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