summaryrefslogtreecommitdiff
path: root/docs/manpages
diff options
context:
space:
mode:
authorJelmer Vernooij <jelmer@samba.org>2003-04-03 18:54:40 +0000
committerJelmer Vernooij <jelmer@samba.org>2003-04-03 18:54:40 +0000
commit754d895cea006ac4f06676d5c03e71576759bf7a (patch)
treea1c526a5884739383d9ff7216199a13da8b99210 /docs/manpages
parentfdb11bb6551a014db6acc7335e6b35172f39f9cd (diff)
downloadsamba-754d895cea006ac4f06676d5c03e71576759bf7a.tar.gz
samba-754d895cea006ac4f06676d5c03e71576759bf7a.tar.bz2
samba-754d895cea006ac4f06676d5c03e71576759bf7a.zip
Convert RoutedNetworks to SGML
(This used to be commit c38bdb2aa0a96006094d1455b23183e97b2e7b2a)
Diffstat (limited to 'docs/manpages')
-rw-r--r--docs/manpages/rpcclient.1330
-rw-r--r--docs/manpages/smbmnt.85
-rw-r--r--docs/manpages/smbmount.817
-rw-r--r--docs/manpages/smbsh.184
-rw-r--r--docs/manpages/smbspool.84
-rw-r--r--docs/manpages/smbtar.16
-rw-r--r--docs/manpages/testprns.12
7 files changed, 335 insertions, 113 deletions
diff --git a/docs/manpages/rpcclient.1 b/docs/manpages/rpcclient.1
index 76e606240f..8f880afcd3 100644
--- a/docs/manpages/rpcclient.1
+++ b/docs/manpages/rpcclient.1
@@ -172,56 +172,146 @@ options.
\fB-h|--help\fR
Print a summary of command line options.
.SH "COMMANDS"
-.PP
-\fBLSARPC\fR
-.TP 0.2i
-\(bu
+.SS "LSARPC"
+.TP
\fBlsaquery\fR
-.TP 0.2i
-\(bu
-\fBlookupsids\fR - Resolve a list
+Query info policy
+.TP
+\fBlookupsids\fR
+Resolve a list
of SIDs to usernames.
-.TP 0.2i
-\(bu
-\fBlookupnames\fR - Resolve a list
+.TP
+\fBlookupnames\fR
+Resolve a list
of usernames to SIDs.
-.TP 0.2i
-\(bu
+.TP
\fBenumtrusts\fR
+Enumerate trusted domains
+.TP
+\fBenumprivs\fR
+Enumerate privileges
+.TP
+\fBgetdispname\fR
+Get the privilege name
+.TP
+\fBlsaenumsid\fR
+Enumerate the LSA SIDS
+.TP
+\fBlsaenumprivsaccount\fR
+Enumerate the privileges of an SID
+.TP
+\fBlsaenumacctrights\fR
+Enumerate the rights of an SID
+.TP
+\fBlsaenumacctwithright\fR
+Enumerate accounts with a right
+.TP
+\fBlsaaddacctrights\fR
+Add rights to an account
+.TP
+\fBlsaremoveacctrights\fR
+Remove rights from an account
+.TP
+\fBlsalookupprivvalue\fR
+Get a privilege value given its name
+.TP
+\fBlsaquerysecobj\fR
+Query LSA security object
+.SS "LSARPC-DS"
+.TP
+\fBdsroledominfo\fR
+Get Primary Domain Information
.PP
.PP
-\fBSAMR\fR
-.TP 0.2i
-\(bu
+\fBDFS\fR
+.TP
+\fBdfsexist\fR
+Query DFS support
+.TP
+\fBdfsadd\fR
+Add a DFS share
+.TP
+\fBdfsremove\fR
+Remove a DFS share
+.TP
+\fBdfsgetinfo\fR
+Query DFS share info
+.TP
+\fBdfsenum\fR
+Enumerate dfs shares
+.SS "REG"
+.TP
+\fBshutdown\fR
+Remote Shutdown
+.TP
+\fBabortshutdown\fR
+Abort Shutdown
+.SS "SRVSVC"
+.TP
+\fBsrvinfo\fR
+Server query info
+.TP
+\fBnetshareenum\fR
+Enumerate shares
+.TP
+\fBnetfileenum\fR
+Enumerate open files
+.TP
+\fBnetremotetod\fR
+Fetch remote time of day
+.SS "SAMR"
+.TP
\fBqueryuser\fR
-.TP 0.2i
-\(bu
+Query user info
+.TP
\fBquerygroup\fR
-.TP 0.2i
-\(bu
+Query group info
+.TP
\fBqueryusergroups\fR
-.TP 0.2i
-\(bu
+Query user groups
+.TP
\fBquerygroupmem\fR
-.TP 0.2i
-\(bu
+Query group membership
+.TP
\fBqueryaliasmem\fR
-.TP 0.2i
-\(bu
+Query alias membership
+.TP
\fBquerydispinfo\fR
-.TP 0.2i
-\(bu
+Query display info
+.TP
\fBquerydominfo\fR
-.TP 0.2i
-\(bu
+Query domain info
+.TP
+\fBenumdomusers\fR
+Enumerate domain users
+.TP
\fBenumdomgroups\fR
-.PP
-.PP
-\fBSPOOLSS\fR
-.TP 0.2i
-\(bu
-\fBadddriver <arch> <config>\fR
-- Execute an AddPrinterDriver() RPC to install the printer driver
+Enumerate domain groups
+.TP
+\fBenumalsgroups\fR
+Enumerate alias groups
+.TP
+\fBcreatedomuser\fR
+Create domain user
+.TP
+\fBsamlookupnames\fR
+Look up names
+.TP
+\fBsamlookuprids\fR
+Look up names
+.TP
+\fBdeletedomuser\fR
+Delete domain user
+.TP
+\fBsamquerysecobj\fR
+Query SAMR security object
+.TP
+\fBgetdompwinfo\fR
+Retrieve domain password info
+.SS "SPOOLSS"
+.TP
+\fBadddriver <arch> <config>\fR
+Execute an AddPrinterDriver() RPC to install the printer driver
information on the server. Note that the driver files should
already exist in the directory returned by
\fBgetdriverdir\fR. Possible values for
@@ -250,111 +340,149 @@ use of a bi-directional link for communication. This field should
be "NULL". On a remote NT print server, the Print Monitor for a
driver must already be installed prior to adding the driver or
else the RPC will fail.
-.TP 0.2i
-\(bu
-\fBaddprinter <printername>
-<sharename> <drivername> <port>\fR
-- Add a printer on the remote server. This printer
+.TP
+\fBaddprinter <printername> <sharename> <drivername> <port>\fR
+Add a printer on the remote server. This printer
will be automatically shared. Be aware that the printer driver
must already be installed on the server (see \fBadddriver\fR)
and the \fIport\fRmust be a valid port name (see
\fBenumports\fR.
-.TP 0.2i
-\(bu
-\fBdeldriver\fR - Delete the
+.TP
+\fBdeldriver\fR
+Delete the
specified printer driver for all architectures. This
does not delete the actual driver files from the server,
only the entry from the server's list of drivers.
-.TP 0.2i
-\(bu
-\fBenumdata\fR - Enumerate all
+.TP
+\fBenumdata\fR
+Enumerate all
printer setting data stored on the server. On Windows NT clients,
these values are stored in the registry, while Samba servers
store them in the printers TDB. This command corresponds
to the MS Platform SDK GetPrinterData() function (* This
command is currently unimplemented).
-.TP 0.2i
-\(bu
-\fBenumjobs <printer>\fR
-- List the jobs and status of a given printer.
+.TP
+\fBenumdataex\fR
+Enumerate printer data for a key
+.TP
+\fBenumjobs <printer>\fR
+List the jobs and status of a given printer.
This command corresponds to the MS Platform SDK EnumJobs()
-function (* This command is currently unimplemented).
-.TP 0.2i
-\(bu
-\fBenumports [level]\fR
-- Executes an EnumPorts() call using the specified
+function
+.TP
+\fBenumkey\fR
+Enumerate printer keys
+.TP
+\fBenumports [level]\fR
+Executes an EnumPorts() call using the specified
info level. Currently only info levels 1 and 2 are supported.
-.TP 0.2i
-\(bu
-\fBenumdrivers [level]\fR
-- Execute an EnumPrinterDrivers() call. This lists the various installed
+.TP
+\fBenumdrivers [level]\fR
+Execute an EnumPrinterDrivers() call. This lists the various installed
printer drivers for all architectures. Refer to the MS Platform SDK
documentation for more details of the various flags and calling
options. Currently supported info levels are 1, 2, and 3.
-.TP 0.2i
-\(bu
-\fBenumprinters [level]\fR
-- Execute an EnumPrinters() call. This lists the various installed
+.TP
+\fBenumprinters [level]\fR
+Execute an EnumPrinters() call. This lists the various installed
and share printers. Refer to the MS Platform SDK documentation for
more details of the various flags and calling options. Currently
supported info levels are 0, 1, and 2.
-.TP 0.2i
-\(bu
-\fBgetdata <printername>\fR
-- Retrieve the data for a given printer setting. See
+.TP
+\fBgetdata <printername> <valuename;>\fR
+Retrieve the data for a given printer setting. See
the \fBenumdata\fR command for more information.
This command corresponds to the GetPrinterData() MS Platform
-SDK function (* This command is currently unimplemented).
-.TP 0.2i
-\(bu
-\fBgetdriver <printername>\fR
-- Retrieve the printer driver information (such as driver file,
+SDK function.
+.TP
+\fBgetdataex\fR
+Get printer driver data with keyname
+.TP
+\fBgetdriver <printername>\fR
+Retrieve the printer driver information (such as driver file,
config file, dependent files, etc...) for
the given printer. This command corresponds to the GetPrinterDriver()
MS Platform SDK function. Currently info level 1, 2, and 3 are supported.
-.TP 0.2i
-\(bu
-\fBgetdriverdir <arch>\fR
-- Execute a GetPrinterDriverDirectory()
+.TP
+\fBgetdriverdir <arch>\fR
+Execute a GetPrinterDriverDirectory()
RPC to retrieve the SMB share name and subdirectory for
storing printer driver files for a given architecture. Possible
values for \fIarch\fR are "Windows 4.0"
(for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows
Alpha_AXP", and "Windows NT R4000".
-.TP 0.2i
-\(bu
-\fBgetprinter <printername>\fR
-- Retrieve the current printer information. This command
+.TP
+\fBgetprinter <printername>\fR
+Retrieve the current printer information. This command
corresponds to the GetPrinter() MS Platform SDK function.
-.TP 0.2i
-\(bu
-\fBopenprinter <printername>\fR
-- Execute an OpenPrinterEx() and ClosePrinter() RPC
+.TP
+\fBgetprintprocdir\fR
+Get print processor directory
+.TP
+\fBopenprinter <printername>\fR
+Execute an OpenPrinterEx() and ClosePrinter() RPC
against a given printer.
-.TP 0.2i
-\(bu
-\fBsetdriver <printername>
-<drivername>\fR
-- Execute a SetPrinter() command to update the printer driver
+.TP
+\fBsetdriver <printername> <drivername>\fR
+Execute a SetPrinter() command to update the printer driver
associated with an installed printer. The printer driver must
already be correctly installed on the print server.
See also the \fBenumprinters\fR and
\fBenumdrivers\fR commands for obtaining a list of
of installed printers and drivers.
-.PP
-\fBGENERAL OPTIONS\fR
-.TP 0.2i
-\(bu
-\fBdebuglevel\fR - Set the current
+.TP
+\fBaddform\fR
+Add form
+.TP
+\fBsetform\fR
+Set form
+.TP
+\fBgetform\fR
+Get form
+.TP
+\fBdeleteform\fR
+Delete form
+.TP
+\fBenumforms\fR
+Enumerate form
+.TP
+\fBsetprinter\fR
+Set printer comment
+.TP
+\fBsetprinterdata\fR
+Set REG_SZ printer data
+.TP
+\fBrffpcnex\fR
+Rffpcnex test
+.SS "NETLOGON"
+.TP
+\fBlogonctrl2\fR
+Logon Control 2
+.TP
+\fBlogonctrl\fR
+Logon Control
+.TP
+\fBsamsync\fR
+Sam Synchronisation
+.TP
+\fBsamdeltas\fR
+Query Sam Deltas
+.TP
+\fBsamlogon\fR
+Sam Logon
+.SS "GENERAL COMMANDS"
+.TP
+\fBdebuglevel\fR
+Set the current
debug level used to log information.
-.TP 0.2i
-\(bu
-\fBhelp (?)\fR - Print a listing of all
+.TP
+\fBhelp (?)\fR
+Print a listing of all
known commands or extended help on a particular command.
-.TP 0.2i
-\(bu
-\fBquit (exit)\fR - Exit \fBrpcclient
+.TP
+\fBquit (exit)\fR
+Exit \fBrpcclient
\fR.
.SH "BUGS"
.PP
diff --git a/docs/manpages/smbmnt.8 b/docs/manpages/smbmnt.8
index c17d15261a..5c9a662863 100644
--- a/docs/manpages/smbmnt.8
+++ b/docs/manpages/smbmnt.8
@@ -9,7 +9,7 @@
smbmnt \- helper utility for mounting SMB filesystems
.SH SYNOPSIS
-\fBsmbmnt\fR \fBmount-point\fR [ \fB-s <share>\fR ] [ \fB-r\fR ] [ \fB-u <uid>\fR ] [ \fB-g <gid>\fR ] [ \fB-f <mask>\fR ] [ \fB-d <mask>\fR ] [ \fB-o <options>\fR ]
+\fBsmbmnt\fR \fBmount-point\fR [ \fB-s <share>\fR ] [ \fB-r\fR ] [ \fB-u <uid>\fR ] [ \fB-g <gid>\fR ] [ \fB-f <mask>\fR ] [ \fB-d <mask>\fR ] [ \fB-o <options>\fR ] [ \fB-h\fR ]
.SH "DESCRIPTION"
.PP
@@ -49,6 +49,9 @@ applied
\fB-o options\fR
list of options that are passed as-is to smbfs, if this
command is run on a 2.4 or higher Linux kernel.
+.TP
+\fB-h|--help\fR
+Print a summary of command line options.
.SH "AUTHOR"
.PP
Volker Lendecke, Andrew Tridgell, Michael H. Warfield
diff --git a/docs/manpages/smbmount.8 b/docs/manpages/smbmount.8
index 344fc5e0cd..207ec836d6 100644
--- a/docs/manpages/smbmount.8
+++ b/docs/manpages/smbmount.8
@@ -70,6 +70,9 @@ This is preferred over having passwords in plaintext in a
shared file, such as \fI/etc/fstab\fR. Be sure to protect any
credentials file properly.
.TP
+\fBkrb\fR
+Use kerberos (Active Directory).
+.TP
\fBnetbiosname=<arg>\fR
sets the source NetBIOS name. It defaults
to the local hostname.
@@ -95,30 +98,30 @@ permissions that remote files have in the local filesystem.
The default is based on the current umask.
.TP
\fBdmask=<arg>\fR
-sets the directory mask. This determines the
+Sets the directory mask. This determines the
permissions that remote directories have in the local filesystem.
The default is based on the current umask.
.TP
\fBdebug=<arg>\fR
-sets the debug level. This is useful for
+Sets the debug level. This is useful for
tracking down SMB connection problems. A suggested value to
start with is 4. If set too high there will be a lot of
output, possibly hiding the useful output.
.TP
\fBip=<arg>\fR
-sets the destination host or IP address.
+Sets the destination host or IP address.
.TP
\fBworkgroup=<arg>\fR
-sets the workgroup on the destination
+Sets the workgroup on the destination
.TP
\fBsockopt=<arg>\fR
-sets the TCP socket options. See the \fBsmb.conf\fR(5) \fIsocket options\fR option.
+Sets the TCP socket options. See the \fBsmb.conf\fR(5) \fIsocket options\fR option.
.TP
\fBscope=<arg>\fR
-sets the NetBIOS scope
+Sets the NetBIOS scope
.TP
\fBguest\fR
-don't prompt for a password
+Don't prompt for a password
.TP
\fBro\fR
mount read-only
diff --git a/docs/manpages/smbsh.1 b/docs/manpages/smbsh.1
index d2770d410a..f7ee47949b 100644
--- a/docs/manpages/smbsh.1
+++ b/docs/manpages/smbsh.1
@@ -39,6 +39,90 @@ the user to set the directory prefix for SMB access. The
default value if this option is not specified is
\fBsmb\fR.
.TP
+\fB-s <configuration file>\fR
+The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See \fIsmb.conf(5)\fR for more information.
+The default configuration file name is determined at
+compile time.
+.TP
+\fB-d|--debug=debuglevel\fR
+\fIdebuglevel\fR is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.
+
+The higher this value, the more detail will be
+logged to the log files about the activities of the
+server. At level 0, only critical errors and serious
+warnings will be logged. Level 1 is a reasonable level for
+day to day running - it generates a small amount of
+information about operations carried out.
+
+Levels above 1 will generate considerable
+amounts of log data, and should only be used when
+investigating a problem. Levels above 3 are designed for
+use only by developers and generate HUGE amounts of log
+data, most of which is extremely cryptic.
+
+Note that specifying this parameter here will
+override the log
+level file.
+.TP
+\fB-R <name resolve order>\fR
+This option is used to determine what naming
+services and in what order to resolve
+host names to IP addresses. The option takes a space-separated
+string of different name resolution options.
+
+The options are: "lmhosts", "host", "wins" and "bcast".
+They cause names to be resolved as follows :
+.RS
+.TP 0.2i
+\(bu
+lmhosts:
+Lookup an IP address in the Samba lmhosts file. If the
+line in lmhosts has no name type attached to the
+NetBIOS name
+(see the \fBlmhosts\fR(5) for details)
+then any name type matches for lookup.
+.TP 0.2i
+\(bu
+host:
+Do a standard host name to IP address resolution, using
+the system \fI/etc/hosts\fR, NIS, or DNS
+lookups. This method of name resolution is operating
+system dependent, for instance on IRIX or Solaris this
+may be controlled by the \fI/etc/nsswitch.conf\fR file). Note that this method is only used
+if the NetBIOS name type being queried is the 0x20
+(server) name type, otherwise it is ignored.
+.TP 0.2i
+\(bu
+wins:
+Query a name with the IP address listed in the
+\fIwins server\fR parameter. If no
+WINS server has been specified this method will be
+ignored.
+.TP 0.2i
+\(bu
+bcast:
+Do a broadcast on each of the known local interfaces
+listed in the \fIinterfaces\fR
+parameter. This is the least reliable of the name
+resolution methods as it depends on the target host
+being on a locally connected subnet.
+.RE
+
+If this parameter is not set then the name resolve order
+defined in the \fBsmb.conf\fR(5) file parameter
+(\fIname resolve order\fR) will be used.
+
+The default order is lmhosts, host, wins, bcast. Without
+this parameter or any entry in the \fIname resolve order\fR parameter of the \fBsmb.conf\fR(5) file, the name resolution methods
+will be attempted in this order.
+.TP
\fB-L libdir\fR
This parameter specifies the location of the
shared libraries used by \fBsmbsh\fR. The default
diff --git a/docs/manpages/smbspool.8 b/docs/manpages/smbspool.8
index 7ee3a465b3..8cfa1b2671 100644
--- a/docs/manpages/smbspool.8
+++ b/docs/manpages/smbspool.8
@@ -9,7 +9,7 @@
smbspool \- send a print file to an SMB printer
.SH SYNOPSIS
-\fBsmbspool\fR [ \fBjob\fR ] [ \fBuser\fR ] [ \fBtitle\fR ] [ \fBcopies\fR ] [ \fBoptions\fR ] [ \fBfilename\fR ]
+\fBsmbspool\fR \fBjob\fR \fBuser\fR \fBtitle\fR \fBcopies\fR \fBoptions\fR [ \fBfilename\fR ]
.SH "DESCRIPTION"
.PP
@@ -78,7 +78,7 @@ name of the file to print. If this argument is not specified
then the print file is read from the standard input.
.SH "VERSION"
.PP
-This man page is correct for version 2.2 of the Samba suite.
+This man page is correct for version 3.0 of the Samba suite.
.SH "SEE ALSO"
.PP
\fBsmbd\fR(8) and \fBSamba\fR(7).
diff --git a/docs/manpages/smbtar.1 b/docs/manpages/smbtar.1
index bef59c21ac..e15af72b65 100644
--- a/docs/manpages/smbtar.1
+++ b/docs/manpages/smbtar.1
@@ -9,7 +9,7 @@
smbtar \- shell script for backing up SMB/CIFS shares directly to UNIX tape drives
.SH SYNOPSIS
-\fBsmbtar\fR \fB-s server\fR [ \fB-p password\fR ] [ \fB-x services\fR ] [ \fB-X\fR ] [ \fB-d directory\fR ] [ \fB-u user\fR ] [ \fB-t tape\fR ] [ \fB-t tape\fR ] [ \fB-b blocksize\fR ] [ \fB-N filename\fR ] [ \fB-i\fR ] [ \fB-r\fR ] [ \fB-l loglevel\fR ] [ \fB-v\fR ] \fBfilenames\fR
+\fBsmbtar\fR [ \fB-r\fR ] [ \fB-i\fR ] [ \fB-a\fR ] [ \fB-v\fR ] \fB-s server\fR [ \fB-p password\fR ] [ \fB-x services\fR ] [ \fB-X\fR ] [ \fB-N filename\fR ] [ \fB-b blocksize\fR ] [ \fB-d directory\fR ] [ \fB-l loglevel\fR ] [ \fB-u user\fR ] [ \fB-t tape\fR ] \fBfilenames\fR
.SH "DESCRIPTION"
.PP
@@ -46,6 +46,10 @@ Default: none
The user id to connect as. Default:
UNIX login name.
.TP
+\fB-a\fR
+Reset DOS archive bit mode to
+indicate file has been archived.
+.TP
\fB-t tape\fR
Tape device. May be regular file or tape
device. Default: \fI$TAPE\fR environmental
diff --git a/docs/manpages/testprns.1 b/docs/manpages/testprns.1
index 49ec423986..5779d71b19 100644
--- a/docs/manpages/testprns.1
+++ b/docs/manpages/testprns.1
@@ -69,7 +69,7 @@ for errors and warnings.
Other messages are self-explanatory.
.SH "VERSION"
.PP
-This man page is correct for version 2.2 of
+This man page is correct for version 3.0 of
the Samba suite.
.SH "SEE ALSO"
.PP