documentation: add examples to man pages

This patch add examples and missing info in file section libcgroup man pages.

Signed-off-by: Ivana Hutarova Varekova <varekova@redhat.com>
Acked-by: Jan Chaloupka<jchaloup@redhat.com>

diff --git a/doc/man/cgclassify.1 b/doc/man/cgclassify.1
index db4e0863a35b3dc1a59069e60e4c6798e2b18ac3..1facd2b2fde332983fe4b328933b655302a1978c 100644 (file)
--- a/doc/man/cgclassify.1
+++ b/doc/man/cgclassify.1
@@ -57,7 +57,25 @@ controls verbosity of the tool. Allowed values are \fBDEBUG\fR,
 .TP
 .B /etc/cgrules.conf
 default libcgroup configuration file
+.TP
+.B /etc/cgrules.d
+default libcgroup configuration files directory
+
+.SH EXAMPLES
+.TP
+.B cgclassify -g cpu:student 1234
+moves process with pid number 1234 to control group student in cpu hierarchy.
 
+.TP
+.B cgclassify 1234
+moves process with pid number 1234 to control groups based on
+\fB/etc/cgrules.conf\fR configuration file.
+
+.TP
+.B cgclassify --sticky -g cpu:/student 1234
+moves process with pid number 1234 to control group student in cpu hierarchy.
+The daemon of service cgred does not change cgroups of pid 1234 and its children
+(based on \fB/etc/cgrules.conf\fR).
 
 .SH SEE ALSO
 cgrules.conf (5), cgexec (1)

diff --git a/doc/man/cgclear.1 b/doc/man/cgclear.1
index 318c9254657c1d321575007901b54d490e9c255b..241a095626c167513da32e66078024250edc82a5 100644 (file)
--- a/doc/man/cgclear.1
+++ b/doc/man/cgclear.1
@@ -43,5 +43,24 @@ option works only with \fB-l\fR or \fB-L\fR options.
 controls verbosity of the tool. Allowed values are \fBDEBUG\fR,
 \fBINFO\fR, \fBWARNING\fR or \fBERROR\fR.
 
+.SH FILES
+.TP
+.B /etc/cgconfig.conf
+default templates file
+.TP
+.B /etc/cgconfig.d/
+default templates files directory
+.RE
+
+
+.SH EXAMPLES
+.TP
+.B cgclear
+unload the whole cgroup filesystem
+
+.TP
+.B cgclear -l /etc/cgconfig.conf
+unload a subsystem of cgroup filesystem based on \fB/etc/cgconfig.conf\fR definition.
+
 .SH SEE ALSO
-cgconfigparser(1)
+cgconfigparser(1), cgconfig.conf(5)

diff --git a/doc/man/cgconfig.conf.5 b/doc/man/cgconfig.conf.5
index a7d99354f85fd063ad5b7bd7d88b5d5f23f55d71..f3a4ba91c1d7574776371435e6fe2e03590a2b85 100644 (file)
--- a/doc/man/cgconfig.conf.5
+++ b/doc/man/cgconfig.conf.5
@@ -784,15 +784,12 @@ better to explicitly specify all groups and all controllers
 related to them.
 
 .SH FILES
-.LP
-.PD .1v
 .TP
 .B /etc/cgconfig.conf
-.TP
 default libcgroup configuration file
+.TP
 .B /etc/cgconfig.d/
 default libcgroup configuration files directory
-.PD 
 
 .SH SEE ALSO
 cgconfigparser (8)

diff --git a/doc/man/cgconfigparser.8 b/doc/man/cgconfigparser.8
index 0a20f958fa7c6e8f7c0b3e57c91e34bc1dfc61a3..8fff95f450b1fc1bd5d368275d85bfdc2cf017c9 100644 (file)
--- a/doc/man/cgconfigparser.8
+++ b/doc/man/cgconfigparser.8
@@ -74,5 +74,19 @@ of this group have write access to the file.
 controls verbosity of the tool. Allowed values are \fBDEBUG\fR,
 \fBINFO\fR, \fBWARNING\fR or \fBERROR\fR.
 
+.SH FILES
+.TP
+.B /etc/cgconfig.conf
+default libcgroup configuration file
+.TP
+.B /etc/cgconfig.d/
+default libcgroup configuration files directory
+
+.SH EXAMPLES
+.TP
+.B cgconfigparser -l /etc/cgconfig.conf
+setup control group file system based on \fB/etc/cgconfig.conf\fR configuration file
+
+
 .SH SEE ALSO
 cgconfig.conf (5)

diff --git a/doc/man/cgcreate.1 b/doc/man/cgcreate.1
index 557b5aee09b8066fceda1d1fdf89c5d800ab5ca4..6ec1b27ca43de084c4fd44e0b2ea496ff46bc058 100644 (file)
--- a/doc/man/cgcreate.1
+++ b/doc/man/cgcreate.1
@@ -70,9 +70,16 @@ The default value is the same as has the parent cgroup.
 controls verbosity of the tool. Allowed values are \fBDEBUG\fR,
 \fBINFO\fR, \fBWARNING\fR or \fBERROR\fR.
 
-.SH FILES
+.SH EXAMPLES
+.TP
+.B cgcreate -g *:student devices:teacher
+create control group student in all mounted hierarchies and create
+control group teacher in hierarchy containing controller devices.
+
+
+
 
 .SH SEE ALSO
 cgrules.conf (5)
 cgexec (1)
-cgclassify (1)
+cgclassify (1)
\ No newline at end of file

diff --git a/doc/man/cgdelete.1 b/doc/man/cgdelete.1
index 025a799e97534a0627dbac6f0c30f22893d217f7..957228713142191e031d500c76d00c29f5b36b62 100644 (file)
--- a/doc/man/cgdelete.1
+++ b/doc/man/cgdelete.1
@@ -16,7 +16,7 @@ program removes all specified control groups.
 
 .TP
 .B [-g] <controllers>:<path>
-Defines the control group to delete. Multiple control groups nay be
+Defines the control group to delete. Multiple control groups may be
 specified.
 .B -g
 is optional.
@@ -35,5 +35,11 @@ Recursively remove all subgroups.
 controls verbosity of the tool. Allowed values are \fBDEBUG\fR,
 \fBINFO\fR, \fBWARNING\fR or \fBERROR\fR.
 
+.SH EXAMPLES
+.TP
+.B cgdelete -g cpu,devices:/test
+remove control group test from hierarchies containing cpu and device controllers
+
+
 .SH SEE ALSO
 cgcreate (1), lscgroup (1), cgclear (1)

diff --git a/doc/man/cgred.conf.5 b/doc/man/cgred.conf.5
index 3fe760fb2e8cd8f235436b43b1c14dd8d208f0f1..1c0922f4d51e86dab46e47fba4c70127606d731e 100644 (file)
--- a/doc/man/cgred.conf.5
+++ b/doc/man/cgred.conf.5
@@ -42,7 +42,7 @@ default libcgroup configuration file
 
 .SH SEE ALSO
 cgrules.conf (5),
-cgconfig.conf (5)
+cgconfig.conf (5), cgrules.d (5)
 
 
 

diff --git a/doc/man/cgrulesengd.8 b/doc/man/cgrulesengd.8
index ba654b9dc886856991afb36fa9f6733eb09347bc..cf45611853d2173714d8b55665fb086c534b0943 100644 (file)
--- a/doc/man/cgrulesengd.8
+++ b/doc/man/cgrulesengd.8
@@ -64,27 +64,21 @@ controls verbosity of the tool. Allowed values are \fBDEBUG\fR,
 \fBINFO\fR, \fBWARNING\fR or \fBERROR\fR.
 
 .SH FILES
-.LP
-.PD .1v
 .TP
 .B /etc/cgrules.conf
-.RS 6
-the default libcgroup configuration file
-.RE
+default libcgroup configuration file
+
+.TP
 .B /etc/cgrules.d
-.RS 6
-the default libcgroup configuration files directory
-.RE
+default libcgroup configuration files directory
+
 .TP
 .B /etc/cgconfig.conf
-.RS 6
-the default templates file
-.RE
+default templates file
+
 .TP
-.B /etc/cgconfig.d/
-.RS 6
-the default templates directory
-.RE
+.B /etc/cgconfig.d
+default templates directory
 
 .SH SEE ALSO
 cgrules.conf (5), cgrules.d (5)

diff --git a/doc/man/cgset.1 b/doc/man/cgset.1
index be886c67a20b7118bd2b1580f24dfc3a577fe152..b05473f14fbf866697bf73708ae88aff8f236eb6 100644 (file)
--- a/doc/man/cgset.1
+++ b/doc/man/cgset.1
@@ -36,5 +36,16 @@ copied to the input cgroup.
 controls verbosity of the tool. Allowed values are \fBDEBUG\fR,
 \fBINFO\fR, \fBWARNING\fR or \fBERROR\fR.
 
+.SH EXAMPLES
+.TP
+.B cgset -r cpuset.cpus=0-1 student
+set variable cpus in control group student (controller cpuset) to 0-1
+
+.TP
+.B cgset --copy-from group1/ group2/
+copy all parameters of group group1 to group group2
+(for all path where both cgroups are defined)
+
+
 .SH SEE ALSO
 cgrules.conf (1), cgcreate (1), cgget (1)

diff --git a/doc/man/cgsnapshot.1 b/doc/man/cgsnapshot.1
index 03c85f6aff2c3d2f1858f2feee0087812e8fc797..48a038ed38c89d11114093fbf7cfa85d61ecc65d 100644 (file)
--- a/doc/man/cgsnapshot.1
+++ b/doc/man/cgsnapshot.1
@@ -8,7 +8,7 @@ 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] [...]
+[\fB-w\fR \fIfile\fR] [\fB-f\fR \fIoutput_file\fR] [\fBcontroller\fR] [...]
 
 .SH DESCRIPTION
 \fBcgsnapshot\fR
@@ -96,5 +96,18 @@ default whitelist
 .B /etc/cgconfig.conf
 default libcgroup configuration file
 
+.SH EXAMPLES
+.TP
+.B cgsnapshot -s -f /etc/cgconfig.conf.cgsnapshot
+create configuration file which contains all mounted controllers and all
+control groups which are on the actual system
+
+.TP
+.B cgsnapshot -s -f /etc/cgconfig.conf.cgsnapshot cpu
+create configuration file which contains hierarchy containing cpu controller and all its
+control groups on the actual system
+
+
+
 .SH SEE ALSO
 cgconfig.conf (5)

diff --git a/doc/man/lscgroup.1 b/doc/man/lscgroup.1
index 693fbbcfcd823350dbe220e86c01e4e6fc3cd1e0..124379e0b739a4f955e916c89d2797c5496d0e13 100644 (file)
--- a/doc/man/lscgroup.1
+++ b/doc/man/lscgroup.1
@@ -26,6 +26,21 @@ list all existing cgroups.
 controls verbosity of the tool. Allowed values are \fBDEBUG\fR,
 \fBINFO\fR, \fBWARNING\fR or \fBERROR\fR.
 
+.SH EXAMPLES
+.TP
+.B lscgroup -g cpu:/
+list all cgroups which are in hierarchy containing cpu controller
+
+.TP
+.B lscgroup -g cpu:/student
+list all cgroups which are in hierarchy containing cpu controller
+in subgroup student
+
+.TP
+.B lscgroup
+list all cgroups which in all hierarchies
+
+
 .SH SEE ALSO
 lssubsys (1), cgcreate (1), cgdelete (1),
 cgconfig.conf (5)