Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.bin / ncplogin / ncplogin.1
1 .\" $FreeBSD: src/usr.bin/ncplogin/ncplogin.1,v 1.4.2.8 2002/06/21 15:28:29 charnier Exp $
2 .Dd September 15, 1999
3 .Dt NCPLOGIN 1
4 .Os
5 .Sh NAME
6 .Nm ncplogin
7 .Nd create permanent connection to a NetWare server
8 .Sh SYNOPSIS
9 .Nm
10 .Op Fl BCDN
11 .Op Fl S Ar server
12 .Op Fl U Ar user
13 .Op Fl A Ar host
14 .Op Fl I Ar level
15 .Op Fl M Ar mode
16 .Oo
17 .Fl O Xo
18 .Op Ar owner Ns
19 .Op : Ns Ar group
20 .Xc
21 .Oc
22 .Op Fl R Ar retrycount
23 .Op Fl T Ar tree
24 .Op Fl W Ar timeout
25 .Nm
26 .Op Fl BCDN
27 .Op Fl A Ar host
28 .Op Fl I Ar level
29 .Op Fl M Ar mode
30 .Oo
31 .Fl O Xo
32 .Op Ar owner Ns
33 .Op : Ns Ar group
34 .Xc
35 .Oc
36 .Op Fl R Ar retrycount
37 .Op Fl T Ar tree
38 .Op Fl W Ar timeout
39 .No / Ns Ar server Ns : Ns Ar user
40 .Sh DESCRIPTION
41 Connections to a
42 .Tn NetWare
43 server can be created and used independently of the
44 .Xr mount_nwfs 8
45 command.
46 Connections can be created by any user.
47 Each user can have multiple
48 connections, but each NetWareServer:NetWareUser pair should be unique.
49 .Pp
50 The
51 .Nm
52 command is used to create a permanent connection to a
53 .Tn NetWare
54 server.
55 Permanent connections will stay connected even if no applications use them.
56 This allows users to run different ncp* programs
57 without specifying a file server and user to use.
58 Established connections can be destroyed with the
59 .Xr ncplogout 1
60 command.
61 .Pp
62 Upper case options described in this manual
63 are common for other ncp* programs and are referred to as
64 .Qq connection options .
65 Options
66 .Fl U
67 and
68 .Fl S
69 are mutually exclusive with the
70 .No / Ns Ar server Ns : Ns Ar user
71 syntax.
72 .Pp
73 The options are:
74 .Bl -tag -width indent
75 .It Fl S Ar server
76 Specify the name of the
77 .Tn NetWare
78 server to connect to.
79 This affect only
80 .Tn IPX
81 servers.
82 For native
83 .Tn IP
84 servers, see the
85 .Fl A
86 option.
87 .It Fl U Ar user
88 Specify the name of the user used in the login sequence.
89 .It Fl A Ar host
90 Use the
91 .Tn UDP
92 protocol to connect to a
93 .Tn NetWare
94 5.x server specified by the
95 .Ar host
96 argument.
97 .It Fl C
98 Do not convert the password to uppercase.
99 .It Fl D
100 Mark the connection as primary.
101 The option can be used to modify existing connections.
102 Only the
103 .Nm
104 program accepts this option.
105 .It Fl I Ar signature_level
106 Try to use
107 .Ar signature_level .
108 Available values are:
109 .Bd -literal -offset indent
110 Value   Meaning
111 0       disable signatures
112 1       enable (use if required by server)
113 2       request but do not require signing
114 3       require signatures
115 .Ed
116 .Pp
117 Note that only packet header signing is implemented.
118 .It Fl M Ar mode
119 Share this connection.
120 The bits in the
121 .Ar mode
122 argument are similar to standard file permissions:
123 .Bd -literal -offset indent
124 Mask    Meaning
125 4       READ    - connection will be visible.
126 2       WRITE   - connection can be closed/modified
127 1       EXECUTE - user allowed to execute requests.
128 .Ed
129 .Pp
130 By default, the connection is created with
131 .Ar mode
132 0700
133 and only the owner can use it.
134 Specifying 0750 as the argument to the
135 .Fl M
136 option would allow read-only group access as well.
137 This would allow the group to perform
138 .Tn NCP
139 requests,
140 but not to destroy the connection.
141 When a server is not explicitly specified,
142 ncp* programs try to find a suitable connection in the following order:
143 .Bl -enum -offset indent
144 .It
145 Try to find a connection owned by the user.
146 If there is more than one such
147 connection, try to determine which one is primary.
148 The primary flag is set with the
149 .Fl D
150 option.
151 .It
152 If the primary connection could not be determined,
153 the first shared connection will be used.
154 .El
155 .It Fl N
156 Do not prompt for a password.
157 At run time,
158 .Nm
159 reads the
160 .Pa ~/.nwfsrc
161 file for additional configuration parameters and a password.
162 If no password is found for the specified
163 .Ar server Ns : Ns Ar user
164 pair,
165 .Nm
166 prompts for it.
167 .It Fl O
168 Specify the
169 .Ar owner
170 and
171 .Ar group
172 attributes for the connection.
173 Newly created connections take the
174 .Ar owner
175 attribute from the creating user's username and the
176 .Ar group
177 attribute from the creating user's primary group.
178 This option overrides that behaviour.
179 Only the superuser can override the
180 .Ar owner
181 attribute for a connection.
182 .It Fl P
183 Mark the connection as permanent.
184 The
185 .Nm
186 utility always creates permanent connections.
187 This option can be used in other ncp*
188 programs.
189 .It Fl R Ar retry_count
190 Specify the number of retries to be performed
191 before dropping the connection.
192 The default value is 10.
193 .Pp
194 Note: after a connection is marked
195 .Sq BAD ,
196 each request will try to restore it.
197 This process restores only the
198 .Tn NCP
199 connection;
200 it does not reopen any files that were open
201 at the time that the connection was marked
202 .Sq BAD .
203 .It Fl W Ar timeout
204 Specify the server request timeout in seconds.
205 The default is 5 seconds.
206 .It / Ns Ar server Ns : Ns Ar user
207 This syntax is provided for the sake of simplicity
208 and is mutually exclusive with the
209 .Fl S
210 and
211 .Fl U
212 options.
213 .El
214 .Sh IMPLEMENTATION NOTES
215 Low level connection management is implemented in the
216 .Pa ncp.ko
217 module.
218 The
219 .Xr IPXrouted 8
220 program is also required for
221 .Tn IPX
222 support.
223 .Sh FILES
224 .Bl -tag -width /var/log/wtmp -compact
225 .It Pa ~/.nwfsrc
226 keeps static parameters for connections and other information
227 See
228 .Pa /usr/share/examples/nwclient/dot.nwfsrc
229 for details.
230 .El
231 .Sh HISTORY
232 The
233 .Nm
234 command first appeared in
235 .Fx 4.0 .
236 .Sh AUTHORS
237 .An Boris Popov Aq bp@butya.kz ,
238 .Aq rbp@chat.ru
239 .Sh BUGS
240 Please report any bugs to the author.