svn commit: r225927 - head/bin/ps

[Alexander Best]

On Mon Oct  3 11, Alexander Best wrote:
> On Sun Oct  2 11, Glen Barber wrote:
> > Author: gjb (doc committer)
> > Date: Sun Oct  2 16:05:19 2011
> > New Revision: 225927
> > URL: http://svn.freebsd.org/changeset/base/225927
> > 
> > Log:
> >   Correct a typo that was introduced in 225912
> >   
> >   Submitted by:		Valentin Nechayev (netch % netch!kiev!ua), arundel
> >   MFC after:		1 week
> >   With-MFC:		225908
> > 
> > Modified:
> >   head/bin/ps/ps.1
> 
> i've been reviewing the ps(1) man page some more and found several other
> issues. in addition to those, i think some of the recent changes could be
> improved, too.
> 
> it would be nice to hear what people think regarding these changes.

i'll try tidying up the man page a bit more and will then submit a PR. the
patch is quite extensive, so i guess filing this as PR is a better idea.

cheers.
alex

> 
> cheers.
> alex
> 
> > 
> > Modified: head/bin/ps/ps.1
> > ==============================================================================
> > --- head/bin/ps/ps.1	Sun Oct  2 14:10:25 2011	(r225926)
> > +++ head/bin/ps/ps.1	Sun Oct  2 16:05:19 2011	(r225927)
> > @@ -431,7 +431,7 @@ The process is being traced or debugged.
> >  An abbreviation for the pathname of the controlling terminal, if any.
> >  The abbreviation consists of the three letters following
> >  .Pa /dev/tty ,
> > -or, for psuedo-terminals, the corresponding entry in
> > +or, for pseudo-terminals, the corresponding entry in
> >  .Pa /dev/pts .
> >  This is followed by a
> >  .Ql -

> diff --git a/bin/ps/ps.1 b/bin/ps/ps.1
> index 2c04c21..965abcb 100644
> --- a/bin/ps/ps.1
> +++ b/bin/ps/ps.1
> @@ -29,7 +29,7 @@
>  .\"     @(#)ps.1	8.3 (Berkeley) 4/18/94
>  .\" $FreeBSD$
>  .\"
> -.Dd October 1, 2011
> +.Dd October 3, 2011
>  .Dt PS 1
>  .Os
>  .Sh NAME
> @@ -98,6 +98,16 @@ The default output format includes, for each process, the process' ID,
>  controlling terminal, state, CPU time (including both user and system time)
>  and associated command.
>  .Pp
> +The
> +.Fl G , O , o , p , t
> +and
> +.Fl U
> +options accept, in addition to a single argument, a list of arguments
> +which must be space or comma seperated.
> +Also these options can be used more than once in a single
> +.Nm
> +command.
> +.Pp
>  The process file system (see
>  .Xr procfs 5 )
>  should be mounted when
> @@ -184,11 +194,15 @@ Add the information associated with the space or comma separated list
>  of keywords specified, after the process ID,
>  in the default information
>  display.
> -Keywords may be appended with an equals
> +The last keyword in the list may be appended with an equals
>  .Pq Ql =
> -sign and a string.
> +sign and a string that spans the rest of the argument, and can contain
> +space and comma characters.
>  This causes the printed header to use the specified string instead of
>  the standard header.
> +To specify header texts for multiple keywords, more than one
> +.Fl O
> +option must be used.
>  .It Fl o
>  Display information associated with the space or comma separated
>  list of keywords specified.
> @@ -198,10 +212,9 @@ sign and a string that spans the rest of the argument, and can contain
>  space and comma characters.
>  This causes the printed header to use the specified string instead of
>  the standard header.
> -Multiple keywords may also be given in the form of more than one
> +To specify header texts for multiple keywords, more than one
>  .Fl o
> -option.
> -So the header texts for multiple keywords can be changed.
> +option must be used.
>  If all keywords have empty header texts, no header line is written.
>  .It Fl p
>  Display information about processes which match the specified process IDs.
> @@ -217,7 +230,9 @@ with the standard input.
>  .It Fl t
>  Display information about processes attached to the specified terminal
>  devices.
> -Full pathnames, as well as abbreviations (see explanation of the
> +Full pathnames, relative pathnames to
> +.Pa /dev ,
> +as well as abbreviations (see explanation of the
>  .Cm tt
>  keyword) can be specified.
>  .It Fl U
> @@ -428,16 +443,16 @@ The process is swapped out.
>  The process is being traced or debugged.
>  .El
>  .It Cm tt
> -An abbreviation for the pathname of the controlling terminal, if any.
> -The abbreviation consists of the three letters following
> +An abbreviation for the device name of the controlling terminal, if any.
> +The abbreviation consists of the two letters following
>  .Pa /dev/tty ,
> -or, for pseudo-terminals, the corresponding entry in
> +or, for pseudo-terminals, the corresponding device number in
>  .Pa /dev/pts .
>  This is followed by a
>  .Ql -
>  if the process can no longer reach that
>  controlling terminal (i.e., it has been revoked).
> -The full pathname of the controlling terminal is available via the
> +The full device name of the controlling terminal is available via the
>  .Cm tty
>  keyword.
>  .It Cm wchan
> @@ -636,9 +651,12 @@ control terminal session ID
>  .It Cm tsiz
>  text size (in Kbytes)
>  .It Cm tt
> -control terminal name (two letter abbreviation)
> +abbreviated two letter control terminal name or
> +device number for pseudo-terminals
>  .It Cm tty
> -full name of control terminal
> +full name of control terminal or
> +.Pa pts/ Ns Ao Ar tt Ac
> +for pseudo-terminals
>  .It Cm ucomm
>  name to be used for accounting
>  .It Cm uid