From: Christian Kastner Date: Sat, 26 Jul 2014 14:31:39 +0200 Subject: Syntax fixes for man pages Hyphens used as minus signs must be escaped. Last-Update: 2015-10-02 --- doc/man/cgclassify.1 | 8 +++--- doc/man/cgclear.1 | 16 ++++++------ doc/man/cgconfig.conf.5 | 66 ++++++++++++++++++++++++------------------------ doc/man/cgconfigparser.8 | 30 +++++++++++----------- doc/man/cgcreate.1 | 24 +++++++++--------- doc/man/cgdelete.1 | 10 ++++---- doc/man/cgexec.1 | 18 ++++++------- doc/man/cgget.1 | 30 +++++++++++----------- doc/man/cgred.conf.5 | 6 ++--- doc/man/cgrulesengd.8 | 32 +++++++++++------------ doc/man/cgset.1 | 8 +++--- doc/man/cgsnapshot.1 | 20 +++++++-------- doc/man/lscgroup.1 | 4 +-- doc/man/lssubsys.1 | 28 ++++++++++---------- 14 files changed, 150 insertions(+), 150 deletions(-) diff --git a/doc/man/cgclassify.1 b/doc/man/cgclassify.1 index db4e086..4a24b31 100644 --- a/doc/man/cgclassify.1 +++ b/doc/man/cgclassify.1 @@ -6,7 +6,7 @@ cgclassify \- move running task(s) to given cgroups .SH SYNOPSIS -\fBcgclassify\fR [\fB-g\fR <\fIcontrollers>:] [--sticky | --cancel-sticky] <\fIpidlist\fR> +\fBcgclassify\fR [\fB\-g\fR <\fIcontrollers>:] [\-\-sticky | \-\-cancel-sticky] <\fIpidlist\fR> .SH DESCRIPTION this command moves processes defined by the list @@ -17,7 +17,7 @@ to the given control groups. The pids in the pidlist are separated by spaces .TP -.B -g : +.B \-g : defines the control groups where the task will be moved. \fBcontrollers\fR is a list of controllers and \fBpath\fR is the relative path to control groups @@ -34,7 +34,7 @@ If this option is not used then control group based on \fB/etc/cgrules.conf\fR. .TP -.B --sticky +.B \-\-sticky If this option is used, the daemon of service cgred (cgrulesengd process) does not change both the specified \fBpidlist\fR and their children tasks. Without this option, the daemon does not change the specified \fBpidlist\fR @@ -42,7 +42,7 @@ but it automatically changes their child tasks to the right cgroup based on \fB/etc/cgrules.conf\fR. .TP -.B --cancel-sticky +.B \-\-cancel-sticky If this option is used, the daemon of service cgred (cgrulesengd process) can automatically change both the specified \fBpidlist\fR and their child tasks to the right cgroup based on \fB/etc/cgrules.conf\fR. diff --git a/doc/man/cgclear.1 b/doc/man/cgclear.1 index 318c925..ff179de 100644 --- a/doc/man/cgclear.1 +++ b/doc/man/cgclear.1 @@ -6,7 +6,7 @@ cgclear \- unload the cgroup filesystem .SH SYNOPSIS -\fBcgclear\fR [\fB-e\fR] [\fB-l\fR <\fIfilename\fR>] [\fB-L\fR <\fIdirectory\fR>] [...] +\fBcgclear\fR [\fB\-e\fR] [\fB\-l\fR <\fIfilename\fR>] [\fB\-L\fR <\fIdirectory\fR>] [...] .SH DESCRIPTION @@ -20,22 +20,22 @@ file on command line is processed first, so \fBcgclear\fR can have the same command line arguments as appropriate \fBcgconfigparser\fR. .TP -.B -l, --load= +.B \-l, \-\-load= specifies the config file to read. This option can be used multiple times and -can be mixed with \fB-L\fR option. +can be mixed with \fB\-L\fR option. .TP -.B -L, --load-directory= +.B \-L, \-\-load-directory= specifies the directory, which is searched for configuration files. All files in this directory will be processed in alphabetical order as they were specified -by \fB-l\fR option. This option can be used multiple times and -can be mixed with \fB-l\fR option. +by \fB\-l\fR option. This option can be used multiple times and +can be mixed with \fB\-l\fR option. .TP -.B -e +.B \-e specifies that only empty groups should be removed. If a group defined in a config file has tasks inside or has a subgroup, it won't be removed. This -option works only with \fB-l\fR or \fB-L\fR options. +option works only with \fB\-l\fR or \fB\-L\fR options. .SH ENVIRONMENT VARIABLES .TP diff --git a/doc/man/cgconfig.conf.5 b/doc/man/cgconfig.conf.5 index 5ebd879..76a986d 100644 --- a/doc/man/cgconfig.conf.5 +++ b/doc/man/cgconfig.conf.5 @@ -275,7 +275,7 @@ inside. It corresponds to the following operations: .RS .nf mkdir /sys/fs/cgroup/cpu -mount -t cgroup -o cpu,cpuacct cpu /sys/fs/cgroup/cpu +mount \-t cgroup \-o cpu,cpuacct cpu /sys/fs/cgroup/cpu .fi .RE @@ -318,8 +318,8 @@ following operations: .RS .nf mkdir /sys/fs/cgroup/cpu -mount -t cgroup -o cpu,name=scheduler cpu /sys/fs/cgroup/cpu -mount -t cgroup -o none,name=noctrl none /sys/fs/cgroup/noctrl +mount \-t cgroup \-o cpu,name=scheduler cpu /sys/fs/cgroup/cpu +mount \-t cgroup \-o none,name=noctrl none /sys/fs/cgroup/noctrl mkdir /sys/fs/cgroup/cpu/daemons echo 1000 > /sys/fs/cgroup/cpu/daemons/www/cpu.shares @@ -427,7 +427,7 @@ which are little bit trickier to emulate via chmod): .RS .nf mkdir /sys/fs/cgroup/cpu -mount -t cgroup -o cpu,cpuacct cpu /sys/fs/cgroup/cpu +mount \-t cgroup \-o cpu,cpuacct cpu /sys/fs/cgroup/cpu mkdir /sys/fs/cgroup/cpu/daemons @@ -437,23 +437,23 @@ chown root:webmaster /sys/fs/cgroup/cpu/daemons/www/tasks echo 1000 > /sys/fs/cgroup/cpu/daemons/www/cpu.shares # + chmod the files so the result looks like: - # ls -la /sys/fs/cgroup/cpu/daemons/www/ + # ls \-la /sys/fs/cgroup/cpu/daemons/www/ # admin.dperm = 755: - # drwxr-xr-x. 2 root webmaster 0 Jun 16 11:51 . + # drwxr\-xr\-x. 2 root webmaster 0 Jun 16 11:51 . # # admin.fperm = 744: - # --w-------. 1 root webmaster 0 Jun 16 11:51 cgroup.event_control - # -r--r--r--. 1 root webmaster 0 Jun 16 11:51 cgroup.procs - # -r--r--r--. 1 root webmaster 0 Jun 16 11:51 cpuacct.stat - # -rw-r--r--. 1 root webmaster 0 Jun 16 11:51 cpuacct.usage - # -r--r--r--. 1 root webmaster 0 Jun 16 11:51 cpuacct.usage_percpu - # -rw-r--r--. 1 root webmaster 0 Jun 16 11:51 cpu.rt_period_us - # -rw-r--r--. 1 root webmaster 0 Jun 16 11:51 cpu.rt_runtime_us - # -rw-r--r--. 1 root webmaster 0 Jun 16 11:51 cpu.shares - # -rw-r--r--. 1 root webmaster 0 Jun 16 11:51 notify_on_release + # \-\-w\-\-\-\-\-\-\-. 1 root webmaster 0 Jun 16 11:51 cgroup.event_control + # \-r\-\-r\-\-r\-\-. 1 root webmaster 0 Jun 16 11:51 cgroup.procs + # \-r\-\-r\-\-r\-\-. 1 root webmaster 0 Jun 16 11:51 cpuacct.stat + # \-rw\-r\-\-r\-\-. 1 root webmaster 0 Jun 16 11:51 cpuacct.usage + # \-r\-\-r\-\-r\-\-. 1 root webmaster 0 Jun 16 11:51 cpuacct.usage_percpu + # \-rw\-r\-\-r\-\-. 1 root webmaster 0 Jun 16 11:51 cpu.rt_period_us + # \-rw\-r\-\-r\-\-. 1 root webmaster 0 Jun 16 11:51 cpu.rt_runtime_us + # \-rw\-r\-\-r\-\-. 1 root webmaster 0 Jun 16 11:51 cpu.shares + # \-rw\-r\-\-r\-\-. 1 root webmaster 0 Jun 16 11:51 notify_on_release # # tasks.fperm = 770 - # -rw-rw----. 1 root webmaster 0 Jun 16 11:51 tasks + # \-rw\-rw\-\-\-\-. 1 root webmaster 0 Jun 16 11:51 tasks mkdir /sys/fs/cgroup/cpu/daemons/ftp @@ -462,23 +462,23 @@ chown root:ftpmaster /sys/fs/cgroup/cpu/daemons/ftp/tasks echo 500 > /sys/fs/cgroup/cpu/daemons/ftp/cpu.shares # + chmod the files so the result looks like: - # ls -la /sys/fs/cgroup/cpu/daemons/ftp/ + # ls \-la /sys/fs/cgroup/cpu/daemons/ftp/ # admin.dperm = 755: - # drwxr-xr-x. 2 root ftpmaster 0 Jun 16 11:51 . + # drwxr\-xr\-x. 2 root ftpmaster 0 Jun 16 11:51 . # # admin.fperm = 700: - # --w-------. 1 root ftpmaster 0 Jun 16 11:51 cgroup.event_control - # -r--------. 1 root ftpmaster 0 Jun 16 11:51 cgroup.procs - # -r--------. 1 root ftpmaster 0 Jun 16 11:51 cpuacct.stat - # -rw-------. 1 root ftpmaster 0 Jun 16 11:51 cpuacct.usage - # -r--------. 1 root ftpmaster 0 Jun 16 11:51 cpuacct.usage_percpu - # -rw-------. 1 root ftpmaster 0 Jun 16 11:51 cpu.rt_period_us - # -rw-------. 1 root ftpmaster 0 Jun 16 11:51 cpu.rt_runtime_us - # -rw-------. 1 root ftpmaster 0 Jun 16 11:51 cpu.shares - # -rw-------. 1 root ftpmaster 0 Jun 16 11:51 notify_on_release + # \-\-w\-\-\-\-\-\-\-. 1 root ftpmaster 0 Jun 16 11:51 cgroup.event_control + # \-r\-\-\-\-\-\-\-\-. 1 root ftpmaster 0 Jun 16 11:51 cgroup.procs + # \-r\-\-\-\-\-\-\-\-. 1 root ftpmaster 0 Jun 16 11:51 cpuacct.stat + # \-rw\-\-\-\-\-\-\-. 1 root ftpmaster 0 Jun 16 11:51 cpuacct.usage + # \-r\-\-\-\-\-\-\-\-. 1 root ftpmaster 0 Jun 16 11:51 cpuacct.usage_percpu + # \-rw\-\-\-\-\-\-\-. 1 root ftpmaster 0 Jun 16 11:51 cpu.rt_period_us + # \-rw\-\-\-\-\-\-\-. 1 root ftpmaster 0 Jun 16 11:51 cpu.rt_runtime_us + # \-rw\-\-\-\-\-\-\-. 1 root ftpmaster 0 Jun 16 11:51 cpu.shares + # \-rw\-\-\-\-\-\-\-. 1 root ftpmaster 0 Jun 16 11:51 notify_on_release # # tasks.fperm = 774: - # -rw-rw-r--. 1 root ftpmaster 0 Jun 16 11:51 tasks + # \-rw\-rw\-r\-\-. 1 root ftpmaster 0 Jun 16 11:51 tasks .fi .RE @@ -532,8 +532,8 @@ It corresponds to the following operations: .nf mkdir /sys/fs/cgroup/cpu mkdir /sys/fs/cgroup/cpuacct -mount -t cgroup -o cpu cpu /sys/fs/cgroup/cpu -mount -t cgroup -o cpuacct cpuacct /sys/fs/cgroup/cpuacct +mount \-t cgroup \-o cpu cpu /sys/fs/cgroup/cpu +mount \-t cgroup \-o cpuacct cpuacct /sys/fs/cgroup/cpuacct mkdir /sys/fs/cgroup/cpu/daemons mkdir /sys/fs/cgroup/cpuacct/daemons @@ -599,8 +599,8 @@ It corresponds to the following operations: .nf mkdir /sys/fs/cgroup/cpu mkdir /sys/fs/cgroup/cpuacct -mount -t cgroup -o cpu cpu /sys/fs/cgroup/cpu -mount -t cgroup -o cpuacct cpuacct /sys/fs/cgroup/cpuacct +mount \-t cgroup \-o cpu cpu /sys/fs/cgroup/cpu +mount \-t cgroup \-o cpuacct cpuacct /sys/fs/cgroup/cpuacct mkdir /sys/fs/cgroup/cpuacct/daemons mkdir /sys/fs/cgroup/cpu/daemons @@ -697,7 +697,7 @@ It corresponds to the following operations: .RS .nf mkdir /sys/fs/cgroup/cpu -mount -t cgroup -o cpu,cpuacct cpu /sys/fs/cgroup/cpu +mount \-t cgroup \-o cpu,cpuacct cpu /sys/fs/cgroup/cpu chown root:operator /sys/fs/cgroup/cpu/* chown root:operator /sys/fs/cgroup/cpu/tasks diff --git a/doc/man/cgconfigparser.8 b/doc/man/cgconfigparser.8 index 0a20f95..dd70484 100644 --- a/doc/man/cgconfigparser.8 +++ b/doc/man/cgconfigparser.8 @@ -7,61 +7,61 @@ cgconfigparser \- setup control group file system .SH SYNOPSIS -\fBcgconfigparser\fR [\fB-h\fR] [\fB-l\fR \fI\fR] [\fB-L\fR \fI\fR] [...] +\fBcgconfigparser\fR [\fB\-h\fR] [\fB\-l\fR \fI\fR] [\fB\-L\fR \fI\fR] [...] .SH OPTIONS .TP -.B -h, --help +.B \-h, \-\-help Displays help. .TP -.B -l, --load=FILE +.B \-l, \-\-load=FILE Parses the control groups configuration file Sets up the control group file system defined by the configuration file and mounts mount points defined by the configuration file. The format of the file is described in \fBcgconfig.conf\fR. This option can be used multiple times and can be mixed -with \fB-L\fR option. +with \fB\-L\fR option. .TP -.B -L, --load-directory=DIR +.B \-L, \-\-load-directory=DIR Finds all files in given directory and parses them in alphabetical order -like they were specified by \fB-l\fR option. This option can be used -multiple times and can be mixed with \fB-l\fR option. +like they were specified by \fB\-l\fR option. This option can be used +multiple times and can be mixed with \fB\-l\fR option. .TP -.B -a : +.B \-a : defines the default owner of the rest of the defined control group’s files. These users are allowed to set subsystem parameters and create subgroups. The default value is the same as has the parent cgroup. .TP -.B -d, --dperm=mode +.B \-d, \-\-dperm=mode sets the default permissions of a control groups directory. The permissions needs to be specified as octal numbers e.g. -\fB-d 775\fR. +\fB\-d 775\fR. .TP -.B -f, --fperm=mode +.B \-f, \-\-fperm=mode sets the default permissions of the control group files. The permissions needs to be specified as octal numbers e.g. -\fB-f 775\fR. +\fB\-f 775\fR. The value is not used as given because the current owner's permissions are used as an umask (so 777 will set group and others permissions to the owners permissions). .TP -.B -s, --tperm=mode +.B \-s, \-\-tperm=mode sets the default permissions of the control group tasks files. The permissions needs to be specified as octal numbers e.g. -\fB-f 775\fR. +\fB\-f 775\fR. The value is not used as given because the current owner's permissions are used as an umask (so 777 will set group and others permissions to the owners permissions). .TP -.B -t : +.B \-t : defines the default owner of tasks file of the defined control group. I.e. this user and members of this group have write access to the file. diff --git a/doc/man/cgcreate.1 b/doc/man/cgcreate.1 index 7068073..e95873c 100644 --- a/doc/man/cgcreate.1 +++ b/doc/man/cgcreate.1 @@ -5,38 +5,38 @@ cgcreate \- create new cgroup(s) .SH SYNOPSIS -\fBcgcreate\fR [\fB-h\fR] [\fB-t\fR <\fItuid>:] -[\fB-a\fR <\fIagid>:] [\fB-f\fR mode] [\fB-d\fR mode] -[\fB-s\fR mode] \fB-g\fR <\fIcontrollers>: [\fB-g\fR ...] +\fBcgcreate\fR [\fB\-h\fR] [\fB\-t\fR <\fItuid>:] +[\fB\-a\fR <\fIagid>:] [\fB\-f\fR mode] [\fB\-d\fR mode] +[\fB\-s\fR mode] \fB\-g\fR <\fIcontrollers>: [\fB\-g\fR ...] .SH DESCRIPTION The command creates new cgroup(s) defined by the options \fB-g\fR. .TP -.B -a : +.B \-a : defines the name of the user and the group which own the rest of the defined control group’s files. These users are allowed to set subsystem parameters and create subgroups. The default value is the same as has the parent cgroup. .TP -.B -d, --dperm=mode +.B \-d, \-\-dperm=mode sets the permissions of a control groups directory. The permissions needs to be specified as octal numbers e.g. \fB-d 775\fR. .TP -.B -f, --fperm=mode +.B \-f, \-\-fperm=mode sets the permissions of the control groups parameters. The permissions needs to be specified as octal numbers e.g. -\fB-f 775\fR. +\fB\-f 775\fR. The value is not used as given because the current owner's permissions are used as an umask (so 777 will set group and others permissions to the owners permissions). .TP -.B -g : +.B \-g : defines control groups to be added. \fBcontrollers\fR is a list of controllers and \fBpath\fR is the relative path to control groups @@ -44,20 +44,20 @@ in the given controllers list. This option can be specified multiple times. .TP -.B -h, --help +.B \-h, \-\-help display this help and exit .TP -.B -s, --tperm=mode +.B \-s, \-\-tperm=mode sets the permissions of the control group tasks file. The permissions needs to be specified as octal numbers e.g. -\fB-s 775\fR. +\fB\-s 775\fR. The value is not used as given because the current owner's permissions are used as an umask (so 777 will set group and others permissions to the owners permissions). .TP -.B -t : +.B \-t : defines the name of the user and the group, which owns tasks file of the defined control group. I.e. this user and members of this group have write access to the file. diff --git a/doc/man/cgdelete.1 b/doc/man/cgdelete.1 index 025a799..92dbcfb 100644 --- a/doc/man/cgdelete.1 +++ b/doc/man/cgdelete.1 @@ -7,7 +7,7 @@ cgdelete \- remove control group(s) .SH SYNOPSIS -\fBcgdelete\fR [\fB-h\fR] [\fB-r\fR] [[\fB-g\fR] +\fBcgdelete\fR [\fB\-h\fR] [\fB\-r\fR] [[\fB\-g\fR] <\fIcontrollers\fR>:\fI] ... .SH DESCRIPTION @@ -15,18 +15,18 @@ The \fBcgdelete\fR program removes all specified control groups. .TP -.B [-g] : +.B [\-g] : Defines the control group to delete. Multiple control groups nay be specified. -.B -g +.B \-g is optional. .TP -.B -h, --help +.B \-h, \-\-help Display this help and exit. .TP -.B -r, --recursive +.B \-r, \-\-recursive Recursively remove all subgroups. .SH ENVIRONMENT VARIABLES diff --git a/doc/man/cgexec.1 b/doc/man/cgexec.1 index cacbd3a..c34edf1 100644 --- a/doc/man/cgexec.1 +++ b/doc/man/cgexec.1 @@ -7,7 +7,7 @@ cgexec \- run the task in given control groups .SH SYNOPSIS -\fBcgexec\fR [\fB-h\fR] [\fB-g\fR <\fIcontrollers>:] [--sticky] \fBcommand\fR [\fIarguments\fR] +\fBcgexec\fR [\fB\-h\fR] [\fB\-g\fR <\fIcontrollers>:] [\-\-sticky] \fBcommand\fR [\fIarguments\fR] .SH DESCRIPTION The \fBcgexec\fR @@ -15,7 +15,7 @@ program executes the task \fBcommand\fR with arguments \fBarguments\fR in the given control groups. .TP -.B -g : +.B \-g : defines the control groups in which the task will be run. \fBcontrollers\fR is a list of controllers and \fBpath\fR is the relative path to control groups @@ -40,11 +40,11 @@ If the specifications are not present the group is created with the default kernel values. .TP -.B -h, --help +.B \-h, \-\-help Display this help and exit. .TP -.B --sticky +.B \-\-sticky If running the task \fBcommand\fR with this option, the daemon of service cgred (cgrulesengd process) does not change both the task of the \fBcommand\fR and the child tasks. Without this option, @@ -58,7 +58,7 @@ changes the child tasks to the right cgroup based on .nf .ft B -cgexec -g *:test1 ls +cgexec \-g *:test1 ls .ft R .fi runs command \fBls\fR in control group test1 @@ -66,18 +66,18 @@ in all mounted controllers. .nf .ft B -cgexec -g cpu,memory:test1 ls -l +cgexec \-g cpu,memory:test1 ls \-l .ft R .fi -runs command \fBls -l\fR in control group test1 +runs command \fBls \-l\fR in control group test1 in controllers cpu and memory. .nf .ft B -cgexec -g cpu,memory:test1 -g swap:test2 ls -l +cgexec \-g cpu,memory:test1 \-g swap:test2 ls \-l .ft R .fi -runs command \fBls -l\fR in control group test1 +runs command \fBls \-l\fR in control group test1 in controllers cpu and memory and control group test2 in controller swap. diff --git a/doc/man/cgget.1 b/doc/man/cgget.1 index 744a329..73a1eb0 100644 --- a/doc/man/cgget.1 +++ b/doc/man/cgget.1 @@ -7,11 +7,11 @@ cgget \- print parameter(s) of given group(s) .SH SYNOPSIS -\fBcgget\fR [\fB-n\fR] [\fB-v\fR] [\fB-r\fR <\fIname\fR>] -[\fB-g\fR <\fIcontroller\fR>] [\fB-a\fR] <\fBpath\fR> ... +\fBcgget\fR [\fB\-n\fR] [\fB\-v\fR] [\fB\-r\fR <\fIname\fR>] +[\fB\-g\fR <\fIcontroller\fR>] [\fB\-a\fR] <\fBpath\fR> ... .br -\fBcgget\fR [\fB-n\fR] [\fB-v\fR] [\fB-r\fR <\fIname\fR>] -\fB-g\fR <\fIcontroller\fR>:<\fBpath\fR> ... +\fBcgget\fR [\fB\-n\fR] [\fB\-v\fR] [\fB\-r\fR <\fIname\fR>] +\fB\-g\fR <\fIcontroller\fR>:<\fBpath\fR> ... .SH DESCRIPTION Prints the parameter(s) of input cgroup(s). @@ -24,40 +24,40 @@ is the name of the cgroup which should be read. This parameter can be used multiple times. .TP -.B -a, --all +.B \-a, \-\-all print the variables for all controllers which consist in the given cgroup .TP -.B -g +.B \-g defines controllers whose values should be displayed. This option can be used multiple times. .TP -.B -g : +.B \-g : defines control groups whose values should be displayed. This option can be used multiple times. .TP -.B -h, --help +.B \-h, \-\-help display help and exit .TP -.B -n +.B \-n do not print headers, i.e. names of groups. .TP -.B -r, --variable +.B \-r, \-\-variable defines parameter to display. This option can be used multiple times. .TP -.B -v, --values-only +.B \-v, \-\-values-only print only values, not parameter names. .SH EXAMPLES .nf -$ cgget -r cpuset.cpus -r cpuset.mems first second +$ cgget \-r cpuset.cpus \-r cpuset.mems first second first: cpuset.cpus=0-1 cpuset.mems=0 @@ -66,19 +66,19 @@ second: cpuset.cpus=0 cpuset.mems=0 -$ cgget -n -r cpuset.cpus -r cpuset.mems first second +$ cgget \-n \-r cpuset.cpus \-r cpuset.mems first second cpuset.cpus=0-1 cpuset.mems=0 cpuset.cpus=0 cpuset.mems=0 -$ cgget -nv -r cpuset.cpus -r cpuset.mems first second +$ cgget \-nv \-r cpuset.cpus \-r cpuset.mems first second 0-1 0 0 0 -$ cgget -n -g cpu / +$ cgget \-n \-g cpu / cpu.rt_period_us=1000000 cpu.rt_runtime_us=950000 cpu.shares=1024 diff --git a/doc/man/cgred.conf.5 b/doc/man/cgred.conf.5 index 3fe760f..f4ee956 100644 --- a/doc/man/cgred.conf.5 +++ b/doc/man/cgred.conf.5 @@ -21,13 +21,13 @@ variable specifies the file to which logs will be written .TP \fBNODAEMON\fR -if it is equal to "--nodamon" then +if it is equal to "\-\-nodamon" then run cgred in non-daemon mode .TP \fBLOG\fR -define the verbosity of logging. Accepted values are '-v', '-vv', '-q' -and '--nolog'. +define the verbosity of logging. Accepted values are '\-v', '\-vv', '\-q' +and '\-\-nolog'. .LP diff --git a/doc/man/cgrulesengd.8 b/doc/man/cgrulesengd.8 index 2e89c5b..ee74870 100644 --- a/doc/man/cgrulesengd.8 +++ b/doc/man/cgrulesengd.8 @@ -21,40 +21,40 @@ The daemon opens a standard unix socket to receive 'sticky' requests from \fBcge .SH OPTIONS .TP -.B -h|--help +.B \-h|\-\-help Display help. .TP -.B -f |--logfile= -Write log messages to the given log file. When '-' is used as , log messages -are written to the standard output. If '\fB-f\fR' and '\fB-s\fR' are used together, +.B \-f |\-\-logfile= +Write log messages to the given log file. When '\-' is used as , log messages +are written to the standard output. If '\fB\-f\fR' and '\fB\-s\fR' are used together, the logs are sent to both destinations. .TP -.B -s[facility]|--syslog=[facility] -Write log messages to syslog. The default facility is DAEMON. If '\fB-f\fR' -and '\fB-s\fR' are used together, the logs are sent to both destinations. +.B \-s[facility]|\-\-syslog=[facility] +Write log messages to syslog. The default facility is DAEMON. If '\fB\-f\fR' +and '\fB\-s\fR' are used together, the logs are sent to both destinations. .TP -.B -n|--nodaemon +.B \-n|\-\-nodaemon Don't fork the daemon, stay in the foreground. .TP -.B -v|--verbose +.B \-v|\-\-verbose Display more log messages. This option can be used three times to enable more verbose log messages. .TP -.B -q|--quiet +.B \-q|\-\-quiet Display less log messages. .TP -.B -Q|--nolog +.B \-Q|\-\-nolog Disable logging. .TP -.B -d|--debug -Equivalent to '-nvvvf -', i.e. don't fork the daemon, display all log messages and +.B \-d|\-\-debug +Equivalent to '\-nvvvf \-', i.e. don't fork the daemon, display all log messages and write them to the standard output. .TP -.B -u |--socket-user= -.B -g |--socket-group= +.B \-u |\-\-socket-user= +.B \-g |\-\-socket-group= Set the owner of cgrulesengd socket. Assumes that \fBcgexec\fR runs with proper -suid permissions so it can write to the socket when \fBcgexec\fR --sticky is used. +suid permissions so it can write to the socket when \fBcgexec\fR \-\-sticky is used. .SH ENVIRONMENT VARIABLES .TP diff --git a/doc/man/cgset.1 b/doc/man/cgset.1 index be886c6..4e63aa2 100644 --- a/doc/man/cgset.1 +++ b/doc/man/cgset.1 @@ -7,9 +7,9 @@ cgset \- set the parameters of given cgroup(s) .SH SYNOPSIS -\fBcgset\fR [\fB-r\fR <\fIname=value\fR>] <\fBcgroup_path\fR> ... +\fBcgset\fR [\fB\-r\fR <\fIname=value\fR>] <\fBcgroup_path\fR> ... .br -\fBcgset\fR \fB--copy-from\fR <\fIsource_cgroup_path\fR> <\fBcgroup_path\fR> ... +\fBcgset\fR \fB\-\-copy-from\fR <\fIsource_cgroup_path\fR> <\fBcgroup_path\fR> ... .SH DESCRIPTION Set the parameters of input cgroups. @@ -20,13 +20,13 @@ is the name of the cgroup which should be changed. This parameter can be used multiple times. .TP -.B -r +.B \-r defines the name of the file to set and the value which should be written to that file. This parameter can be used multiple times. .TP -.B --copy-from +.B \-\-copy-from defines the name of the cgroup whose parameters will be copied to the input cgroup. diff --git a/doc/man/cgsnapshot.1 b/doc/man/cgsnapshot.1 index 03c85f6..a6bb96e 100644 --- a/doc/man/cgsnapshot.1 +++ b/doc/man/cgsnapshot.1 @@ -7,8 +7,8 @@ cgsnapshot \- generate the configuration file for given controllers .SH SYNOPSIS -\fBcgsnapshot\fR [\fB-h\fR] [\fB-s\fR] [\fB-t\fR] [\fB-b\fR \fIfile\fR] -[\fB-w\fR \fIfile\fR] [\fB-f\fR \fIoutput_file\fR] [\fBcontroller\fR] [...] +\fBcgsnapshot\fR [\fB\-h\fR] [\fB\-s\fR] [\fB\-t\fR] [\fB\-b\fR \fIfile\fR] +[\fB\-w\fR \fIfile\fR] [\fB\-f\fR \fIoutput_file\fR] [\fBcontroller\fR] [...] .SH DESCRIPTION \fBcgsnapshot\fR @@ -21,7 +21,7 @@ The output is in the same format as the configuration file. .TP -.B -b file +.B \-b file Display only variables from the blacklist. The default location of the blacklist is .B /etc/cgsnapshot_blacklist.conf. @@ -33,25 +33,25 @@ If it is not present on the blacklist, the whitelist is checked. .TP -.B -h, --help +.B \-h, \-\-help display this help and exit .TP -.B -f, --file +.B \-f, \-\-file Redirect the output to output_file .TP -.B -s, --silent +.B \-s, \-\-silent Ignore all warnings .TP -.B -t, --strict +.B \-t, \-\-strict Do not display the variables which are not on the whitelist .TP -.B -w file +.B \-w file Set the blacklist configuration file. This list contains all variables which should be displayed by .B cgsnapshot @@ -65,10 +65,10 @@ the variable is displayed and a warning message is produced. By default the whitelist is not used. The warning message can be omitted using the -.B -s, --silent +.B \-s, \-\-silent flag. If the -.B -t, --strict +.B \-t, \-\-strict flag is used, the variable which is not on the whitelist is not displayed. diff --git a/doc/man/lscgroup.1 b/doc/man/lscgroup.1 index 693fbbc..27fec7d 100644 --- a/doc/man/lscgroup.1 +++ b/doc/man/lscgroup.1 @@ -7,9 +7,9 @@ lscgroup \- list all cgroups .SH SYNOPSIS -\fBlscgroup\fR [[\fB-g\fR] <\fIcontrollers>:] [...] +\fBlscgroup\fR [[\fB\-g\fR] <\fIcontrollers>:] [...] .br -\fBlscgroup\fR [\fB-h|--help\fR] +\fBlscgroup\fR [\fB\-h|\-\-help\fR] .SH DESCRIPTION List all/chosen cgroups. diff --git a/doc/man/lssubsys.1 b/doc/man/lssubsys.1 index 790c627..1be272e 100644 --- a/doc/man/lssubsys.1 +++ b/doc/man/lssubsys.1 @@ -7,13 +7,13 @@ lssubsys \- list hierarchies containing given subsystem .SH SYNOPSIS -\fBlssubsys\fR [\fB-m|--mount-points\fR] [\fB-M|--all-mount-points\fR] +\fBlssubsys\fR [\fB\-m|\-\-mount-points\fR] [\fB\-M|\-\-all-mount-points\fR] [\fIcontroller\fR] [...] .br -\fBlssubsys\fR [\fB-m|--mount-points\fR] [\fB-M|--all-mount-points\fR] -[\fB-i|--hierarchies\fR] [\fB-a|--all\fR] +\fBlssubsys\fR [\fB\-m|\-\-mount-points\fR] [\fB\-M|\-\-all-mount-points\fR] +[\fB\-i|\-\-hierarchies\fR] [\fB\-a|\-\-all\fR] .br -\fBlssubsys\fR [\fB-h|--help\fR] +\fBlssubsys\fR [\fB\-h|\-\-help\fR] .SH DESCRIPTION \fBlssubsys\fR list the hierarchies containing @@ -27,37 +27,37 @@ If this parameter is not used, the command will list all mounted subsystems. .TP -.B -m, --mount-points +.B \-m, \-\-mount-points Display mount points. Only the first mount points of shown hierarchies are displayed. .TP -.B -M, --all-mount-points +.B \-M, \-\-all-mount-points Display mount points. All mount points of shown hierarchies are displayed, each on separate line. .TP -.B -a, --all +.B \-a, \-\-all Display all subsystems (including unmounted ones). .TP -.B -i, --hierarchies +.B \-i, \-\-hierarchies Display the attached hierarchy number if the subsystem is in a hierarchy. If the option -.B -m +.B \-m is also used, the hierarchy number is shown only for unmounted hierarchies. .TP -.B -h, --help +.B \-h, \-\-help Display help and exit. .SH EXAMPLE The command -.B lssubsys -am +.B lssubsys \-am lists all subsystems which are present in the system, mounted ones will be shown with their mount point: .RS .nf -$ lssubsys -am +$ lssubsys \-am ns cpuset cpu,devices @@ -69,13 +69,13 @@ net_cls /cgroup/net_cls .RE .LP The command -.B lssubsys -ami +.B lssubsys \-ami lists all subsystems which are present in the system, mounted subsystems are listed with their mount points, unmounted ones which are in a hierarchy are listed with their hierarchy number: .RS .nf -$ lssubsys -ami +$ lssubsys \-ami ns cpuset 5 cpu,devices 6