This patch adds the whitelist configuration file man page
Signed-off-by: Ivana Hutarova Varekova <[email protected]> --- doc/man/Makefile.am | 3 ++- doc/man/cgsnapshot.1 | 31 +++++++++++++++++++++++++++++-- doc/man/cgsnapshot_whitelist.conf.5 | 1 + 3 files changed, 32 insertions(+), 3 deletions(-) create mode 100644 doc/man/cgsnapshot_whitelist.conf.5 diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 26338d8..ec751a4 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -1,6 +1,7 @@ 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 cgget.1 \ - cgdelete.1 lssubsys.1 lscgroup.1 cgsnapshot.1 + cgdelete.1 lssubsys.1 lscgroup.1 cgsnapshot.1 \ + cgsnapshot_whitelist.conf.5 EXTRA_DIST = $(man_MANS) diff --git a/doc/man/cgsnapshot.1 b/doc/man/cgsnapshot.1 index 7290e83..ac30fe5 100644 --- a/doc/man/cgsnapshot.1 +++ b/doc/man/cgsnapshot.1 @@ -32,8 +32,32 @@ Ignore all warnings Display only variables from whitelist. The default location of the whitelist is .B/etc/cgsnapshot_whitelist.conf -is the location - +is the location. +.sp 1 +The whitelist contains two type of records: +.RS +.PD 0 +.TP +.B variable=y +means this variable should be listed in +.B cgsnapshot +output. +.TP +.B variable=n +means this variable should not be listed in +.B cgsnapshot +output. In non-silent mode, +.B cgsnapshot +output a warning if it finds a variable which should not be listed. +.PD +.PP +If +.B cgsnapshot +finds a variable which is not on the list, then it output an error message. +Both warnings and errors can be suppressed using +.B -s +option. +.RE .TP .B --whitelist-file file Set the whitelist configuration file @@ -55,6 +79,9 @@ output .B /etc/cgsnapshot_whitelist.conf .TP default location of the whitelist. +The structure of this whitelist is described in section +.B DESCRIPTION +in the part about the option -w .LP .PD .1v .TP 20 diff --git a/doc/man/cgsnapshot_whitelist.conf.5 b/doc/man/cgsnapshot_whitelist.conf.5 new file mode 100644 index 0000000..7cecfc8 --- /dev/null +++ b/doc/man/cgsnapshot_whitelist.conf.5 @@ -0,0 +1 @@ +.so man1/cgsnapshot.1 \ No newline at end of file ------------------------------------------------------------------------------ This SF.net Dev2Dev email is sponsored by: Show off your parallel programming skills. Enter the Intel(R) Threading Challenge 2010. http://p.sf.net/sfu/intel-thread-sfd _______________________________________________ Libcg-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/libcg-devel
