diff options
| -rw-r--r-- | docs/docbook/manpages/rpcclient.1.sgml | 262 |
1 files changed, 140 insertions, 122 deletions
diff --git a/docs/docbook/manpages/rpcclient.1.sgml b/docs/docbook/manpages/rpcclient.1.sgml index 3e81711d5d..de4d8d72fc 100644 --- a/docs/docbook/manpages/rpcclient.1.sgml +++ b/docs/docbook/manpages/rpcclient.1.sgml @@ -58,7 +58,7 @@ resolved using the <ulink url="smb.conf.5.html#NAMERESOLVEORDER"> <parameter>name resolve order</parameter></ulink> line from <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry>.</para></listitem> - </varlistentry> + </varlistentry> <varlistentry> @@ -97,110 +97,121 @@ <refsect1> <title>COMMANDS</title> - <para><emphasis>LSARPC</emphasis></para> - <itemizedlist> - <listitem><para><command>lsaquery</command> - Query info policy</para></listitem> + <refsect2> + <title>LSARPC</title> + + <variablelist> + <varlistentry><term>lsaquery</term><listitem><para>Query info policy</para></listitem></varlistentry> - <listitem><para><command>lookupsids</command> - Resolve a list + <varlistentry><term>lookupsids</term><listitem><para>Resolve a list of SIDs to usernames. - </para></listitem> + </para></listitem></varlistentry> - <listitem><para><command>lookupnames</command> - Resolve a list + <varlistentry><term>lookupnames</term><listitem><para>Resolve a list of usernames to SIDs. - </para></listitem> + </para></listitem></varlistentry> - <listitem><para><command>enumtrusts</command> - Enumerate trusted domains</para></listitem> + <varlistentry><term>enumtrusts</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry> - <listitem><para><command>enumprivs</command> - Enumerate privileges</para></listitem> + <varlistentry><term>enumprivs</term><listitem><para>Enumerate privileges</para></listitem></varlistentry> - <listitem><para><command>getdispname</command> - Get the privilege name</para></listitem> + <varlistentry><term>getdispname</term><listitem><para>Get the privilege name</para></listitem></varlistentry> - <listitem><para><command>lsaenumsid</command> - Enumerate the LSA SIDS</para></listitem> + <varlistentry><term>lsaenumsid</term><listitem><para>Enumerate the LSA SIDS</para></listitem></varlistentry> - <listitem><para><command>lsaenumprivsaccount</command> - Enumerate the privileges of an SID</para></listitem> + <varlistentry><term>lsaenumprivsaccount</term><listitem><para>Enumerate the privileges of an SID</para></listitem></varlistentry> - <listitem><para><command>lsaenumacctrights</command> - Enumerate the rights of an SID</para></listitem> + <varlistentry><term>lsaenumacctrights</term><listitem><para>Enumerate the rights of an SID</para></listitem></varlistentry> - <listitem><para><command>lsaenumacctwithright</command> - Enumerate accounts with a right</para></listitem> + <varlistentry><term>lsaenumacctwithright</term><listitem><para>Enumerate accounts with a right</para></listitem></varlistentry> - <listitem><para><command>lsaaddacctrights</command> - Add rights to an account</para></listitem> + <varlistentry><term>lsaaddacctrights</term><listitem><para>Add rights to an account</para></listitem></varlistentry> - <listitem><para><command>lsaremoveacctrights</command> - Remove rights from an account</para></listitem> + <varlistentry><term>lsaremoveacctrights</term><listitem><para>Remove rights from an account</para></listitem></varlistentry> - <listitem><para><command>lsalookupprivvalue</command> - Get a privilege value given its name</para></listitem> + <varlistentry><term>lsalookupprivvalue</term><listitem><para>Get a privilege value given its name</para></listitem></varlistentry> - <listitem><para><command>lsaquerysecobj</command> - Query LSA security object</para></listitem> + <varlistentry><term>lsaquerysecobj</term><listitem><para>Query LSA security object</para></listitem></varlistentry> - </itemizedlist> + </variablelist> + </refsect2> - <para> </para> - - <para><emphasis>LSARPC-DS</emphasis></para> - <itemizedlist> - <listitem><para><command>dsroledominfo</command> - Get Primary Domain Information</para></listitem> - </itemizedlist> + <refsect2> + <title>LSARPC-DS</title> + + <variablelist> + <varlistentry><term>dsroledominfo</term><listitem><para>Get Primary Domain Information</para></listitem></varlistentry> + </variablelist> <para> </para> <para><emphasis>DFS</emphasis></para> - <itemizedlist> - <listitem><para><command>dfsexist</command> - Query DFS support</para></listitem> - <listitem><para><command>dfsadd</command> - Add a DFS share</para></listitem> - <listitem><para><command>dfsremove</command> - Remove a DFS share</para></listitem> - <listitem><para><command>dfsgetinfo</command> - Query DFS share info</para></listitem> - <listitem><para><command>dfsenum</command> - Enumerate dfs shares</para></listitem> - </itemizedlist> + <variablelist> + <varlistentry><term>dfsexist</term><listitem><para>Query DFS support</para></listitem></varlistentry> + <varlistentry><term>dfsadd</term><listitem><para>Add a DFS share</para></listitem></varlistentry> + <varlistentry><term>dfsremove</term><listitem><para>Remove a DFS share</para></listitem></varlistentry> + <varlistentry><term>dfsgetinfo</term><listitem><para>Query DFS share info</para></listitem></varlistentry> + <varlistentry><term>dfsenum</term><listitem><para>Enumerate dfs shares</para></listitem></varlistentry> + </variablelist> - <para> </para> + </refsect2> - <para><emphasis>REG</emphasis></para> - <itemizedlist> - <listitem><para><command>shutdown</command> - Remote Shutdown</para></listitem> - <listitem><para><command>abortshutdown</command> - Abort Shutdown</para></listitem> - </itemizedlist> + <refsect2> + <title>REG</title> + <variablelist> + <varlistentry><term>shutdown</term><listitem><para>Remote Shutdown</para></listitem></varlistentry> + <varlistentry><term>abortshutdown</term><listitem><para>Abort Shutdown</para></listitem></varlistentry> + </variablelist> - <para> </para> + </refsect2> - <para><emphasis>SRVSVC</emphasis></para> - <itemizedlist> - <listitem><para><command>srvinfo</command> - Server query info</para></listitem> + <refsect2> + <title>SRVSVC</title> + + <variablelist> + <varlistentry><term>srvinfo</term><listitem><para>Server query info</para></listitem></varlistentry> - <listitem><para><command>netshareenum</command> - Enumerate shares</para></listitem> + <varlistentry><term>netshareenum</term><listitem><para>Enumerate shares</para></listitem></varlistentry> - <listitem><para><command>netfileenum</command> - Enumerate open files</para></listitem> + <varlistentry><term>netfileenum</term><listitem><para>Enumerate open files</para></listitem></varlistentry> - <listitem><para><command>netremotetod</command> - Fetch remote time of day</para></listitem> + <varlistentry><term>netremotetod</term><listitem><para>Fetch remote time of day</para></listitem></varlistentry> - </itemizedlist> + </variablelist> - <para> </para> + </refsect2> - <para><emphasis>SAMR</emphasis></para> - <itemizedlist> - <listitem><para><command>queryuser</command> - Query user info</para></listitem> - <listitem><para><command>querygroup</command> - Query group info</para></listitem> - <listitem><para><command>queryusergroups</command> - Query user groups</para></listitem> - <listitem><para><command>querygroupmem</command> - Query group membership</para></listitem> - <listitem><para><command>queryaliasmem</command> - Query alias membership</para></listitem> - <listitem><para><command>querydispinfo</command> - Query display info</para></listitem> - <listitem><para><command>querydominfo</command> - Query domain info</para></listitem> - <listitem><para><command>enumdomusers</command> - Enumerate domain users</para></listitem> - <listitem><para><command>enumdomgroups</command> - Enumerate domain groups</para></listitem> - <listitem><para><command>enumalsgroups</command> - Enumerate alias groups</para></listitem> - <listitem><para><command>createdomuser</command> - Create domain user</para></listitem> - <listitem><para><command>samlookupnames</command> - Look up names</para></listitem> - <listitem><para><command>samlookuprids</command> - Look up names</para></listitem> - <listitem><para><command>deletedomuser</command> - Delete domain user</para></listitem> - <listitem><para><command>samquerysecobj</command> - Query SAMR security object</para></listitem> - <listitem><para><command>getdompwinfo</command> - Retrieve domain password info</para></listitem> - </itemizedlist> - <para> </para> + <refsect2> + <title>SAMR</title> + + <variablelist> + <varlistentry><term>queryuser</term><listitem><para>Query user info</para></listitem></varlistentry> + <varlistentry><term>querygroup</term><listitem><para>Query group info</para></listitem></varlistentry> + <varlistentry><term>queryusergroups</term><listitem><para>Query user groups</para></listitem></varlistentry> + <varlistentry><term>querygroupmem</term><listitem><para>Query group membership</para></listitem></varlistentry> + <varlistentry><term>queryaliasmem</term><listitem><para>Query alias membership</para></listitem></varlistentry> + <varlistentry><term>querydispinfo</term><listitem><para>Query display info</para></listitem></varlistentry> + <varlistentry><term>querydominfo</term><listitem><para>Query domain info</para></listitem></varlistentry> + <varlistentry><term>enumdomusers</term><listitem><para>Enumerate domain users</para></listitem></varlistentry> + <varlistentry><term>enumdomgroups</term><listitem><para>Enumerate domain groups</para></listitem></varlistentry> + <varlistentry><term>enumalsgroups</term><listitem><para>Enumerate alias groups</para></listitem></varlistentry> + <varlistentry><term>createdomuser</term><listitem><para>Create domain user</para></listitem></varlistentry> + <varlistentry><term>samlookupnames</term><listitem><para>Look up names</para></listitem></varlistentry> + <varlistentry><term>samlookuprids</term><listitem><para>Look up names</para></listitem></varlistentry> + <varlistentry><term>deletedomuser</term><listitem><para>Delete domain user</para></listitem></varlistentry> + <varlistentry><term>samquerysecobj</term><listitem><para>Query SAMR security object</para></listitem></varlistentry> + <varlistentry><term>getdompwinfo</term><listitem><para>Retrieve domain password info</para></listitem></varlistentry> + </variablelist> + + </refsect2> - <para><emphasis>SPOOLSS</emphasis></para> + <refsect2> + <title>SPOOLSS</title> - <itemizedlist> - <listitem><para><command>adddriver <arch> <config></command> - - Execute an AddPrinterDriver() RPC to install the printer driver + <variablelist> + <varlistentry><term>adddriver <arch> <config></term> + <listitem><para> + 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 <command>getdriverdir</command>. Possible values for @@ -227,130 +238,137 @@ Comma Separated list of Files 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. </para></listitem> + else the RPC will fail. </para></listitem></varlistentry> - <listitem><para><command>addprinter <printername> - <sharename> <drivername> <port></command> - - Add a printer on the remote server. This printer + <varlistentry><term>addprinter <printername> + <sharename> <drivername> <port></term> + <listitem><para> + 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 <command>adddriver</command>) and the <parameter>port</parameter>must be a valid port name (see <command>enumports</command>.</para> - </listitem> + </listitem></varlistentry> - <listitem><para><command>deldriver</command> - Delete the + <varlistentry><term>deldriver</term><listitem><para>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. - </para></listitem> + </para></listitem></varlistentry> - <listitem><para><command>enumdata</command> - Enumerate all + <varlistentry><term>enumdata</term><listitem><para>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).</para></listitem> + command is currently unimplemented).</para></listitem></varlistentry> - <listitem><para><command>enumjobs <printer></command> - - List the jobs and status of a given printer. + <varlistentry><term>enumjobs <printer></term> + <listitem><para>List the jobs and status of a given printer. This command corresponds to the MS Platform SDK EnumJobs() - function </listitem> + function </listitem></varlistentry> - <listitem><para><command>enumports [level]</command> - - Executes an EnumPorts() call using the specified + <varlistentry><term>enumports [level]</term> + <listitem><para> + Executes an EnumPorts() call using the specified info level. Currently only info levels 1 and 2 are supported. - </para></listitem> + </para></listitem></varlistentry> - <listitem><para><command>enumdrivers [level]</command> - - Execute an EnumPrinterDrivers() call. This lists the various installed + <varlistentry><term>enumdrivers [level]</term> + <listitem><para> + 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.</para></listitem> + options. Currently supported info levels are 1, 2, and 3.</para></listitem></varlistentry> - <listitem><para><command>enumprinters [level]</command> - - Execute an EnumPrinters() call. This lists the various installed + <varlistentry><term>enumprinters [level]</term> + <listitem><para>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.</para></listitem> + supported info levels are 0, 1, and 2.</para></listitem></varlistentry> - <listitem><para><command>getdata <printername> <valuename;></command> - - Retrieve the data for a given printer setting. See + <varlistentry><term>getdata <printername> <valuename;></term> + <listitem><para>Retrieve the data for a given printer setting. See the <command>enumdata</command> command for more information. This command corresponds to the GetPrinterData() MS Platform - SDK function. </para></listitem> + SDK function. </para></listitem></varlistentry> - <listitem><para><command>getdriver <printername></command> - - Retrieve the printer driver information (such as driver file, + <varlistentry><term>getdriver <printername></term> + <listitem><para> + 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. - </para></listitem> + </para></listitem></varlistentry> - <listitem><para><command>getdriverdir <arch></command> - - Execute a GetPrinterDriverDirectory() + <varlistentry><term>getdriverdir <arch></term> + <listitem><para> + Execute a GetPrinterDriverDirectory() RPC to retrieve the SMB share name and subdirectory for storing printer driver files for a given architecture. Possible values for <parameter>arch</parameter> are "Windows 4.0" (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows - Alpha_AXP", and "Windows NT R4000". </para></listitem> + Alpha_AXP", and "Windows NT R4000". </para></listitem></varlistentry> - <listitem><para><command>getprinter <printername></command> - - Retrieve the current printer information. This command + <varlistentry><term>getprinter <printername></term> + <listitem><para>Retrieve the current printer information. This command corresponds to the GetPrinter() MS Platform SDK function. - </para></listitem> + </para></listitem></varlistentry> - <listitem><para><command>openprinter <printername></command> - - Execute an OpenPrinterEx() and ClosePrinter() RPC + <varlistentry><term>openprinter <printername></term> + <listitem><para>Execute an OpenPrinterEx() and ClosePrinter() RPC against a given printer. </para></listitem> - <listitem><para><command>setdriver <printername> - <drivername></command> - - Execute a SetPrinter() command to update the printer driver + <varlistentry><term>setdriver <printername> + <drivername></term> + <listitem><para>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. </para> <para>See also the <command>enumprinters</command> and <command>enumdrivers</command> commands for obtaining a list of - of installed printers and drivers.</para></listitem> + of installed printers and drivers.</para></listitem></varlistentry> - </itemizedlist> + </variablelist> + </refsect2> - <para><emphasis>GENERAL OPTIONS</emphasis></para> + <refsect2> + <title>GENERAL COMMANDS</title> - <itemizedlist> - <listitem><para><command>debuglevel</command> - Set the current - debug level used to log information.</para></listitem> + <variablelist> + <varlistentry><term>debuglevel</term><listitem><para>Set the current + debug level used to log information.</para></listitem></varlistentry> - <listitem><para><command>help (?)</command> - Print a listing of all + <varlistentry><term>help (?)</term><listitem><para>Print a listing of all known commands or extended help on a particular command. - </para></listitem> + </para></listitem></varlistentry> - <listitem><para><command>quit (exit)</command> - Exit <command>rpcclient - </command>.</para></listitem> - </itemizedlist> - + <varlistentry><term>quit (exit)</term><listitem><para>Exit <command>rpcclient + </command>.</para></listitem></varlistentry> + </variablelist> + </refsect2> </refsect1> |