man page and readme updates

This commit is contained in:
Bjango
2016-10-23 18:55:08 +11:00
parent a2d5d03629
commit 63e8613616
6 changed files with 33 additions and 30 deletions

View File

@@ -1,37 +1,42 @@
.Dd 2009-05-17
.Dt istat.conf 5
.Dt istatserver.conf 5
.Os
.Sh NAME
.Nm istat.conf
.Nd configuration file for istatd
.Nm istatserver.conf
.Nd configuration file for istatserver
.Sh OPTIONS
.Bl -tag -width -indent-three
.It network_addr
Address to bind (default: 0.0.0.0)
.It network_port
Port to bind (default: 5109)
.It server_code
Lock code needed when connecting to the server for the first time.
.It server_socket
Location of the unix socket. (default: /tmp/istatd.sock)
Location of the unix socket. (default: /tmp/istatserver.sock)
.It server_pid
Location of the pid. (default: /var/run/istat/istatd.pid)
Location of the pid. (default: /var/run/istatserver.pid)
.It server_user
User to switch to when entering daemon mode. It's not recommended to use high privilaged users like root due to security reasons. Defaults to root if the user doesn't exist. (default: istat)
.It server_group
Group to switch to when entering daemon mode. Defaults to root if the group doesn't exist. (default: istat)
.It monitor_disk
Can contain search path to device or mount point. When specifying more than one disk, use paranteses around the list:
monitor_disk /dev/sda1
.It disable_history_storage
Set to 1 if you want to disable history storage (not recommended unless you have very limited disk space).
monitor_disk ( /dev/sda1 /dev/sda2 )
.It disk_disable_filtering
Set to 1 if you want to disable all mount path based disk filtering (excludes filesystems that you are unlikely to want to monitor).
.It disk_mount_path_label
Set to 1 if you want to use mount path as label instead of the device name.
.It disk_filesystem_label
Set to 1 if you want to probe the filesystem for disk label, will override the mount path and device name.
.It disk_rename_label
Set custom disk label. Will override all other labels. You can use either the device name or mount path:
@@ -40,4 +45,4 @@ disk_rename_label /dev/sda1 "root"
disk_rename_label /home "home"
.El
.Sh SEE ALSO
.Xr istatd 1
.Xr istatserver 1