xref: /freebsd/crypto/heimdal/appl/push/push.8 (revision d5566384042fa631ffe7916fd89bcb4669ad12a7)
1.\" $Id: push.8,v 1.13 2002/08/20 17:07:07 joda Exp $
2.\"
3.Dd May 31, 1998
4.Dt PUSH 8
5.Os HEIMDAL
6.Sh NAME
7.Nm push
8.Nd fetch mail via POP
9.Sh SYNOPSIS
10.Nm
11.Op Fl 4 | Fl -krb4
12.Op Fl 5 | Fl -krb5
13.Op Fl v | Fl -verbose
14.Op Fl f | Fl -fork
15.Op Fl l | -leave
16.Op Fl -from
17.Op Fl c | -count
18.Op Fl -headers Ns = Ns Ar headers
19.Oo Fl p Ar port-spec  \*(Ba Xo
20.Fl -port Ns = Ns Ar port-spec
21.Xc
22.Oc
23.Ar po-box
24.Pa filename
25.Sh DESCRIPTION
26.Nm
27retrieves mail from the post office box
28.Ar po-box ,
29and stores the mail in mbox format in
30.Pa filename .
31The
32.Ar po-box
33can have any of the following formats:
34.Bl -hang -compact -offset indent
35.It Ql hostname:username
36.It Ql po:hostname:username
37.It Ql username@hostname
38.It Ql po:username@hostname
39.It Ql hostname
40.It Ql po:username
41.El
42.Pp
43If no username is specified,
44.Nm
45assumes that it's the same as on the local machine;
46.Ar hostname
47defaults to the value of the
48.Ev MAILHOST
49environment variable.
50.Pp
51Supported options:
52.Bl -tag -width Ds
53.It Xo
54.Fl 4 ,
55.Fl -krb4
56.Xc
57use Kerberos 4 (if compiled with support for Kerberos 4)
58.It Xo
59.Fl 5 ,
60.Fl -krb5
61.Xc
62use Kerberos 5 (if compiled with support for Kerberos 5)
63.It Xo
64.Fl f ,
65.Fl -fork
66.Xc
67fork before starting to delete messages
68.It Xo
69.Fl l ,
70.Fl -leave
71.Xc
72don't delete fetched mail
73.It Xo
74.Fl -from
75.Xc
76behave like from.
77.It Xo
78.Fl c ,
79.Fl -count
80.Xc
81first print how many messages and bytes there are.
82.It Xo
83.Fl -headers Ns = Ns Ar headers
84.Xc
85a list of comma-separated headers that should get printed.
86.It Xo
87.Fl p Ar port-spec ,
88.Fl -port Ns = Ns Ar port-spec
89.Xc
90use this port instead of the default
91.Ql kpop
92or
93.Ql 1109 .
94.El
95.Pp
96The default is to first try Kerberos 5 authentication and then, if
97that fails, Kerberos 4.
98.Sh ENVIRONMENT
99.Bl -tag -width Ds
100.It Ev MAILHOST
101points to the post office, if no other hostname is specified.
102.El
103.\".Sh FILES
104.Sh EXAMPLES
105.Bd -literal -offset indent
106$ push cornfield:roosta ~/.emacs-mail-crash-box
107.Ed
108.Pp
109tries to fetch mail for the user
110.Ar roosta
111from the post office at
112.Dq cornfield ,
113and stores the mail in
114.Pa ~/.emacs-mail-crash-box
115(you are using Gnus, aren't you?)
116.Bd -literal -offset indent
117$ push --from -5 havregryn
118.Ed
119.Pp
120tries to fetch
121.Sy From:
122lines for current user at post office
123.Dq havregryn
124using Kerberos 5.
125.\".Sh DIAGNOSTICS
126.Sh SEE ALSO
127.Xr from 1 ,
128.Xr pfrom 1 ,
129.Xr movemail 8 ,
130.Xr popper 8
131.\".Sh STANDARDS
132.Sh HISTORY
133.Nm
134was written while waiting for
135.Nm movemail
136to finish getting the mail.
137.\".Sh AUTHORS
138.\".Sh BUGS
139