Ondřej Vašík <[EMAIL PROTECTED]> wrote:
> as those commands were not documented in info documentation, I wrote
> basic info documentation for runcon and chcon command (and related
> SELinux context menu section). It is completely based on man
> documentation, I would say just the first step to have them documented.
> Patch is in attachement.
Thanks for doing that!
I've added to your patch with the following.
Please fold this into yours and add similar mark-up for runcon.
Also, it'd be good to document the exit status values that runcon uses,
as is done for at least nohup and timeout.
>From 246ef8da7b03037e1666c9a1ff479ab3fdec14e2 Mon Sep 17 00:00:00 2001
From: Jim Meyering <[EMAIL PROTECTED]>
Date: Tue, 7 Oct 2008 00:03:35 +0200
Subject: [PATCH] tweak wording, add formatting like @var, @option
---
doc/coreutils.texi | 81 ++++++++++++++++++++++++---------------------------
1 files changed, 38 insertions(+), 43 deletions(-)
diff --git a/doc/coreutils.texi b/doc/coreutils.texi
index 5bb1f73..440e519 100644
--- a/doc/coreutils.texi
+++ b/doc/coreutils.texi
@@ -95,7 +95,7 @@
* readlink: (coreutils)readlink invocation. Print referent of a symlink.
* rm: (coreutils)rm invocation. Remove files.
* rmdir: (coreutils)rmdir invocation. Remove empty directories.
-* runcon: (coreutils)runcon invocation. Run file in specif. SELinux
CTX.
+* runcon: (coreutils)runcon invocation. Run in specified SELinux CTX.
* seq: (coreutils)seq invocation. Print numeric sequences
* sha1sum: (coreutils)sha1sum invocation. Print or check SHA-1 digests.
* sha2: (coreutils)sha2 utilities. Print or check SHA-2 digests.
@@ -425,7 +425,7 @@ Top
SELinux context
* chcon invocation:: Change SELinux context of file
-* runcon invocation:: Run file in specified SELinux context
+* runcon invocation:: Run a command in specified SELinux context
Modified command invocation
@@ -12900,7 +12900,7 @@ SELinux context
@menu
* chcon invocation:: Change SELinux context of file
-* runcon invocation:: Run file in specified SELinux context
+* runcon invocation:: Run a command in specified SELinux context
@end menu
@node chcon invocation
@@ -12910,18 +12910,18 @@ chcon invocation
@cindex changing security context
@cindex change SELinux context
-
[EMAIL PROTECTED] changes SELinux security context of the file.
[EMAIL PROTECTED] changes the SELinux security context of the selected files.
Synopses:
@smallexample
-chcon [EMAIL PROTECTED]@dots{} CONTEXT @[EMAIL PROTECTED]
-chcon [EMAIL PROTECTED]@dots{} [-u USER] [-r ROLE] [-l RANGE] [-t TYPE]
@[EMAIL PROTECTED]
-chcon [EMAIL PROTECTED]@dots{} --reference=RFILE @[EMAIL PROTECTED]
+chcon [EMAIL PROTECTED]@dots{} @var{context} @[EMAIL PROTECTED]
+chcon [EMAIL PROTECTED]@dots{} [-u @var{user}] [-r @var{role}] [-l
@var{range}] [-t @var{type}] @[EMAIL PROTECTED]
+chcon [EMAIL PROTECTED]@dots{} [EMAIL PROTECTED] @[EMAIL PROTECTED]
@end smallexample
-Change the SELinux security context of each FILE to CONTEXT. With
---reference, change the security context of each FILE to that of RFILE.
+Change the SELinux security context of each @var{file} to @var{context}.
+With @option{--reference}, change the security context of each @var{file}
+to that of @var{rfile}.
The program accepts the following options. Also see @ref{Common options}.
@@ -12932,13 +12932,12 @@ chcon invocation
@opindex -h
@opindex --no-dereference
@cindex no dereference
-Affect symbolic links instead of any referenced file
+Affect symbolic links instead of any referenced file.
[EMAIL PROTECTED] --reference=RFILE
[EMAIL PROTECTED] [EMAIL PROTECTED]
@opindex --reference
@cindex reference file
-Use RFILE’s security context rather than specifying a CONTEXT
-value
+Use @var{rfile}'s security context rather than specifying a @var{context}
value.
@item -R
@itemx --recursive
@@ -12946,56 +12945,52 @@ chcon invocation
@opindex --recursive
Operate on files and directories recursively.
-Following options to modify how a hierarchy is traversed could also
-be specified. If more than one is specified, only the final one takes
-effect.
[EMAIL PROTECTED] @samp
[EMAIL PROTECTED] -H
-if a command line argument is a symbolic link to a directory,
-traverse it
[EMAIL PROTECTED] -L
-traverse every symbolic link to a directory encountered
[EMAIL PROTECTED] -P
-do not traverse any symbolic links (default)
[EMAIL PROTECTED] table
[EMAIL PROTECTED]
[EMAIL PROTECTED] symlinks}.
+
[EMAIL PROTECTED]
[EMAIL PROTECTED] symlinks}.
+
[EMAIL PROTECTED]
[EMAIL PROTECTED] symlinks}.
@item -v
@itemx --verbose
@opindex -v
@opindex --verbose
@cindex diagnostic
-Output a diagnostic for every file processed
+Output a diagnostic for every file processed.
[EMAIL PROTECTED] -u USER
[EMAIL PROTECTED] --user=USER
[EMAIL PROTECTED] -u @var{user}
[EMAIL PROTECTED] [EMAIL PROTECTED]
@opindex -u
@opindex --user
-Set user USER in the target security context
+Set user @var{user} in the target security context.
[EMAIL PROTECTED] -r ROLE
[EMAIL PROTECTED] --role=ROLE
[EMAIL PROTECTED] -r @var{role}
[EMAIL PROTECTED] [EMAIL PROTECTED]
@opindex -r
@opindex --role
-Set role ROLE in the target security context
+Set role @var{role} in the target security context.
[EMAIL PROTECTED] -t TYPE
[EMAIL PROTECTED] --type=type
[EMAIL PROTECTED] -t @var{type}
[EMAIL PROTECTED] [EMAIL PROTECTED]
@opindex -t
@opindex --type
-Set type TYPE in the target security context
+Set type @var{type} in the target security context.
[EMAIL PROTECTED] -l RANGE
[EMAIL PROTECTED] --range=RANGE
[EMAIL PROTECTED] -l @var{range}
[EMAIL PROTECTED] [EMAIL PROTECTED]
@opindex -l
@opindex --range
-Set range RANGE in the target security context
+Set range @var{range} in the target security context.
@end table
@exitstatus
@node runcon invocation
[EMAIL PROTECTED] @command{runcon}: Run file in specified SELinux context
[EMAIL PROTECTED] @command{runcon}: Run a command in specified SELinux context
@pindex runcon
@cindex run with security context
@@ -13013,11 +13008,11 @@ runcon invocation
current or transitioned security context modified by one or more of LEVEL,
ROLE, TYPE and USER.
-If none of -c, -t, -u, -r, or -l, is specified, the first argument is
-used as the complete context. Any additional arguments after COMMAND
+If none of -c, -t, -u, -r, or -l, is specified, the first argument is
+used as the complete context. Any additional arguments after COMMAND
are interpreted as arguments to the command.
-With neither CONTEXT nor COMMAND, print the current security context.
+With neither CONTEXT nor COMMAND, print the current security context.
The program accepts the following options. Also see @ref{Common options}.
--
1.6.0.2.307.gc427
_______________________________________________
Bug-coreutils mailing list
[email protected]
http://lists.gnu.org/mailman/listinfo/bug-coreutils
