Blame SOURCES/libcgroup-0.41-add-examples-to-man-pages.patch

308897
From d58a95615a146f868106411aecd61af182d7c7e2 Mon Sep 17 00:00:00 2001
308897
From: Jan Chaloupka <jchaloup@redhat.com>
308897
Date: Sun, 21 Sep 2014 12:05:11 +0200
308897
Subject: [PATCH] add examples to man pages
308897
308897
---
308897
 doc/man/cgclassify.1     | 18 ++++++++++++++++++
308897
 doc/man/cgclear.1        | 21 ++++++++++++++++++++-
308897
 doc/man/cgconfig.conf.5  |  5 +----
308897
 doc/man/cgconfigparser.8 | 14 ++++++++++++++
308897
 doc/man/cgcreate.1       |  9 ++++++++-
308897
 doc/man/cgdelete.1       |  8 +++++++-
308897
 doc/man/cgred.conf.5     |  2 +-
308897
 doc/man/cgrulesengd.8    |  3 ---
308897
 doc/man/cgset.1          | 11 +++++++++++
308897
 doc/man/cgsnapshot.1     | 15 ++++++++++++++-
308897
 doc/man/lscgroup.1       | 15 +++++++++++++++
308897
 11 files changed, 109 insertions(+), 12 deletions(-)
308897
308897
diff --git a/doc/man/cgclassify.1 b/doc/man/cgclassify.1
308897
index db4e086..1facd2b 100644
308897
--- a/doc/man/cgclassify.1
308897
+++ b/doc/man/cgclassify.1
308897
@@ -57,7 +57,25 @@ controls verbosity of the tool. Allowed values are \fBDEBUG\fR,
308897
 .TP
308897
 .B /etc/cgrules.conf
308897
 default libcgroup configuration file
308897
+.TP
308897
+.B /etc/cgrules.d
308897
+default libcgroup configuration files directory
308897
+
308897
+.SH EXAMPLES
308897
+.TP
308897
+.B cgclassify -g cpu:student 1234
308897
+moves process with pid number 1234 to control group student in cpu hierarchy.
308897
 
308897
+.TP
308897
+.B cgclassify 1234
308897
+moves process with pid number 1234 to control groups based on
308897
+\fB/etc/cgrules.conf\fR configuration file.
308897
+
308897
+.TP
308897
+.B cgclassify --sticky -g cpu:/student 1234
308897
+moves process with pid number 1234 to control group student in cpu hierarchy.
308897
+The daemon of service cgred does not change cgroups of pid 1234 and its children
308897
+(based on \fB/etc/cgrules.conf\fR).
308897
 
308897
 .SH SEE ALSO
308897
 cgrules.conf (5), cgexec (1)
308897
diff --git a/doc/man/cgclear.1 b/doc/man/cgclear.1
308897
index 318c925..241a095 100644
308897
--- a/doc/man/cgclear.1
308897
+++ b/doc/man/cgclear.1
308897
@@ -43,5 +43,24 @@ option works only with \fB-l\fR or \fB-L\fR options.
308897
 controls verbosity of the tool. Allowed values are \fBDEBUG\fR,
308897
 \fBINFO\fR, \fBWARNING\fR or \fBERROR\fR.
308897
 
308897
+.SH FILES
308897
+.TP
308897
+.B /etc/cgconfig.conf
308897
+default templates file
308897
+.TP
308897
+.B /etc/cgconfig.d/
308897
+default templates files directory
308897
+.RE
308897
+
308897
+
308897
+.SH EXAMPLES
308897
+.TP
308897
+.B cgclear
308897
+unload the whole cgroup filesystem
308897
+
308897
+.TP
308897
+.B cgclear -l /etc/cgconfig.conf
308897
+unload a subsystem of cgroup filesystem based on \fB/etc/cgconfig.conf\fR definition.
308897
+
308897
 .SH SEE ALSO
308897
-cgconfigparser(1)
308897
+cgconfigparser(1), cgconfig.conf(5)
308897
diff --git a/doc/man/cgconfig.conf.5 b/doc/man/cgconfig.conf.5
308897
index a7d9935..f3a4ba9 100644
308897
--- a/doc/man/cgconfig.conf.5
308897
+++ b/doc/man/cgconfig.conf.5
308897
@@ -784,15 +784,12 @@ better to explicitly specify all groups and all controllers
308897
 related to them.
308897
 
308897
 .SH FILES
308897
-.LP
308897
-.PD .1v
308897
 .TP
308897
 .B /etc/cgconfig.conf
308897
-.TP
308897
 default libcgroup configuration file
308897
+.TP
308897
 .B /etc/cgconfig.d/
308897
 default libcgroup configuration files directory
308897
-.PD 
308897
 
308897
 .SH SEE ALSO
308897
 cgconfigparser (8)
308897
diff --git a/doc/man/cgconfigparser.8 b/doc/man/cgconfigparser.8
308897
index 0a20f95..8fff95f 100644
308897
--- a/doc/man/cgconfigparser.8
308897
+++ b/doc/man/cgconfigparser.8
308897
@@ -74,5 +74,19 @@ of this group have write access to the file.
308897
 controls verbosity of the tool. Allowed values are \fBDEBUG\fR,
308897
 \fBINFO\fR, \fBWARNING\fR or \fBERROR\fR.
308897
 
308897
+.SH FILES
308897
+.TP
308897
+.B /etc/cgconfig.conf
308897
+default libcgroup configuration file
308897
+.TP
308897
+.B /etc/cgconfig.d/
308897
+default libcgroup configuration files directory
308897
+
308897
+.SH EXAMPLES
308897
+.TP
308897
+.B cgconfigparser -l /etc/cgconfig.conf
308897
+setup control group file system based on \fB/etc/cgconfig.conf\fR configuration file
308897
+
308897
+
308897
 .SH SEE ALSO
308897
 cgconfig.conf (5)
308897
diff --git a/doc/man/cgcreate.1 b/doc/man/cgcreate.1
308897
index 557b5ae..17c33d8 100644
308897
--- a/doc/man/cgcreate.1
308897
+++ b/doc/man/cgcreate.1
308897
@@ -70,7 +70,14 @@ The default value is the same as has the parent cgroup.
308897
 controls verbosity of the tool. Allowed values are \fBDEBUG\fR,
308897
 \fBINFO\fR, \fBWARNING\fR or \fBERROR\fR.
308897
 
308897
-.SH FILES
308897
+.SH EXAMPLES
308897
+.TP
308897
+.B cgcreate -g *:student -g devices:teacher
308897
+create control group student in all mounted hierarchies and create
308897
+control group teacher in hierarchy containing controller devices.
308897
+
308897
+
308897
+
308897
 
308897
 .SH SEE ALSO
308897
 cgrules.conf (5)
308897
diff --git a/doc/man/cgdelete.1 b/doc/man/cgdelete.1
308897
index 025a799..9572287 100644
308897
--- a/doc/man/cgdelete.1
308897
+++ b/doc/man/cgdelete.1
308897
@@ -16,7 +16,7 @@ program removes all specified control groups.
308897
 
308897
 .TP
308897
 .B [-g] <controllers>:<path>
308897
-Defines the control group to delete. Multiple control groups nay be
308897
+Defines the control group to delete. Multiple control groups may be
308897
 specified.
308897
 .B -g
308897
 is optional.
308897
@@ -35,5 +35,11 @@ Recursively remove all subgroups.
308897
 controls verbosity of the tool. Allowed values are \fBDEBUG\fR,
308897
 \fBINFO\fR, \fBWARNING\fR or \fBERROR\fR.
308897
 
308897
+.SH EXAMPLES
308897
+.TP
308897
+.B cgdelete -g cpu,devices:/test
308897
+remove control group test from hierarchies containing cpu and device controllers
308897
+
308897
+
308897
 .SH SEE ALSO
308897
 cgcreate (1), lscgroup (1), cgclear (1)
308897
diff --git a/doc/man/cgred.conf.5 b/doc/man/cgred.conf.5
308897
index 3fe760f..1c0922f 100644
308897
--- a/doc/man/cgred.conf.5
308897
+++ b/doc/man/cgred.conf.5
308897
@@ -42,7 +42,7 @@ default libcgroup configuration file
308897
 
308897
 .SH SEE ALSO
308897
 cgrules.conf (5),
308897
-cgconfig.conf (5)
308897
+cgconfig.conf (5), cgrules.d (5)
308897
 
308897
 
308897
 
308897
diff --git a/doc/man/cgrulesengd.8 b/doc/man/cgrulesengd.8
308897
index 749b6fc..2810aa5 100644
308897
--- a/doc/man/cgrulesengd.8
308897
+++ b/doc/man/cgrulesengd.8
308897
@@ -63,11 +63,8 @@ controls verbosity of the tool. Allowed values are \fBDEBUG\fR,
308897
 \fBINFO\fR, \fBWARNING\fR or \fBERROR\fR.
308897
 
308897
 .SH FILES
308897
-.LP
308897
-.PD .1v
308897
 .TP
308897
 .B /etc/cgrules.conf
308897
-.TP
308897
 the default libcgroup configuration file
308897
 .TP
308897
 .B /etc/cgconfig.conf
308897
diff --git a/doc/man/cgset.1 b/doc/man/cgset.1
308897
index be886c6..b05473f 100644
308897
--- a/doc/man/cgset.1
308897
+++ b/doc/man/cgset.1
308897
@@ -36,5 +36,16 @@ copied to the input cgroup.
308897
 controls verbosity of the tool. Allowed values are \fBDEBUG\fR,
308897
 \fBINFO\fR, \fBWARNING\fR or \fBERROR\fR.
308897
 
308897
+.SH EXAMPLES
308897
+.TP
308897
+.B cgset -r cpuset.cpus=0-1 student
308897
+set variable cpus in control group student (controller cpuset) to 0-1
308897
+
308897
+.TP
308897
+.B cgset --copy-from group1/ group2/
308897
+copy all parameters of group group1 to group group2
308897
+(for all path where both cgroups are defined)
308897
+
308897
+
308897
 .SH SEE ALSO
308897
 cgrules.conf (1), cgcreate (1), cgget (1)
308897
diff --git a/doc/man/cgsnapshot.1 b/doc/man/cgsnapshot.1
308897
index 03c85f6..48a038e 100644
308897
--- a/doc/man/cgsnapshot.1
308897
+++ b/doc/man/cgsnapshot.1
308897
@@ -8,7 +8,7 @@ cgsnapshot \- generate the configuration file for given controllers
308897
 
308897
 .SH SYNOPSIS
308897
 \fBcgsnapshot\fR [\fB-h\fR] [\fB-s\fR] [\fB-t\fR] [\fB-b\fR \fIfile\fR]
308897
-[\fB-w\fR \fIfile\fR] [\fB-f\fR \fIoutput_file\fR]  [\fBcontroller\fR] [...]
308897
+[\fB-w\fR \fIfile\fR] [\fB-f\fR \fIoutput_file\fR] [\fBcontroller\fR] [...]
308897
 
308897
 .SH DESCRIPTION
308897
 \fBcgsnapshot\fR
308897
@@ -96,5 +96,18 @@ default whitelist
308897
 .B /etc/cgconfig.conf
308897
 default libcgroup configuration file
308897
 
308897
+.SH EXAMPLES
308897
+.TP
308897
+.B cgsnapshot -s -f /etc/cgconfig.conf.cgsnapshot
308897
+create configuration file which contains all mounted controllers and all
308897
+control groups which are on the actual system
308897
+
308897
+.TP
308897
+.B cgsnapshot -s -f /etc/cgconfig.conf.cgsnapshot cpu
308897
+create configuration file which contains hierarchy containing cpu controller and all its
308897
+control groups on the actual system
308897
+
308897
+
308897
+
308897
 .SH SEE ALSO
308897
 cgconfig.conf (5)
308897
diff --git a/doc/man/lscgroup.1 b/doc/man/lscgroup.1
308897
index 693fbbc..124379e 100644
308897
--- a/doc/man/lscgroup.1
308897
+++ b/doc/man/lscgroup.1
308897
@@ -26,6 +26,21 @@ list all existing cgroups.
308897
 controls verbosity of the tool. Allowed values are \fBDEBUG\fR,
308897
 \fBINFO\fR, \fBWARNING\fR or \fBERROR\fR.
308897
 
308897
+.SH EXAMPLES
308897
+.TP
308897
+.B lscgroup -g cpu:/
308897
+list all cgroups which are in hierarchy containing cpu controller
308897
+
308897
+.TP
308897
+.B lscgroup -g cpu:/student
308897
+list all cgroups which are in hierarchy containing cpu controller
308897
+in subgroup student
308897
+
308897
+.TP
308897
+.B lscgroup
308897
+list all cgroups which in all hierarchies
308897
+
308897
+
308897
 .SH SEE ALSO
308897
 lssubsys (1), cgcreate (1), cgdelete (1),
308897
 cgconfig.conf (5)
308897
-- 
308897
1.9.3
308897