From: Jan Safranek <jsafrane@redhat.com>
Date: Thu, 3 Nov 2011 09:50:14 +0000 (+0100)
Subject: doc: Man page updates
X-Git-Tag: v0.38~29
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1d14e03b4d0ccfaf9fb0ea72c77aa7a2b04cb671;p=thirdparty%2Flibcgroup.git

doc: Man page updates

Update cgconfig and cgclear man pages with new parameters.

Signed-off-by: Jan Safranek <jsafrane@redhat.com>
---

diff --git a/doc/man/cgclear.1 b/doc/man/cgclear.1
index d07e8bb3..0a3ed912 100644
--- a/doc/man/cgclear.1
+++ b/doc/man/cgclear.1
@@ -6,14 +6,36 @@
 cgclear \- unload the cgroup filesystem
 
 .SH SYNOPSIS
-\fBcgclear\fR
+\fBcgclear\fR [\fB-e\fR] [\fB-l\fR <\fIfilename\fR>] [\fB-L\fR <\fIdirectory\fR>] [...]
 
 .SH DESCRIPTION
 
-This command moves all the tasks inside the various cgroups
+Without parameters, this command moves all the tasks inside the various cgroups
 to the root cgroup, deletes all the cgroups and finally
 unmounts the cgroup filesystem from the system.
 
+If one or more config files are specified, only groups defined in the config
+files are removed. The files are processed in reverse order, i.e. the last
+file on command line is processed first, so \fBcgclear\fR can have the same
+command line arguments as appropriate \fBcgconfigparser\fR.
+
+.TP
+.B -l, --load=<filename>
+specifies the config file to read. This option can be used multiple times and
+can be mixed with \fB-L\fR option.
+
+.TP
+.B -L, --load-directory=<directory>
+specifies the directory, which is searched for configuration files. All files
+in this directory will be processed in alphabetical order as they were specified
+by \fB-l\fR option. This option can be used multiple times and
+can be mixed with \fB-l\fR option.
+
+.TP
+.B -e
+specifies that only empty groups should be removed. If a group defined in a
+config file has tasks inside or has a subgroup, it won't be removed. This
+option works only with \fB-l\fR or \fB-L\fR options.
+
 .SH SEE ALSO
 cgconfigparser(1)
-
diff --git a/doc/man/cgconfigparser.8 b/doc/man/cgconfigparser.8
index c850bc19..fdd6956f 100644
--- a/doc/man/cgconfigparser.8
+++ b/doc/man/cgconfigparser.8
@@ -7,11 +7,11 @@
 cgconfigparser \- setup control group file system
 
 .SH SYNOPSIS
-\fBcgconfigparser\fR [\fB-h\fR | \fB-l\fR \fI<filename>\fR]
+\fBcgconfigparser\fR [\fB-h\fR] [\fB-l\fR \fI<filename>\fR] [\fB-L\fR \fI<directory>\fR] [...]
 
 .SH OPTIONS
 .TP
-.B -h|--help
+.B -h, --help
 Displays help.
 .TP
 .B -l, --load=FILE
@@ -20,7 +20,13 @@ Sets up the control group file system
 defined by the configuration file and mounts
 mount points defined by the configuration file.
 The format of the file is described in
-\fBcgconfig.conf\fR.
+\fBcgconfig.conf\fR. This option can be used multiple times and can be mixed
+with \fB-L\fR option.
+.TP
+.B -L, --load-directory=DIR
+Finds all files in given directory and parses them in alphabetical order
+like they were specified by \fB-l\fR option. This option can be used
+multiple times and can be mixed with \fB-l\fR option.
 .LP
 
 .SH SEE ALSO