Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
RUSHWHO(1)		      Rush User	Reference		    RUSHWHO(1)

NAME
       rushwho - show who is logged on by rush(1)

SYNOPSIS
       rushwho	[-Hh]  [-F  STRING]  [-f  DIR]	[--file=DIR] [--format=STRING]
       [--help]	[--no-header] [--usage]	[--version]

NOTE
       This manpage is a short description of rushwho.	For a detailed discus-
       sion, including examples	and usage recommendations, refer to the	manual
       GNU Rush	-- a restricted	user shell, available in texinfo  format.   If
       the  info  reader  and the rush documentation are properly installed on
       your system, the	command

	   info	rushwho

       should give you access to the complete manual.

       You can also view the manual using the info mode	in emacs(1),  or  find
       it in various formats online at

	   http://www.gnu.org.ua/software/rush/manual

       If  any	discrepancies  occur  between this manpage and the Manual, the
       later shall be considered the authoritative source.

DESCRIPTION
       Displays	a list of users	who are	currently logged in by	rush(1).   The
       utility	operates  on  the  default accounting database,	which is main-
       tained if rush(1) runs in accounting mode.

OPTIONS
       -F, --format=STRING
	      Use STRING instead of the	default	format.	 See the section  FOR-
	      MAT,  for	 a  detailed  discussion of the	format syntax.	If the
	      STRING begins with a @, then this	character is removed from  it,
	      and  the	resulting  string is regarded as a name	of the file to
	      read.  The file is read literally, except	that  lines  beginning
	      with a semicolon are ignored.

       -f, --file=DIR
	      Look for database	files in DIR.

       -n, --count=NUMBER
	      Show at most NUMBER records.

       Other options

       -h, --help
	      Give this	help list.

       --usage
	      Give a short usage message.

       --version
	      Print program version.

ENVIRONMENT
       RUSHWHO_FORMAT
	      When  set, supplies a format string to use instead of the	built-
	      in format.  If the value begins with a @ sign, rest  of  charac-
	      ters  is	treated	 as  the name of file to read the format from,
	      similarly	to the --format	option,	which see.

	      The precedence rule for format selection is:

	      1.     The --format option.

	      2.     The RUSHWHO_FORMAT	environment variable.

	      3.     Built-in format.

FORMAT
       The format string supplied with the -F (--format) option	 controls  the
       output  of every	record from the	GNU Rush accounting database.  It con-
       sists of	the following classes of objects:

       Ordinary	characters
	      These are	copied to the output verbatim.

       Escapes
	      An escape	is a backslash,	followed by a single character.	 It is
	      interpreted according to the following table:

		      Sequence	  Replaced with
		      \a	  Audible bell character (ASCII	7)
		      \b	  Backspace character (ASCII 8)
		      \e	  Escape character (ASCII 27)
		      \f	  Form-feed character (ASCII 12)
		      \n	  Newline character (ASCII 10)
		      \r	  Carriage return character (ASCII 13)
		      \t	  Horizontal tabulation	character (ASCII 9)
		      \v	  Vertical tabulation character	(ASCII 11)
		      \\	  A single backslash
		      \"	  A double-quote.

	      Any escape not listed in the table above results in  its	second
	      character	being output.

       Quoted strings
	      Strings  are  delimited  by  single  or double quotes.  Within a
	      string escape sequences are interpreted as described above.

       Format specifications
	      Format specification can be regarded  as	a  kind	 of  function,
	      which  outputs  a	particular piece of information	from the data-
	      base record.  Syntactically, format specification	starts with an
	      opening brace and	ends with a closing brace.  The	first word af-
	      ter the brace is the name	of the	specification.	 The  rest  of
	      words  are  positional  arguments	followed by keyword arguments.
	      Both are optional.  A keyword argument begins with a colon.

       The available format specifications are:

       (newline	[COUNT])
	      Causes the newline character to  be  output.   If	 the  optional
	      count is supplied, that many newlines will be printed

       (tab [COUNT])
	      Advance  to the next tab stop in the output stream.  If optional
	      COUNT is present,	then skip that many tab	stops.	Each tab  stop
	      is eight characters long.

       The  following  specifications  output  particular fields of a database
       record.	They all take two positional arguments:	WIDTH and TITLE.

       The first argument, WIDTH sets the maximum output length	for this spec-
       ification.  If the number of characters actually	output	is  less  than
       the width, they will be padded with whitespace either to	the left or to
       the  right,  depending  on the presence of the :right keyword argument.
       If the number of	characters is greater than WIDTH, they will  be	 trun-
       cated to	fit.  If WIDTH is not given, the exact data are	output as is.

       The  second  argument,  TITLE,  gives  the title	of this	column for the
       heading line.  By default no title is output.

       Every field specification accepts at least two keyword arguments.   The
       keyword	:right	may  be	used to	request	alignment to the right for the
       data.  This keyword is ignored if WIDTH is not given.

       The keyword :empty followed by a	string causes the  program  to	output
       that  string if the resulting value for this specification would	other-
       wise be empty.

       (user WIDTH TITLE [:empty REPL][:right])
	      Print the	user login name.

       (time WIDTH TITLE [:empty REPL][:right][:format DATE-FORMAT])
	      Date and time when the session started.  The word	start-time can
	      be used instead of time.

	      The :format keyword introduces the strftime(3) format string  to
	      be  used	when  converting  the  date for	printing.  The default
	      value is "%a %H:%M".

       (duration WIDTH TITLE [:empty REPL][:right])
	      Total time of the	session	duration.

       (rule WIDTH TITLE [:right])
	      The tag of the rule that was used	to serve the user.

       (command	WIDTH TITLE [:empty REPL][:right])
	      Command line being executed.

       (pid WIDTH TITLE	[:right])
	      PID of the process.

       For example, the	following is the default format	for  rushwho.	It  is
       written	in a form, suitable for	use in a file supplied with the	--for-
       mat=@FILE option:

       (user 10	Login)"	"
       (rule 8 Rule)" "
       (start-time 0 Start)" "
       (duration 9 Time)" "
       (pid 10 PID)" "
       (command	28 Command)

SEE ALSO
       rush(1),	rushwho(1).

AUTHORS
       Sergey Poznyakoff

BUG REPORTS
       Report bugs to <bug-rush@gnu.org.ua>.

COPYRIGHT
       Copyright (C) 2016 Sergey Poznyakoff
       License GPLv3+: GNU GPL version 3 or later <http://gnu.org/li-
       censes/gpl.html>
       This is free software: you are free  to	change	and  redistribute  it.
       There is	NO WARRANTY, to	the extent permitted by	law.

RUSHWHO				August 17, 2016			    RUSHWHO(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=rushwho&sektion=1&manpath=FreeBSD+Ports+15.0>

home | help