Merge from vendor branch LESS:
[dragonfly.git] / contrib / smbfs / smbutil / smbutil.1
1 .\" $Id: smbutil.1,v 1.5 2002/04/16 02:48:16 bp Exp $
2 .Dd February 14, 2000
3 .Dt SMBUTIL 1
4 .Os
5 .Sh NAME
6 .Nm smbutil
7 .Nd "interface to the SMB requester"
8 .Sh SYNOPSIS
9 .Nm
10 .Op Fl hv
11 .Ar command
12 .Op Fl Ar options
13 .Op Ar args
14 .Sh DESCRIPTION
15 The
16 .Nm
17 command is used to control SMB requester and issue various commands.
18 .Pp
19 There are two types of options \(em global and local to the specified
20 .Ar command .
21 .Pp
22 Global options are as follows:
23 .Bl -tag -width indent
24 .It Fl h
25 Print a short help message.
26 .It Fl v
27 Verbose output.
28 .El
29 .Pp
30 The commands and local options are:
31 .Bl -tag -width indent
32 .It Cm crypt Op Ar password
33 Encrypt clear text password for use in the
34 .Pa ~/.nsmbrc
35 file.
36 The encrypted password starts with the
37 .Ql $$1
38 symbols.
39 Warning: the encryption function is very weak and intended only to hide
40 clear text password.
41 If
42 .Ar password
43 is omitted from the command line,
44 .Nm
45 will prompt for one.
46 .It Cm help Ar command
47 Print usage information about
48 .Ar command .
49 .It Cm lc
50 List active connections and their parameters.
51 .It Xo
52 .Cm login
53 .Op Fl Ar connection_options
54 .No // Ns Ar user Ns @ Ns Ar server Ns Op / Ns Ar share
55 .Xc
56 Login/attach to the specified
57 .Ar server
58 and/or
59 .Ar share
60 as
61 .Ar user .
62 This command will create and authenticate connection to an SMB server, and
63 will leave it active after exit.
64 Thus, it is possible to login only once and then
65 use other SMB commands without authentication procedure and additional
66 connections.
67 For the description of
68 .Fl Ar connection_options
69 refer to the
70 .Xr mount_smbfs 8
71 manpage (all uppercase options are connection options).
72 .It Xo
73 .Cm logout
74 .No // Ns Ar user Ns @ Ns Ar server Ns Op / Ns Ar share
75 .Xc
76 Logout/detach from the specified
77 .Ar server
78 and/or
79 .Ar share
80 as
81 .Ar user .
82 This command will destroy a connection created by the
83 .Cm login
84 command.
85 A connection may not be closed immediately if it is used by other
86 programs.
87 .It Xo
88 .Cm lookup
89 .Op Fl w Ar host
90 .Ar name
91 .Xc
92 Resolve the given
93 .Ar name
94 to an IP address.
95 The NetBIOS name server can be directly specified via the
96 .Fl w
97 option.
98 .It Xo
99 .Cm print
100 .Op Fl Ar connection_options
101 .No // Ns Ar user Ns @ Ns Ar server Ns / Ns Ar share
102 .Ar file
103 .Xc
104 Send the given
105 .Ar file
106 to the specified queue on the remote server.
107 If
108 .Ar file
109 is
110 .Pa - ,
111 then standard input will be used.
112 .It Xo
113 .Cm view
114 .Op Fl Ar connection_options
115 .No // Ns Ar user Ns @ Ns Ar server
116 .Xc
117 List resources available on the specified
118 .Ar server
119 for the user
120 .Ar user .
121 .El
122 .Sh FILES
123 .Bl -tag -width ".Pa ~/.nsmbrc" -compact
124 .It Pa ~/.nsmbrc
125 Keeps description for each connection.
126 See
127 .Pa ./examples/dot.nsmbrc
128 for details.
129 .El
130 .Sh AUTHORS
131 .An Boris Popov Aq bp@butya.kz ,
132 .Aq bp@FreeBSD.org
133 .Sh BUGS
134 Please report any bugs to the author.