1 .\" Copyright (C) 2001-2006 Ben Kibbey <bjk@luxsci.net>
3 .\" This program is free software; you can redistribute it and/or modify
4 .\" it under the terms of the GNU General Public License as published by
5 .\" the Free Software Foundation; either version 2 of the License, or
6 .\" (at your option) any later version.
8 .\" This program is distributed in the hope that it will be useful,
9 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
10 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 .\" GNU General Public License for more details.
13 .\" You should have received a copy of the GNU General Public License
14 .\" along with this program; if not, write to the Free Software
15 .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 .Nd show information about local users
34 .Op Oo Fl xXO Oc Ar module1.so Oo options Oc Oo Fl - Op Fl xXO Oc Ar module2.so Oo options Oc Op ...
44 uses loadable modules to display various information about a local user.
45 Multiple usernames or filenames (see
47 may be specified. If no arguments are given or a username or filename is
49 then arguments are read via standard input.
53 Load the default modules (passwd.so, mail.so and login.so). This can be used
54 anywhere in the module list.
56 Specify an alternate time format for modules which have time values. See the
62 Load a configuration file. May be used more than once. See below for details.
64 Load a module. The remaining switches are to be options for this
65 module. End options for this module by specifying
67 This option may by used more than once. Due to the way module chaining is
68 implemented, the same module may be loaded more than once.
76 input. This will only work if the module is chainable. You can specify this
77 option more than once for unlimited chaining.
83 info, only pass the strings to
87 Alternate character used to separate fields. Standard escape sequences
90 Alternate character used to separate multi string values. Standard escape
91 sequences are supported.
93 Get information for the owners of the specified files.
97 option is specified and the file is a symbolic link, get owner
98 information for the file the link points to and not the link itself.
100 Be verbose when possible. Some modules may limit their display. This should
101 show everything available. This is reset for each loaded module unless
104 Display help text. A module must be specified either with the
106 command line option or loaded via configuration file
108 for a modules help text to be displayed.
115 Returns 1 on failure and 0 on success. Note that a modules return value
116 affects this exit status.
120 .Pa PREFIX/lib/userinfo
121 Default location of loadable modules.
124 The following will load two modules, specify module options and load a
125 configuration file. Module options end when
152 .Sh CONFIGURATION FILE SYNTAX
154 There is no default configuration file that will be loaded so you'll have to
155 create one and load it with the
157 command-line option. Empty lines and everything to the right of a '#' are
158 ignored. If you need a '#' in your options, escape it with a '\\'. This file
159 should contain any modules you want loaded and their options separated by one
160 or more whitespace characters on one line per module.
163 have a .so filename extension. If a module filename begins with a ~, it will
164 be expanded to your home directory. Some module options may require quoting.
165 Single and double quotes are supported and may also be escaped with a
166 backslash character. Multiple configuration files may be specified and may
167 also be used with the
169 command-line option. The order of module loading and output is dependent on
170 the order of the module stack and any module options.
172 If you want module chaining, put a '>' or '-' at the beginning of the module
173 name before any '~'. This is the same as specifying
177 on the command line, respectively. The following module, which may also be
178 chained, will be chained to this module.
182 .An "Ben Kibbey" Aq bjk@luxsci.net