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