summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJan Safranek <jsafrane@redhat.com>2010-01-18 16:43:48 +0530
committerBalbir Singh <balbir@linux.vnet.ibm.com>2010-01-18 16:43:48 +0530
commit87e2109b15c5807738bb9e4aa48874753b67cfbb (patch)
tree258c5b731a683611e3a57db1d785e17818598a7b
parentfd3628c00a73f89484f8fcbdaa2c89d2911ee9d7 (diff)
downloadlibcg-87e2109b15c5807738bb9e4aa48874753b67cfbb.tar.gz
libcg-87e2109b15c5807738bb9e4aa48874753b67cfbb.tar.xz
libcg-87e2109b15c5807738bb9e4aa48874753b67cfbb.zip
Add cgget man page.
Signed-off-by: Jan Safranek <jsafrane@redhat.com> Signed-off-by: Balbir Singh <balbir@linux.vnet.ibm.com>
-rw-r--r--doc/man/Makefile.am2
-rw-r--r--doc/man/cgget.159
-rw-r--r--doc/man/cgset.12
3 files changed, 61 insertions, 2 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 4966571..c744917 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -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
index 0000000..485d562
--- /dev/null
+++ b/doc/man/cgget.1
@@ -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)
+
diff --git a/doc/man/cgset.1 b/doc/man/cgset.1
index 5f6e062..94e6225 100644
--- a/doc/man/cgset.1
+++ b/doc/man/cgset.1
@@ -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)