From: Tom Hromatka Date: Wed, 3 Aug 2022 19:33:18 +0000 (-0600) Subject: man/cgxget: add man page for cgxget X-Git-Tag: v3.0~3^2~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6cdf75ee6958adfaf7ac7307e131bbacac69fdeb;p=thirdparty%2Flibcgroup.git man/cgxget: add man page for cgxget Reviewed-by: Kamalesh Babulal Signed-off-by: Tom Hromatka --- diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 8b2f4117..c5e9042a 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -1,6 +1,7 @@ man_MANS = cgclassify.1 cgconfig.conf.5 cgconfigparser.8 cgexec.1 \ cgred.conf.5 cgrules.conf.5 cgrulesengd.8 cgcreate.1 cgset.1 \ - cgget.1 cgdelete.1 lssubsys.1 lscgroup.1 cgsnapshot.1 + cgget.1 cgdelete.1 lssubsys.1 lscgroup.1 cgsnapshot.1 \ + cgxget.1 EXTRA_DIST = $(man_MANS) diff --git a/doc/man/cgxget.1 b/doc/man/cgxget.1 new file mode 100644 index 00000000..df502131 --- /dev/null +++ b/doc/man/cgxget.1 @@ -0,0 +1,122 @@ +.TH CGXGET 1 2022-08-03 "Linux" "libcgroup Manual" +.SH NAME + +cgxget \- print parameter(s) of given group(s) + +.SH SYNOPSIS +\fBcgxget\fR [\fB-1\fR] [\fB-2\fR] [\fB-i\fR] [\fB-n\fR] [\fB-v\fR] [\fB-r\fR <\fIname\fR>] +[\fB-g\fR <\fIcontroller\fR>] [\fB-a\fR] <\fBpath\fR> ... +.br +\fBcgxget\fR [\fB-1\fR] [\fB-2\fR] [\fB-i\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). +If neither controller nor variable are specified, +the values of all possible variables are displayed. +When the request's cgroup version differs from the system's cgroup version, \fBcgxget\fR will +attempt to translate from one version to the other. +If the request version and the system's version are the same, no translation is done and +\fBcgxget\fR will behave like \fBcgget\fR. +If no version is specified by the user (either [\fB-1\fR] or [\fB-2\fR]), the behavior is +undefined. + +.TP +.B +is the name of the cgroup which should be read. +This parameter can be used multiple times. + +.TP +.B -1, --v1 +data in/out of \fBcgxget\fR is in cgroup v1 format. +In this mode, the user will provide values in cgroup v1 format and receive values in v1 format. +format. +If the system is running in cgroup v2 mode, libcgroup will convert the data as necessary + +.TP +.B -2, --v2 +data in/out of \fBcgxget\fR is in cgroup v2 format. +In this mode, the user will provide values in cgroup v2 format and receive values in v2 format. +If the system is running in cgroup v1 mode, libcgroup will convert the data as necessary + +.TP +.B -a, --all +print the variables for all controllers which consist in the given cgroup + +.TP +.B -g +defines controllers whose values should be displayed. +This option can be used multiple times. + +.TP +.B -g : +defines control groups whose values should be displayed. +This option can be used multiple times. + +.TP +.B -h, --help +display help and exit + +.TP +.B -i, --ignore-unmappable +ignore errors for values that cannot be converted from v1 to v2 or vice versa + +.TP +.B -n +do not print headers, i.e. names of groups. + +.TP +.B -r, --variable +defines parameter to display. +This option can be used multiple times. + + +.TP +.B -v, --values-only +print only values, not parameter names. + +.SH EXAMPLES +.nf +$ cgxget -1 -r cpuset.cpus -r cpuset.mems first second +first: +cpuset.cpus=0-1 +cpuset.mems=0 + +second: +cpuset.cpus=0 +cpuset.mems=0 + +$ cgxget -1 -n -r cpuset.cpus -r cpuset.mems first second +cpuset.cpus=0-1 +cpuset.mems=0 +cpuset.cpus=0 +cpuset.mems=0 + +$ cgxget -1 -nv -r cpuset.cpus -r cpuset.mems first second +0-1 +0 +0 +0 + +$ cgxget -1 -n -g cpu / +cpu.rt_period_us=1000000 +cpu.rt_runtime_us=950000 +cpu.shares=1024 + +$ cgxget -2 -r cpu.max first +first: +cpu.max: max 100000 + +.fi + +.SH ENVIRONMENT VARIABLES +.TP +.B CGROUP_LOGLEVEL +controls verbosity of the tool. Allowed values are \fBDEBUG\fR, +\fBINFO\fR, \fBWARNING\fR or \fBERROR\fR. + +.SH AUTHOR +Tom Hromatka + +.SH SEE ALSO +cgrules.conf (1), cgcreate (1), cgget (1), cgset (1), cgxset (1)