diff options
author | Miles Bader <miles@gnu.org> | 1996-08-27 18:27:31 +0000 |
---|---|---|
committer | Miles Bader <miles@gnu.org> | 1996-08-27 18:27:31 +0000 |
commit | 2e6c5408302b36b67b2e094d471145b44530d0ca (patch) | |
tree | 15098deed6476050a570efe54e7668d6680b88db /utils | |
parent | a3752e4edf20e4ea119de4389465e02f307fc3f6 (diff) |
(doc): Add program description.
Diffstat (limited to 'utils')
-rw-r--r-- | utils/devprobe.c | 3 | ||||
-rw-r--r-- | utils/fsysopts.c | 3 | ||||
-rw-r--r-- | utils/hurdids.c | 2 | ||||
-rw-r--r-- | utils/login.c | 1 | ||||
-rw-r--r-- | utils/portinfo.c | 3 | ||||
-rw-r--r-- | utils/ps.c | 8 | ||||
-rw-r--r-- | utils/settrans.c | 3 | ||||
-rw-r--r-- | utils/showtrans.c | 6 | ||||
-rw-r--r-- | utils/storeinfo.c | 3 | ||||
-rw-r--r-- | utils/vmstat.c | 3 | ||||
-rw-r--r-- | utils/w.c | 2 | ||||
-rw-r--r-- | utils/x.c | 4 |
12 files changed, 24 insertions, 17 deletions
diff --git a/utils/devprobe.c b/utils/devprobe.c index e29e1e32..a0f61733 100644 --- a/utils/devprobe.c +++ b/utils/devprobe.c @@ -33,7 +33,8 @@ static const struct argp_option options[] = { {0} }; static const char *args_doc = "DEVNAME..."; -static const char *doc = "The exit status is 0 if any devices were found."; +static const char *doc = "Test for the existance of mach device DEVNAME..." + "\vThe exit status is 0 if any devices were found."; int main (int argc, char **argv) diff --git a/utils/fsysopts.c b/utils/fsysopts.c index 076e2a87..a4cab6b7 100644 --- a/utils/fsysopts.c +++ b/utils/fsysopts.c @@ -40,7 +40,8 @@ static struct argp_option options[] = {0, 0, 0, 0} }; static char *args_doc = "FILESYS [FS_OPTION...]"; -static char *doc = "The legal values for FS_OPTION depends on FILESYS, but\ +static char *doc = "Get or set command line options for running translator FILESYS." +"\vThe legal values for FS_OPTION depends on FILESYS, but\ some common ones are: --readonly, --writable, --remount, --sync[=INTERVAL],\ and --nosync.\n\nIf no options are supplied, FILESYS's existing options\ are printed"; diff --git a/utils/hurdids.c b/utils/hurdids.c index 18eb3c41..26c2d14a 100644 --- a/utils/hurdids.c +++ b/utils/hurdids.c @@ -43,7 +43,7 @@ static struct argp_option options[] = {0} }; static char *args_doc = 0; -static char *doc = 0; +static char *doc = "Show hurd uids/gids."; /* ---------------------------------------------------------------- */ diff --git a/utils/login.c b/utils/login.c index 46f9629b..4e0c7d12 100644 --- a/utils/login.c +++ b/utils/login.c @@ -108,6 +108,7 @@ static struct argp_option options[] = }; static char *args_doc = "[USER [ARG...]]"; static char *doc = +"Exec a program with uids and/or the environment changed appropriately.\v" "To give args to the shell without specifying a user, use - for USER.\n" "Current login parameters include HOME, SHELL, USER, NAME, and ROOT."; diff --git a/utils/portinfo.c b/utils/portinfo.c index 10f5fe8f..fc0ce214 100644 --- a/utils/portinfo.c +++ b/utils/portinfo.c @@ -72,7 +72,8 @@ static const struct argp_option options[] = { }; static const char *args_doc = "PID [NAME...]"; static const char *doc = -"If no port NAMEs are given, all ports in process PID are reported (if" +"Show information about mach ports NAME... (default all ports) in process PID." +"\vIf no port NAMEs are given, all ports in process PID are reported (if" " translation is used, then only those common to both processes). NAMEs" " may be specified in hexadecimal or octal by using a 0x or 0 prefix."; @@ -90,10 +90,10 @@ static const struct argp_option options[] = }; char *args_doc = "[PID...]"; - -char *doc = "The USER, LID, PID, PGRP, and SID arguments may also be comma \ -separated lists. The System V options -u and -g may be accessed with -O and \ ---pgrp."; +char *doc = +"Show information about processes PID... (default all `interesting' processes)" +"\vThe USER, LID, PID, PGRP, and SID arguments may also be comma separated" +" lists. The System V options -u and -g may be accessed with -O and -G."; int parse_enum(char *arg, char **choices, char *kind, int allow_mismatches) diff --git a/utils/settrans.c b/utils/settrans.c index ff264a5b..93dbdefa 100644 --- a/utils/settrans.c +++ b/utils/settrans.c @@ -61,7 +61,8 @@ static struct argp_option options[] = {0, 0} }; static char *args_doc = "NODE [TRANSLATOR ARG...]"; -static char *doc = "By default the passive translator is set."; +static char *doc = "Set the passive/active translator on NODE." +"\vBy default the passive translator is set."; /* ---------------------------------------------------------------- */ diff --git a/utils/showtrans.c b/utils/showtrans.c index d6acfd9d..32aaaa74 100644 --- a/utils/showtrans.c +++ b/utils/showtrans.c @@ -42,9 +42,9 @@ static struct argp_option options[] = }; static char *args_doc = "FILE..."; - -static char *doc = "A FILE argument of `-' prints the translator on the node \ -attached to standard input."; +static char *doc = "Show the passive translator of FILE..." +"\vA FILE argument of `-' prints the translator on the node" +" attached to standard input."; /* ---------------------------------------------------------------- */ diff --git a/utils/storeinfo.c b/utils/storeinfo.c index ba6d0654..86e827be 100644 --- a/utils/storeinfo.c +++ b/utils/storeinfo.c @@ -48,7 +48,8 @@ static struct argp_option options[] = {0, 0} }; static char *args_doc = "FILE..."; -static char *doc = "With no FILE arguments, the file attached to standard \ +static char *doc = "Show information about storage used by FILE..." +"\vWith no FILE arguments, the file attached to standard \ input is used. The fields to be printed are separated by colons, in this \ order: PREFIX: KIND: NAME: BLOCK-SIZE: BLOCKS: SIZE: RUNS. If the store is a \ composite one and --children is specified, children are printed on lines \ diff --git a/utils/vmstat.c b/utils/vmstat.c index c7f7a7af..eb0595f7 100644 --- a/utils/vmstat.c +++ b/utils/vmstat.c @@ -48,7 +48,8 @@ static const struct argp_option options[] = { {0} }; static const char *args_doc = "[PERIOD [COUNT [HEADER_INTERVAL]]]"; -static const char *doc = "If PERIOD is supplied, then terse mode is" +static const char *doc = "Show system virtual memory statistics" +"\vIf PERIOD is supplied, then terse mode is" " selected, and the output repeated every PERIOD seconds, with cumulative" " fields given the difference from the last output. If COUNT is given" " and non-zero, only that many lines are output. HEADER_INTERVAL" @@ -71,7 +71,7 @@ static struct argp_option options[] = {0, 0} }; static char *args_doc = "[USER...]"; -static char *doc = 0; +static char *doc = "Show logged in users and what they are doing"; /* The current time of day. */ static struct timeval now; @@ -55,8 +55,8 @@ static struct argp_option options[] = {0, 0} }; static char *args_doc = "[USER...]"; -static char *doc = - "A USER specified as an argument adds (or removes) that user's groups as" +static char *doc = "Modify authentication of existing processes" + "\vA USER specified as an argument adds (or removes) that user's groups as" " well. When removing groups implied by such an argument, the groups to" " which uids remaining in the process after any we remove are ignored." "\nUids and groups specified with options are used as-is."; |