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

FreeBSD Manual Pages


home | help
UI(1)			  BSD General Commands Manual			 UI(1)

     ui	-- show	information about local	users

     ui	[-hvVL]	[-F separator] [-m separator] [-t format] [-d]
	[[-xXO] [options] [-- [-xXO] [options] [...]]]
	[-c filename] [user] | [-f filename] [...]

     ui	uses loadable modules to display various information about a local
     user.  Multiple usernames or filenames (see -f) may be specified. If no
     arguments are given or a username or filename is `-', then	arguments are
     read via standard input.

       Load the	default	modules	(, and This	can be
       used anywhere in	the module list.

     -t	format
       Specify an alternate time format	for modules which have time values.
       See the strftime(3) manual page for format syntax.

     -c	filename
       Load a configuration file. May be used more than	once. See below	for

     -O	filename
       Load a module. The remaining switches are to be options for this	mod-
       ule. End	options	for this module	by specifying --.  This	option may by
       used more than once. Due	to the way module chaining is implemented, the
       same module may be loaded more than once.

     -x	filename
       Like -O but chain output to input.	This will only
       work if the module is chainable.	You can	specify	this option more than
       once for	unlimited chaining.

     -X	filename
       The same	as -x but don't	output info,	only pass the strings
       to for processing.

     -F	separator
       Alternate character used	to separate fields. Standard escape sequences
       are supported.

     -m	separator
       Alternate character used	to separate multi string values. Standard es-
       cape sequences are supported.

       Get information for the owners of the specified files.

       If the -f option	is specified and the file is a symbolic	link, get
       owner information for the file the link points to and not the link it-

       Be verbose when possible. Some modules may limit	their display. This
       should show everything available. This is reset for each	loaded module
       unless specified	twice.

       Display help text. A module must	be specified either with the -O	com-
       mand line option	or loaded via configuration file -c for	a modules help
       text to be displayed.

       Version information.

     Returns 1 on failure and 0	on success. Note that a	modules	return value
     affects this exit status.

     PREFIX/lib/userinfo Default location of loadable modules.

     The following will	load two modules, specify module options and load a
     configuration file. Module	options	end when -- is reached.

     ui	-O -switches -- -O	-- -c filename `users`

     strftime(3), passwd(5), aliases(5), forward(5), utmp(5), lastlog(5), dlopen(3)

     There is no default configuration file that will be loaded	so you'll have
     to	create one and load it with the	-c command-line	option.	Empty lines
     and everything to the right of a '#' are ignored. If you need a '#' in
     your options, escape it with a '\'. This file should contain any modules
     you want loaded and their options separated by one	or more	whitespace
     characters	on one line per	module.

     Each module should	have a .so filename extension. If a module filename
     begins with a ~, it will be expanded to your home directory. Some module
     options may require quoting.  Single and double quotes are	supported and
     may also be escaped with a	backslash character. Multiple configuration
     files may be specified and	may also be used with the -O command-line op-
     tion. The order of	module loading and output is dependent on the order of
     the module	stack and any module options.

     If	you want module	chaining, put a	'>' or '-' at the beginning of the
     module name before	any '~'. This is the same as specifying	-x or -X on
     the command line, respectively. The following module, which may also be
     chained, will be chained to this module.

     Ben Kibbey	<>

BSD			       December	05, 2004			   BSD


Want to link to this manual page? Use this URL:

home | help