openkylin
/
libcgroup
4
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Syntax fixes for man pages 

Hyphens used as minus signs must be escaped.

Last-Update: 2015-10-02

Gbp-Pq: Name Syntax-fixes-for-man-pages.patch
This commit is contained in:
Christian Kastner 2014-07-26 14:31:39 +02:00 committed by Lu zhiping
parent aea6daef0e
commit bd4b8f4998
14 changed files with 150 additions and 150 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/man/cgclassify.1
View File

@ -6,7 +6,7 @@
cgclassify \- move running task(s) to given cgroups cgclassify \- move running task(s) to given cgroups
.SH SYNOPSIS .SH SYNOPSIS
\fBcgclassify\fR [\fB-g\fR <\fIcontrollers>:<path\fR>] [--sticky | --cancel-sticky] <\fIpidlist\fR> \fBcgclassify\fR [\fB\-g\fR <\fIcontrollers>:<path\fR>] [\-\-sticky | \-\-cancel-sticky] <\fIpidlist\fR>
.SH DESCRIPTION .SH DESCRIPTION
this command moves processes defined by the list 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 The pids in the pidlist are separated by spaces
.TP .TP
.B -g <controllers>:<path> .B \-g <controllers>:<path>
defines the control groups where the task will be moved. defines the control groups where the task will be moved.
\fBcontrollers\fR is a list of controllers and \fBcontrollers\fR is a list of controllers and
\fBpath\fR is the relative path to control groups \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. control group based on \fB/etc/cgrules.conf\fR.
.TP .TP
.B --sticky .B \-\-sticky
If this option is used, the daemon of service cgred (cgrulesengd process) If this option is used, the daemon of service cgred (cgrulesengd process)
does not change both the specified \fBpidlist\fR and their children tasks. does not change both the specified \fBpidlist\fR and their children tasks.
Without this option, the daemon does not change the specified \fBpidlist\fR 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. \fB/etc/cgrules.conf\fR.
.TP .TP
.B --cancel-sticky .B \-\-cancel-sticky
If this option is used, the daemon of service cgred (cgrulesengd process) If this option is used, the daemon of service cgred (cgrulesengd process)
can automatically change both the specified \fBpidlist\fR and their child can automatically change both the specified \fBpidlist\fR and their child
tasks to the right cgroup based on \fB/etc/cgrules.conf\fR. tasks to the right cgroup based on \fB/etc/cgrules.conf\fR.

16
doc/man/cgclear.1
View File

@ -6,7 +6,7 @@
cgclear \- unload the cgroup filesystem cgclear \- unload the cgroup filesystem
.SH SYNOPSIS .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 .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. command line arguments as appropriate \fBcgconfigparser\fR.
.TP .TP
.B -l, --load=<filename> .B \-l, \-\-load=<filename>
specifies the config file to read. This option can be used multiple times and 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 .TP
.B -L, --load-directory=<directory> .B \-L, \-\-load-directory=<directory>
specifies the directory, which is searched for configuration files. All files specifies the directory, which is searched for configuration files. All files
in this directory will be processed in alphabetical order as they were specified 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 by \fB\-l\fR option. 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 .TP
.B -e .B \-e
specifies that only empty groups should be removed. If a group defined in a 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 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 .SH ENVIRONMENT VARIABLES
.TP .TP

66
doc/man/cgconfig.conf.5
View File

@ -275,7 +275,7 @@ inside. It corresponds to the following operations:
.RS .RS
.nf .nf
mkdir /sys/fs/cgroup/cpu 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 .fi
.RE .RE
@ -318,8 +318,8 @@ following operations:
.RS .RS
.nf .nf
mkdir /sys/fs/cgroup/cpu mkdir /sys/fs/cgroup/cpu
mount -t cgroup -o cpu,name=scheduler cpu /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 none,name=noctrl none /sys/fs/cgroup/noctrl
mkdir /sys/fs/cgroup/cpu/daemons mkdir /sys/fs/cgroup/cpu/daemons
echo 1000 > /sys/fs/cgroup/cpu/daemons/www/cpu.shares echo 1000 > /sys/fs/cgroup/cpu/daemons/www/cpu.shares
@ -427,7 +427,7 @@ which are little bit trickier to emulate via chmod):
.RS .RS
.nf .nf
mkdir /sys/fs/cgroup/cpu 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 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 echo 1000 > /sys/fs/cgroup/cpu/daemons/www/cpu.shares
# + chmod the files so the result looks like: # + 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: # 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: # admin.fperm = 744:
# --w-------. 1 root webmaster 0 Jun 16 11:51 cgroup.event_control # \-\-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 cgroup.procs
# -r--r--r--. 1 root webmaster 0 Jun 16 11:51 cpuacct.stat # \-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 # \-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 # \-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_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.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 cpu.shares
# -rw-r--r--. 1 root webmaster 0 Jun 16 11:51 notify_on_release # \-rw\-r\-\-r\-\-. 1 root webmaster 0 Jun 16 11:51 notify_on_release
# #
# tasks.fperm = 770 # 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 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 echo 500 > /sys/fs/cgroup/cpu/daemons/ftp/cpu.shares
# + chmod the files so the result looks like: # + 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: # 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: # admin.fperm = 700:
# --w-------. 1 root ftpmaster 0 Jun 16 11:51 cgroup.event_control # \-\-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 cgroup.procs
# -r--------. 1 root ftpmaster 0 Jun 16 11:51 cpuacct.stat # \-r\-\-\-\-\-\-\-\-. 1 root ftpmaster 0 Jun 16 11:51 cpuacct.stat
# -rw-------. 1 root ftpmaster 0 Jun 16 11:51 cpuacct.usage # \-rw\-\-\-\-\-\-\-. 1 root ftpmaster 0 Jun 16 11:51 cpuacct.usage
# -r--------. 1 root ftpmaster 0 Jun 16 11:51 cpuacct.usage_percpu # \-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_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.rt_runtime_us
# -rw-------. 1 root ftpmaster 0 Jun 16 11:51 cpu.shares # \-rw\-\-\-\-\-\-\-. 1 root ftpmaster 0 Jun 16 11:51 cpu.shares
# -rw-------. 1 root ftpmaster 0 Jun 16 11:51 notify_on_release # \-rw\-\-\-\-\-\-\-. 1 root ftpmaster 0 Jun 16 11:51 notify_on_release
# #
# tasks.fperm = 774: # 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 .fi
.RE .RE
@ -532,8 +532,8 @@ It corresponds to the following operations:
.nf .nf
mkdir /sys/fs/cgroup/cpu mkdir /sys/fs/cgroup/cpu
mkdir /sys/fs/cgroup/cpuacct mkdir /sys/fs/cgroup/cpuacct
mount -t cgroup -o cpu cpu /sys/fs/cgroup/cpu mount \-t cgroup \-o cpu cpu /sys/fs/cgroup/cpu
mount -t cgroup -o cpuacct cpuacct /sys/fs/cgroup/cpuacct mount \-t cgroup \-o cpuacct cpuacct /sys/fs/cgroup/cpuacct
mkdir /sys/fs/cgroup/cpu/daemons mkdir /sys/fs/cgroup/cpu/daemons
mkdir /sys/fs/cgroup/cpuacct/daemons mkdir /sys/fs/cgroup/cpuacct/daemons
@ -599,8 +599,8 @@ It corresponds to the following operations:
.nf .nf
mkdir /sys/fs/cgroup/cpu mkdir /sys/fs/cgroup/cpu
mkdir /sys/fs/cgroup/cpuacct mkdir /sys/fs/cgroup/cpuacct
mount -t cgroup -o cpu cpu /sys/fs/cgroup/cpu mount \-t cgroup \-o cpu cpu /sys/fs/cgroup/cpu
mount -t cgroup -o cpuacct cpuacct /sys/fs/cgroup/cpuacct mount \-t cgroup \-o cpuacct cpuacct /sys/fs/cgroup/cpuacct
mkdir /sys/fs/cgroup/cpuacct/daemons mkdir /sys/fs/cgroup/cpuacct/daemons
mkdir /sys/fs/cgroup/cpu/daemons mkdir /sys/fs/cgroup/cpu/daemons
@ -697,7 +697,7 @@ It corresponds to the following operations:
.RS .RS
.nf .nf
mkdir /sys/fs/cgroup/cpu 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/*
chown root:operator /sys/fs/cgroup/cpu/tasks chown root:operator /sys/fs/cgroup/cpu/tasks

30
doc/man/cgconfigparser.8
View File

@ -7,61 +7,61 @@
cgconfigparser \- setup control group file system cgconfigparser \- setup control group file system
.SH SYNOPSIS .SH SYNOPSIS
\fBcgconfigparser\fR [\fB-h\fR] [\fB-l\fR \fI<filename>\fR] [\fB-L\fR \fI<directory>\fR] [...] \fBcgconfigparser\fR [\fB\-h\fR] [\fB\-l\fR \fI<filename>\fR] [\fB\-L\fR \fI<directory>\fR] [...]
.SH OPTIONS .SH OPTIONS
.TP .TP
.B -h, --help .B \-h, \-\-help
Displays help. Displays help.
.TP .TP
.B -l, --load=FILE .B \-l, \-\-load=FILE
Parses the control groups configuration file Parses the control groups configuration file
Sets up the control group file system Sets up the control group file system
defined by the configuration file and mounts defined by the configuration file and mounts
mount points defined by the configuration file. mount points defined by the configuration file.
The format of the file is described in The format of the file is described in
\fBcgconfig.conf\fR. This option can be used multiple times and can be mixed \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 .TP
.B -L, --load-directory=DIR .B \-L, \-\-load-directory=DIR
Finds all files in given directory and parses them in alphabetical order 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 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. multiple times and can be mixed with \fB\-l\fR option.
.TP .TP
.B -a <agid>:<auid> .B \-a <agid>:<auid>
defines the default owner of the defines the default owner of the
rest of the defined control group’s files. These users are rest of the defined control group’s files. These users are
allowed to set subsystem parameters and create subgroups. allowed to set subsystem parameters and create subgroups.
The default value is the same as has the parent cgroup. The default value is the same as has the parent cgroup.
.TP .TP
.B -d, --dperm=mode .B \-d, \-\-dperm=mode
sets the default permissions of a control groups directory. sets the default permissions of a control groups directory.
The permissions needs to be specified as octal numbers e.g. The permissions needs to be specified as octal numbers e.g.
\fB-d 775\fR. \fB\-d 775\fR.
.TP .TP
.B -f, --fperm=mode .B \-f, \-\-fperm=mode
sets the default permissions of the control group files. sets the default permissions of the control group files.
The permissions needs to be specified as octal numbers e.g. 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 The value is not used as given because the current owner's
permissions are used as an umask (so 777 will set group and permissions are used as an umask (so 777 will set group and
others permissions to the owners permissions). others permissions to the owners permissions).
.TP .TP
.B -s, --tperm=mode .B \-s, \-\-tperm=mode
sets the default permissions of the control group tasks files. sets the default permissions of the control group tasks files.
The permissions needs to be specified as octal numbers e.g. 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 The value is not used as given because the current owner's
permissions are used as an umask (so 777 will set group and permissions are used as an umask (so 777 will set group and
others permissions to the owners permissions). others permissions to the owners permissions).
.TP .TP
.B -t <tuid>:<tgid> .B \-t <tuid>:<tgid>
defines the default owner of tasks file of the defined control defines the default owner of tasks file of the defined control
group. I.e. this user and members group. I.e. this user and members
of this group have write access to the file. of this group have write access to the file.

24
doc/man/cgcreate.1
View File

@ -5,38 +5,38 @@
cgcreate \- create new cgroup(s) cgcreate \- create new cgroup(s)
.SH SYNOPSIS .SH SYNOPSIS
\fBcgcreate\fR [\fB-h\fR] [\fB-t\fR <\fItuid>:<tgid\fR>] \fBcgcreate\fR [\fB\-h\fR] [\fB\-t\fR <\fItuid>:<tgid\fR>]
[\fB-a\fR <\fIagid>:<auid\fR>] [\fB-f\fR mode] [\fB-d\fR mode] [\fB\-a\fR <\fIagid>:<auid\fR>] [\fB\-f\fR mode] [\fB\-d\fR mode]
[\fB-s\fR mode] \fB-g\fR <\fIcontrollers>:<path\fR> [\fB-g\fR ...] [\fB\-s\fR mode] \fB\-g\fR <\fIcontrollers>:<path\fR> [\fB\-g\fR ...]
.SH DESCRIPTION .SH DESCRIPTION
The command creates new cgroup(s) defined by the options The command creates new cgroup(s) defined by the options
\fB-g\fR. \fB-g\fR.
.TP .TP
.B -a <agid>:<auid> .B \-a <agid>:<auid>
defines the name of the user and the group which own the defines the name of the user and the group which own the
rest of the defined control group’s files. These users are rest of the defined control group’s files. These users are
allowed to set subsystem parameters and create subgroups. allowed to set subsystem parameters and create subgroups.
The default value is the same as has the parent cgroup. The default value is the same as has the parent cgroup.
.TP .TP
.B -d, --dperm=mode .B \-d, \-\-dperm=mode
sets the permissions of a control groups directory. sets the permissions of a control groups directory.
The permissions needs to be specified as octal numbers e.g. The permissions needs to be specified as octal numbers e.g.
\fB-d 775\fR. \fB-d 775\fR.
.TP .TP
.B -f, --fperm=mode .B \-f, \-\-fperm=mode
sets the permissions of the control groups parameters. sets the permissions of the control groups parameters.
The permissions needs to be specified as octal numbers e.g. 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 The value is not used as given because the current owner's
permissions are used as an umask (so 777 will set group and permissions are used as an umask (so 777 will set group and
others permissions to the owners permissions). others permissions to the owners permissions).
.TP .TP
.B -g <controllers>:<path> .B \-g <controllers>:<path>
defines control groups to be added. defines control groups to be added.
\fBcontrollers\fR is a list of controllers and \fBcontrollers\fR is a list of controllers and
\fBpath\fR is the relative path to control groups \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. multiple times.
.TP .TP
.B -h, --help .B \-h, \-\-help
display this help and exit display this help and exit
.TP .TP
.B -s, --tperm=mode .B \-s, \-\-tperm=mode
sets the permissions of the control group tasks file. sets the permissions of the control group tasks file.
The permissions needs to be specified as octal numbers e.g. 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 The value is not used as given because the current owner's
permissions are used as an umask (so 777 will set group and permissions are used as an umask (so 777 will set group and
others permissions to the owners permissions). others permissions to the owners permissions).
.TP .TP
.B -t <tuid>:<tgid> .B \-t <tuid>:<tgid>
defines the name of the user and the group, which owns tasks defines the name of the user and the group, which owns tasks
file of the defined control group. I.e. this user and members file of the defined control group. I.e. this user and members
of this group have write access to the file. of this group have write access to the file.

10
doc/man/cgdelete.1
View File

@ -7,7 +7,7 @@
cgdelete \- remove control group(s) cgdelete \- remove control group(s)
.SH SYNOPSIS .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<path\fR>] ... <\fIcontrollers\fR>:\fI<path\fR>] ...
.SH DESCRIPTION .SH DESCRIPTION
@ -15,18 +15,18 @@ The \fBcgdelete\fR
program removes all specified control groups. program removes all specified control groups.
.TP .TP
.B [-g] <controllers>:<path> .B [\-g] <controllers>:<path>
Defines the control group to delete. Multiple control groups nay be Defines the control group to delete. Multiple control groups nay be
specified. specified.
.B -g .B \-g
is optional. is optional.
.TP .TP
.B -h, --help .B \-h, \-\-help
Display this help and exit. Display this help and exit.
.TP .TP
.B -r, --recursive .B \-r, \-\-recursive
Recursively remove all subgroups. Recursively remove all subgroups.
.SH ENVIRONMENT VARIABLES .SH ENVIRONMENT VARIABLES

18
doc/man/cgexec.1
View File

@ -7,7 +7,7 @@
cgexec \- run the task in given control groups cgexec \- run the task in given control groups
.SH SYNOPSIS .SH SYNOPSIS
\fBcgexec\fR [\fB-h\fR] [\fB-g\fR <\fIcontrollers>:<path\fR>] [--sticky] \fBcommand\fR [\fIarguments\fR] \fBcgexec\fR [\fB\-h\fR] [\fB\-g\fR <\fIcontrollers>:<path\fR>] [\-\-sticky] \fBcommand\fR [\fIarguments\fR]
.SH DESCRIPTION .SH DESCRIPTION
The \fBcgexec\fR The \fBcgexec\fR
@ -15,7 +15,7 @@ program executes the task \fBcommand\fR
with arguments \fBarguments\fR in the given control groups. with arguments \fBarguments\fR in the given control groups.
.TP .TP
.B -g <controllers>:<path> .B \-g <controllers>:<path>
defines the control groups in which the task will be run. defines the control groups in which the task will be run.
\fBcontrollers\fR is a list of controllers and \fBcontrollers\fR is a list of controllers and
\fBpath\fR is the relative path to control groups \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. kernel values.
.TP .TP
.B -h, --help .B \-h, \-\-help
Display this help and exit. Display this help and exit.
.TP .TP
.B --sticky .B \-\-sticky
If running the task \fBcommand\fR with this option, the daemon of If running the task \fBcommand\fR with this option, the daemon of
service cgred (cgrulesengd process) does not change both the task service cgred (cgrulesengd process) does not change both the task
of the \fBcommand\fR and the child tasks. Without this option, 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 .nf
.ft B .ft B
cgexec -g *:test1 ls cgexec \-g *:test1 ls
.ft R .ft R
.fi .fi
runs command \fBls\fR in control group test1 runs command \fBls\fR in control group test1
@ -66,18 +66,18 @@ in all mounted controllers.
.nf .nf
.ft B .ft B
cgexec -g cpu,memory:test1 ls -l cgexec \-g cpu,memory:test1 ls \-l
.ft R .ft R
.fi .fi
runs command \fBls -l\fR in control group test1 runs command \fBls \-l\fR in control group test1
in controllers cpu and memory. in controllers cpu and memory.
.nf .nf
.ft B .ft B
cgexec -g cpu,memory:test1 -g swap:test2 ls -l cgexec \-g cpu,memory:test1 \-g swap:test2 ls \-l
.ft R .ft R
.fi .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 in controllers cpu and memory and control group
test2 in controller swap. test2 in controller swap.

30
doc/man/cgget.1
View File

@ -7,11 +7,11 @@
cgget \- print parameter(s) of given group(s) cgget \- print parameter(s) of given group(s)
.SH SYNOPSIS .SH SYNOPSIS
\fBcgget\fR [\fB-n\fR] [\fB-v\fR] [\fB-r\fR <\fIname\fR>] \fBcgget\fR [\fB\-n\fR] [\fB\-v\fR] [\fB\-r\fR <\fIname\fR>]
[\fB-g\fR <\fIcontroller\fR>] [\fB-a\fR] <\fBpath\fR> ... [\fB\-g\fR <\fIcontroller\fR>] [\fB\-a\fR] <\fBpath\fR> ...
.br .br
\fBcgget\fR [\fB-n\fR] [\fB-v\fR] [\fB-r\fR <\fIname\fR>] \fBcgget\fR [\fB\-n\fR] [\fB\-v\fR] [\fB\-r\fR <\fIname\fR>]
\fB-g\fR <\fIcontroller\fR>:<\fBpath\fR> ... \fB\-g\fR <\fIcontroller\fR>:<\fBpath\fR> ...
.SH DESCRIPTION .SH DESCRIPTION
Prints the parameter(s) of input cgroup(s). 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. This parameter can be used multiple times.
.TP .TP
.B -a, --all .B \-a, \-\-all
print the variables for all controllers which consist in the given cgroup print the variables for all controllers which consist in the given cgroup
.TP .TP
.B -g <controller> .B \-g <controller>
defines controllers whose values should be displayed. defines controllers whose values should be displayed.
This option can be used multiple times. This option can be used multiple times.
.TP .TP
.B -g <controller>:<path> .B \-g <controller>:<path>
defines control groups whose values should be displayed. defines control groups whose values should be displayed.
This option can be used multiple times. This option can be used multiple times.
.TP .TP
.B -h, --help .B \-h, \-\-help
display help and exit display help and exit
.TP .TP
.B -n .B \-n
do not print headers, i.e. names of groups. do not print headers, i.e. names of groups.
.TP .TP
.B -r, --variable <name> .B \-r, \-\-variable <name>
defines parameter to display. defines parameter to display.
This option can be used multiple times. This option can be used multiple times.
.TP .TP
.B -v, --values-only .B \-v, \-\-values-only
print only values, not parameter names. print only values, not parameter names.
.SH EXAMPLES .SH EXAMPLES
.nf .nf
$ cgget -r cpuset.cpus -r cpuset.mems first second $ cgget \-r cpuset.cpus \-r cpuset.mems first second
first: first:
cpuset.cpus=0-1 cpuset.cpus=0-1
cpuset.mems=0 cpuset.mems=0
@ -66,19 +66,19 @@ second:
cpuset.cpus=0 cpuset.cpus=0
cpuset.mems=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.cpus=0-1
cpuset.mems=0 cpuset.mems=0
cpuset.cpus=0 cpuset.cpus=0
cpuset.mems=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-1
0 0
0 0
0 0
$ cgget -n -g cpu / $ cgget \-n \-g cpu /
cpu.rt_period_us=1000000 cpu.rt_period_us=1000000
cpu.rt_runtime_us=950000 cpu.rt_runtime_us=950000
cpu.shares=1024 cpu.shares=1024

6
doc/man/cgred.conf.5
View File

@ -21,13 +21,13 @@ variable specifies the file to which logs will be written
.TP .TP
\fBNODAEMON\fR \fBNODAEMON\fR
if it is equal to "--nodamon" then if it is equal to "\-\-nodamon" then
run cgred in non-daemon mode run cgred in non-daemon mode
.TP .TP
\fBLOG\fR \fBLOG\fR
define the verbosity of logging. Accepted values are '-v', '-vv', '-q' define the verbosity of logging. Accepted values are '\-v', '\-vv', '\-q'
and '--nolog'. and '\-\-nolog'.
.LP .LP

32
doc/man/cgrulesengd.8
View File

@ -21,40 +21,40 @@ The daemon opens a standard unix socket to receive 'sticky' requests from \fBcge
.SH OPTIONS .SH OPTIONS
.TP .TP
.B -h|--help .B \-h|\-\-help
Display help. Display help.
.TP .TP
.B -f <path>|--logfile=<path> .B \-f <path>|\-\-logfile=<path>
Write log messages to the given log file. When '-' is used as <path>, log messages Write log messages to the given log file. When '\-' is used as <path>, log messages
are written to the standard output. If '\fB-f\fR' and '\fB-s\fR' are used together, are written to the standard output. If '\fB\-f\fR' and '\fB\-s\fR' are used together,
the logs are sent to both destinations. the logs are sent to both destinations.
.TP .TP
.B -s[facility]|--syslog=[facility] .B \-s[facility]|\-\-syslog=[facility]
Write log messages to syslog. The default facility is DAEMON. If '\fB-f\fR' 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. and '\fB\-s\fR' are used together, the logs are sent to both destinations.
.TP .TP
.B -n|--nodaemon .B \-n|\-\-nodaemon
Don't fork the daemon, stay in the foreground. Don't fork the daemon, stay in the foreground.
.TP .TP
.B -v|--verbose .B \-v|\-\-verbose
Display more log messages. This option can be used three times to enable more Display more log messages. This option can be used three times to enable more
verbose log messages. verbose log messages.
.TP .TP
.B -q|--quiet .B \-q|\-\-quiet
Display less log messages. Display less log messages.
.TP .TP
.B -Q|--nolog .B \-Q|\-\-nolog
Disable logging. Disable logging.
.TP .TP
.B -d|--debug .B \-d|\-\-debug
Equivalent to '-nvvvf -', i.e. don't fork the daemon, display all log messages and Equivalent to '\-nvvvf \-', i.e. don't fork the daemon, display all log messages and
write them to the standard output. write them to the standard output.
.TP .TP
.B -u <user>|--socket-user=<user> .B \-u <user>|\-\-socket-user=<user>
.B -g <group>|--socket-group=<group> .B \-g <group>|\-\-socket-group=<group>
Set the owner of cgrulesengd socket. Assumes that \fBcgexec\fR runs with proper 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 .SH ENVIRONMENT VARIABLES
.TP .TP

8
doc/man/cgset.1
View File

@ -7,9 +7,9 @@
cgset \- set the parameters of given cgroup(s) cgset \- set the parameters of given cgroup(s)
.SH SYNOPSIS .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 .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 .SH DESCRIPTION
Set the parameters of input cgroups. 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. This parameter can be used multiple times.
.TP .TP
.B -r <name=value> .B \-r <name=value>
defines the name of the file to set and defines the name of the file to set and
the value which should be written to that file. the value which should be written to that file.
This parameter can be used multiple times. This parameter can be used multiple times.
.TP .TP
.B --copy-from <source_cgroup_path> .B \-\-copy-from <source_cgroup_path>
defines the name of the cgroup whose parameters will be defines the name of the cgroup whose parameters will be
copied to the input cgroup. copied to the input cgroup.

20
doc/man/cgsnapshot.1
View File

@ -7,8 +7,8 @@
cgsnapshot \- generate the configuration file for given controllers cgsnapshot \- generate the configuration file for given controllers
.SH SYNOPSIS .SH SYNOPSIS
\fBcgsnapshot\fR [\fB-h\fR] [\fB-s\fR] [\fB-t\fR] [\fB-b\fR \fIfile\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] [...] [\fB\-w\fR \fIfile\fR] [\fB\-f\fR \fIoutput_file\fR] [\fBcontroller\fR] [...]
.SH DESCRIPTION .SH DESCRIPTION
\fBcgsnapshot\fR \fBcgsnapshot\fR
@ -21,7 +21,7 @@ The output is in the same format as the
configuration file. configuration file.
.TP .TP
.B -b file .B \-b file
Display only variables from the blacklist. Display only variables from the blacklist.
The default location of the blacklist is The default location of the blacklist is
.B /etc/cgsnapshot_blacklist.conf. .B /etc/cgsnapshot_blacklist.conf.
@ -33,25 +33,25 @@ If it is not present on the blacklist, the whitelist
is checked. is checked.
.TP .TP
.B -h, --help .B \-h, \-\-help
display this help and exit display this help and exit
.TP .TP
.B -f, --file .B \-f, \-\-file
Redirect the output to output_file Redirect the output to output_file
.TP .TP
.B -s, --silent .B \-s, \-\-silent
Ignore all warnings Ignore all warnings
.TP .TP
.B -t, --strict .B \-t, \-\-strict
Do not display the variables which are not on the whitelist Do not display the variables which are not on the whitelist
.TP .TP
.B -w file .B \-w file
Set the blacklist configuration file. Set the blacklist configuration file.
This list contains all variables which should be displayed by This list contains all variables which should be displayed by
.B cgsnapshot .B cgsnapshot
@ -65,10 +65,10 @@ the variable is displayed and a warning message is produced.
By default the whitelist is not used. By default the whitelist is not used.
The warning message can be omitted using the The warning message can be omitted using the
.B -s, --silent .B \-s, \-\-silent
flag. flag.
If the If the
.B -t, --strict .B \-t, \-\-strict
flag is used, the variable which is not on the whitelist is flag is used, the variable which is not on the whitelist is
not displayed. not displayed.

4
doc/man/lscgroup.1
View File

@ -7,9 +7,9 @@
lscgroup \- list all cgroups lscgroup \- list all cgroups
.SH SYNOPSIS .SH SYNOPSIS
\fBlscgroup\fR [[\fB-g\fR] <\fIcontrollers>:<path\fR>] [...] \fBlscgroup\fR [[\fB\-g\fR] <\fIcontrollers>:<path\fR>] [...]
.br .br
\fBlscgroup\fR [\fB-h|--help\fR] \fBlscgroup\fR [\fB\-h|\-\-help\fR]
.SH DESCRIPTION .SH DESCRIPTION
List all/chosen cgroups. List all/chosen cgroups.

28
doc/man/lssubsys.1
View File

@ -7,13 +7,13 @@
lssubsys \- list hierarchies containing given subsystem lssubsys \- list hierarchies containing given subsystem
.SH SYNOPSIS .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] [...] [\fIcontroller\fR] [...]
.br .br
\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]
[\fB-i|--hierarchies\fR] [\fB-a|--all\fR] [\fB\-i|\-\-hierarchies\fR] [\fB\-a|\-\-all\fR]
.br .br
\fBlssubsys\fR [\fB-h|--help\fR] \fBlssubsys\fR [\fB\-h|\-\-help\fR]
.SH DESCRIPTION .SH DESCRIPTION
\fBlssubsys\fR list the hierarchies containing \fBlssubsys\fR list the hierarchies containing
@ -27,37 +27,37 @@ If this parameter is not used, the command will
list all mounted subsystems. list all mounted subsystems.
.TP .TP
.B -m, --mount-points .B \-m, \-\-mount-points
Display mount points. Only the first mount points of shown hierarchies are displayed. Display mount points. Only the first mount points of shown hierarchies are displayed.
.TP .TP
.B -M, --all-mount-points .B \-M, \-\-all-mount-points
Display mount points. All mount points of shown hierarchies are displayed, each on Display mount points. All mount points of shown hierarchies are displayed, each on
separate line. separate line.
.TP .TP
.B -a, --all .B \-a, \-\-all
Display all subsystems (including unmounted ones). Display all subsystems (including unmounted ones).
.TP .TP
.B -i, --hierarchies .B \-i, \-\-hierarchies
Display the attached hierarchy number if the subsystem is in a hierarchy. Display the attached hierarchy number if the subsystem is in a hierarchy.
If the option If the option
.B -m .B \-m
is also used, the hierarchy number is shown only for unmounted hierarchies. is also used, the hierarchy number is shown only for unmounted hierarchies.
.TP .TP
.B -h, --help .B \-h, \-\-help
Display help and exit. Display help and exit.
.SH EXAMPLE .SH EXAMPLE
The command The command
.B lssubsys -am .B lssubsys \-am
lists all subsystems which are present in the system, lists all subsystems which are present in the system,
mounted ones will be shown with their mount point: mounted ones will be shown with their mount point:
.RS .RS
.nf .nf
$ lssubsys -am $ lssubsys \-am
ns ns
cpuset cpuset
cpu,devices cpu,devices
@ -69,13 +69,13 @@ net_cls /cgroup/net_cls
.RE .RE
.LP .LP
The command The command
.B lssubsys -ami .B lssubsys \-ami
lists all subsystems which are present in the system, lists all subsystems which are present in the system,
mounted subsystems are listed with their mount points, mounted subsystems are listed with their mount points,
unmounted ones which are in a hierarchy are listed with their hierarchy number: unmounted ones which are in a hierarchy are listed with their hierarchy number:
.RS .RS
.nf .nf
$ lssubsys -ami $ lssubsys \-ami
ns ns
cpuset 5 cpuset 5
cpu,devices 6 cpu,devices 6