]> git.ipfire.org Git - thirdparty/libcgroup.git/commitdiff
Add cgget man page.
authorJan Safranek <jsafrane@redhat.com>
Mon, 18 Jan 2010 11:13:48 +0000 (16:43 +0530)
committerBalbir Singh <balbir@linux.vnet.ibm.com>
Mon, 18 Jan 2010 11:13:48 +0000 (16:43 +0530)
Signed-off-by: Jan Safranek <jsafrane@redhat.com>
Signed-off-by: Balbir Singh <balbir@linux.vnet.ibm.com>
doc/man/Makefile.am
doc/man/cgget.1 [new file with mode: 0644]
doc/man/cgset.1

index 49665714ff66615df54ea44fda3948ae5dad6441..c744917b00114750df32b95f856985b3be21d55b 100644 (file)
@@ -1,5 +1,5 @@
 man_MANS = cgclassify.1 cgconfig.conf.5 cgconfigparser.8 cgexec.1 cgred.conf.5 \
-           cgrules.conf.5 cgrulesengd.8 cgcreate.1 cgset.1 cgclear.1
+           cgrules.conf.5 cgrulesengd.8 cgcreate.1 cgset.1 cgclear.1 cgget.1
 
 EXTRA_DIST = $(man_MANS)
 
diff --git a/doc/man/cgget.1 b/doc/man/cgget.1
new file mode 100644 (file)
index 0000000..485d562
--- /dev/null
@@ -0,0 +1,59 @@
+.\" Copyright (C) 2010 Red Hat, Inc. All Rights Reserved.
+.\" Written by Jan Safranek <jsafrane@redhat.com>
+
+.TH CGGET  1 2010-01-18 "Linux" "libcgroup Manual"
+.SH NAME
+
+cgget \- print parameter(s) of given group(s)
+
+.SH SYNOPSIS
+\fBcgget\fR [\fB-n\fR] [\fB-v\fR] [\fB-r\fR <\fIname\fR>] <\fBcgroup_path\fR> ...
+
+.SH DESCRIPTION
+The command prints the parameter(s) of input cgroup(s).
+
+.TP
+.B <path>
+is the name of the cgroup which should be read.
+This parameter can be used multiple times.
+
+.TP
+.B -r <name>
+defines parameter to display.
+This option can be used multiple times.
+
+.TP
+.B -n
+do not print headers, i.e. name of groups.
+
+.TP
+.B -v
+print only values, not parameter names.
+
+.SH EXAMPLES
+.nf
+$ cgget -r cpuset.cpus -r cpuset.mems first second
+first:
+cpuset.cpus=0-1
+cpuset.mems=0
+
+second:
+cpuset.cpus=0
+cpuset.mems=0
+
+$ 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
+0-1
+0
+0
+0
+.fi
+
+.SH SEE ALSO
+cgsules.conf (1), cgcreate (1), cgget (1)
+
index 5f6e062dbaeb357d6d9f35510912bc70b0f989ef..94e6225b48dbea23e1dc3e7d86b72fb5fe54f0cd 100644 (file)
@@ -30,4 +30,4 @@ defines name of cgroup whose parameters will be
 coppied to input cgroup.
 
 .SH SEE ALSO
-cgsules.conf (1), cgcreate (1)
\ No newline at end of file
+cgrules.conf (1), cgcreate (1), cgget (1)