usr.bin/ncplogin/ncplogin.1

   1 .\" $FreeBSD$
   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
  49 .Ar NetWareServer Ns : Ns Ar NetWareUser
  50 pair should be unique.
  51 .Pp
  52 The
  53 .Nm
  54 command is used to create a permanent connection to a
  55 .Tn NetWare
  56 server.
  57 Permanent connections will stay open even if no application uses them.
  58 This allows users to run different
  59 .Pa ncp*
  60 programs
  61 without specifying a file server and user to use.
  62 Established connections can be destroyed with the
  63 .Xr ncplogout 1
  64 command.
  65 .Pp
  66 Upper case options described in this manual page
  67 are common for other
  68 .Pa ncp*
  69 programs and are referred to as
  70 .Dq connection options .
  71 Options
  72 .Fl U
  73 and
  74 .Fl S
  75 are mutually exclusive with the
  76 .No / Ns Ar server Ns : Ns Ar user
  77 syntax.
  78 .Pp
  79 The following options are available:
  80 .Bl -tag -width indent
  81 .It Fl S Ar server
  82 Specify the name of the
  83 .Tn NetWare
  84 server to connect to.
  85 This affects only
  86 .Tn IPX
  87 servers.
  88 For servers supporting
  89 .Tn IP
  90 natively, see the
  91 .Fl A
  92 option.
  93 .It Fl U Ar user
  94 Specify the name of the user used in the login sequence.
  95 .It Fl A Ar host
  96 Use the
  97 .Tn UDP
  98 protocol to connect to a
  99 .Tn NetWare
 100 5.x server specified by the
 101 .Ar host
 102 argument.
 103 .It Fl C
 104 Do not convert the password to uppercase.
 105 .It Fl D
 106 Mark the connection as primary.
 107 The option can be used to modify existing connections.
 108 Only the
 109 .Nm
 110 program accepts this option.
 111 .It Fl I Ar signature_level
 112 Try to use
 113 .Ar signature_level .
 114 Available values are:
 115 .Pp
 116 .Bl -tag -width ".Em Value" -offset indent -compact
 117 .It Em Value
 118 .Em Meaning
 119 .It 0
 120 disable signatures
 121 .It 1
 122 enable (use if required by server)
 123 .It 2
 124 request but do not require signing
 125 .It 3
 126 require signatures
 127 .El
 128 .Pp
 129 Note that only packet header signing is implemented.
 130 .It Fl M Ar mode
 131 Share this connection.
 132 The bits in the
 133 .Ar mode
 134 argument are similar to standard file permissions:
 135 .Pp
 136 .Bl -tag -width ".Em Mask" -offset indent -compact
 137 .It Em Mask
 138 .Em Meaning
 139 .It 4
 140 .Pq READ
 141 connection will be visible.
 142 .It 2
 143 .Pq WRITE
 144 connection can be closed/modified.
 145 .It 1
 146 .Pq EXECUTE
 147 user is allowed to execute requests.
 148 .El
 149 .Pp
 150 By default, the connection is created with
 151 .Ar mode
 152 0700
 153 and only the owner can use it.
 154 Specifying 0750 as the argument to the
 155 .Fl M
 156 option would allow read-only group access as well.
 157 This would allow the group to perform
 158 .Tn NCP
 159 requests,
 160 but not to destroy the connection.
 161 When a server is not explicitly specified,
 162 .Pa ncp*
 163 programs try to find a suitable connection in the following order:
 164 .Bl -enum -offset indent
 165 .It
 166 Try to find a connection owned by the user.
 167 If there is more than one such
 168 connection, try to determine which one is primary.
 169 (The primary flag is set with the
 170 .Fl D
 171 option.)
 172 .It
 173 If the primary connection could not be determined,
 174 the first shared connection will be used.
 175 .El
 176 .It Fl N
 177 Do not prompt for a password.
 178 At run time,
 179 .Nm
 180 reads the
 181 .Pa ~/.nwfsrc
 182 file for additional configuration parameters and a password.
 183 If no password is found for the specified
 184 .Ar server Ns : Ns Ar user
 185 pair,
 186 .Nm
 187 prompts for it.
 188 .It Fl O
 189 Specify the
 190 .Ar owner
 191 and
 192 .Ar group
 193 attributes for the connection.
 194 By default, newly created connections take the
 195 .Ar owner
 196 attribute from the creating user's username and the
 197 .Ar group
 198 attribute from the creating user's primary group.
 199 This option overrides that behaviour.
 200 Only the superuser can override the
 201 .Ar owner
 202 attribute for a connection.
 203 .It Fl P
 204 Mark the connection as permanent.
 205 The
 206 .Nm
 207 utility always creates permanent connections.
 208 This option can be useful in other
 209 .Pa ncp*
 210 programs.
 211 .It Fl R Ar retry_count
 212 Specify the number of retries to be performed
 213 before dropping the connection.
 214 The default value is 10.
 215 .Pp
 216 Note: after a connection is marked
 217 .Dq BAD ,
 218 each request will try to restore it.
 219 This process restores only the
 220 .Tn NCP
 221 connection;
 222 it does not reopen any files that were open
 223 at the time that the connection was marked
 224 .Dq BAD .
 225 .It Fl W Ar timeout
 226 Specify the server request timeout in seconds.
 227 The default is 5 seconds.
 228 .It / Ns Ar server Ns : Ns Ar user
 229 This syntax is provided for the sake of simplicity
 230 and is mutually exclusive with the
 231 .Fl S
 232 and
 233 .Fl U
 234 options.
 235 .El
 236 .Sh IMPLEMENTATION NOTES
 237 Low-level connection management is implemented in the
 238 .Pa ncp.ko
 239 kernel module.
 240 The
 241 .Xr IPXrouted 8
 242 program is also required for
 243 .Tn IPX
 244 support.
 245 .Sh FILES
 246 .Bl -tag -width ".Pa ~/.nwfsrc"
 247 .It Pa ~/.nwfsrc
 248 keeps static parameters for connections and other information;
 249 see
 250 .Pa /usr/share/examples/nwclient/dot.nwfsrc
 251 for details.
 252 .El
 253 .Sh HISTORY
 254 The
 255 .Nm
 256 command first appeared in
 257 .Fx 4.0 .
 258 .Sh AUTHORS
 259 .An Boris Popov Aq bp@butya.kz ,
 260 .Aq rbp@chat.ru
 261 .Sh BUGS
 262 Please report any bugs to the author.