add irc channel to README
[mmh] / man / ali.man1
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH ALI %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
5 .SH NAME
6 ali \- list mail aliases
7 .SH SYNOPSIS
8 .HP 5
9 .na
10 .B ali
11 .RB [ \-file
12 .IR aliasfile ]...
13 .RB [ \-list " | " \-nolist ]
14 .RB [ \-normalize " | " \-nonormalize ]
15 .RB [ \-user " | " \-nouser ]
16 .RB [ \-Version ]
17 .RB [ \-help ]
18 .RI [ aliases " ...]"
19 .ad
20 .SH DESCRIPTION
21 .B Ali
22 searches the named mail alias files for each of the given
23 .IR aliases .
24 It creates a list of addresses for those
25 .IR aliases ,
26 and writes that list on standard output.  If no arguments are given,
27 .B ali
28 outputs all alias entries.
29 This can be used to check the format of the alias file for validity.
30 .PP
31 By default, when an alias expands to multiple addresses, the addresses
32 are separated by commas and printed on as few lines as possible.  If the
33 .B \-list
34 switch is specified, and an address expands to multiple
35 addresses, each address will appear on a separate line.
36 .PP
37 The
38 .B \-user
39 switch directs
40 .B ali
41 to perform its processing in
42 an inverted fashion: instead of listing the addresses that each given
43 alias expands to,
44 .B ali
45 will list the aliases that expand to each
46 given address.  If the
47 .B \-normalize
48 switch is given,
49 .B ali
50 will
51 try to track down the official hostname of the address.
52 .PP
53 If no
54 .B \-file
55 .I aliasfile
56 is given, then the default alias files, as specified by the profile entry
57 .RI ` Aliasfile ',
58 will be read.
59 If any alias files are given by
60 .B \-file
61 .I aliasfile
62 switches, these will be read instead of the default alias files.
63 Either the default alias files are read or the ones given at the
64 command line, never both.
65 .PP
66 Each
67 .I alias
68 is processed as described in
69 .BR mh\-alias (5).
70 .SH FILES
71 .fc ^ ~
72 .nf
73 .ta \w'%etcdir%/ExtraBigFileName  'u
74 ^$HOME/.mmh/profile~^The user profile
75 ^/etc/passwd~^List of users
76 ^/etc/group~^List of groups
77 .fi
78 .SH "PROFILE COMPONENTS"
79 .fc ^ ~
80 .nf
81 .ta 2.4i
82 .ta \w'ExtraBigProfileName  'u
83 ^Path:~^To determine the user's mail storage
84 ^Aliasfile:~^For default alias files
85 .fi
86 .SH "SEE ALSO"
87 mh\-alias(5)
88 .SH DEFAULTS
89 .nf
90 .RB ` \-nolist '
91 .RB ` \-nonormalize '
92 .RB ` \-nouser '
93 .fi
94 .SH CONTEXT
95 None
96 .SH BUGS
97 The
98 .B \-user
99 option with
100 .B \-nonormalize
101 is not entirely accurate, as it
102 does not replace local nicknames for hosts with their official site names.