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