diff options
| -rw-r--r-- | docs/docbook/manpages/net.8.sgml | 833 |
1 files changed, 633 insertions, 200 deletions
diff --git a/docs/docbook/manpages/net.8.sgml b/docs/docbook/manpages/net.8.sgml index 62cee8c1d7..f4f75d0c88 100644 --- a/docs/docbook/manpages/net.8.sgml +++ b/docs/docbook/manpages/net.8.sgml @@ -1,4 +1,40 @@ -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; + +<!-- This one is only used for adding users using RAP --> +<!ENTITY net.arg.flags ' +<varlistentry> +<term>-F flags</term> +<listitem><para> +FIXME. Defaults to 0x21 +</para></listitem> +</varlistentry>'> + +<!-- This one is only used by shutdown (RPC) --> +<!ENTITY net.arg.shutdown ' +<varlistentry> +<term>-r</term> +<listitem><para> +Reboot after shutdown. +</para></listitem> +</varlistentry> + +<varlistentry> +<term>-f</term> +<listitem><para> +Force shutting down all applications. +</para></listitem> +</varlistentry> + +<varlistentry> +<term>-t timeout</term> +<listitem><para> +Timeout before system will be shut down. An interactive +user of the system can use this time to cancel the shutdown. +</para></listitem> +</varlistentry>'> +]> + <refentry id="net.8"> <refmeta> @@ -10,7 +46,8 @@ <refnamediv> <refname>net</refname> <refpurpose>Tool for administration of Samba and remote - CIFS servers.</refpurpose> + CIFS servers. + </refpurpose> </refnamediv> <refsynopsisdiv> @@ -26,14 +63,7 @@ <arg choice="opt">-n myname</arg> <arg choice="opt">-s conffile</arg> <arg choice="opt">-S server</arg> - <arg choice="opt">-C comment</arg> - <arg choice="opt">-M maxusers</arg> - <arg choice="opt">-F flags</arg> - <arg choice="opt">-j jobid</arg> <arg choice="opt">-l</arg> - <arg choice="opt">-r</arg> - <arg choice="opt">-f</arg> - <arg choice="opt">-t timeout</arg> <arg choice="opt">-P</arg> <arg choice="opt">-D debuglevel</arg> </cmdsynopsis> @@ -46,7 +76,13 @@ <manvolnum>7</manvolnum></citerefentry> suite.</para> <para>The samba net utility is meant to work just like the net utility - available for windows and DOS.</para> + available for windows and DOS. The first argument should be used + to specify the protocol to use when executing a certain command. + ADS is used for ActiveDirectory, RAP is using for old (Win9x/NT3) + clients and RPC can be used for NT4 and Windows 2000. If this + argument is omitted, net will try to determine it automatically. + Not all commands are available on all protocols. + </para> </refsect1> @@ -54,13 +90,7 @@ <title>OPTIONS</title> <variablelist> - <varlistentry> - <term>-h</term> - <listitem><para> - Display summary of all available options. - - </para></listitem> - </varlistentry> + &stdarg.help; <varlistentry> <term>-w target-workgroup</term> @@ -88,30 +118,21 @@ <term>-I ip-address</term> <listitem><para> IP address of target server to use. You have to - specify either this option or a target workgroup or a target server. + specify either this option or a target workgroup or + a target server. </para></listitem> </varlistentry> <varlistentry> <term>-p port</term> <listitem><para> - Port on the target server to connect to. + Port on the target server to connect to (usually 139 or 445). + Defaults to trying 445 first, then 139. </para></listitem> </varlistentry> - <varlistentry> - <term>-n myname</term> - <listitem><para> - Sets name of the client. - </para></listitem> - </varlistentry> - - <varlistentry> - <term>-s conffile</term> - <listitem><para> - Specify alternative configuration file that should be loaded. - </para></listitem> - </varlistentry> + &stdarg.netbios.name; + &stdarg.configfile; <varlistentry> <term>-S server</term> @@ -122,58 +143,9 @@ </varlistentry> <varlistentry> - <term>-C comment</term> - <listitem><para> - FIXME - </para></listitem> - </varlistentry> - - <varlistentry> - <term>-M maxusers</term> - <listitem><para> - FIXME - </para></listitem> - </varlistentry> - - <varlistentry> - <term>-F flags</term> - <listitem><para> - FIXME - </para></listitem> - </varlistentry> - - <varlistentry> - <term>-j jobid</term> - <listitem><para> - FIXME - </para></listitem> - </varlistentry> - - <varlistentry> <term>-l</term> <listitem><para> - FIXME - </para></listitem> - </varlistentry> - - <varlistentry> - <term>-r</term> - <listitem><para> - FIXME - </para></listitem> - </varlistentry> - - <varlistentry> - <term>-f</term> - <listitem><para> - FIXME - </para></listitem> - </varlistentry> - - <varlistentry> - <term>-t timeout</term> - <listitem><para> - FIXME + When listing data, give more information on each item. </para></listitem> </varlistentry> @@ -184,147 +156,610 @@ </para></listitem> </varlistentry> - <varlistentry> - <term>-D debuglevel</term> - <listitem><para>set the debuglevel. Debug level 0 is the lowest - and 100 being the highest. This should be set to 100 if you are - planning on submitting a bug report to the Samba team (see - <filename>BUGS.txt</filename>). - </para></listitem> - </varlistentry> + &stdarg.debug; </variablelist> </refsect1> - <refsect1> +<title>COMMANDS</title> + +<refsect2> <title>TIME</title> <para>The <command>NET TIME</command> command allows you to view the time on a remote server or synchronise the time on the local server with the time on the remote server.</para> - <variablelist> - <varlistentry> - <term></term> - <listitem><para> - Without any options, the <command>NET TIME</command> command - displays the time on the remote server. - </para></listitem> - </varlistentry> +<refsect3> +<title>TIME</title> - <varlistentry> - <term>SYSTEM</term> - <listitem><para> - Displays the time on the remote server in a format ready for <command>/bin/date</command> - </para></listitem> - </varlistentry> +<para>Without any options, the <command>NET TIME</command> command +displays the time on the remote server. +</para> - <varlistentry> - <term>SET</term> - <listitem><para> - Tries to set the date and time of the local server to that on - the remote server using <command>/bin/date</command>. - </para></listitem> - </varlistentry> +</refsect3> - <varlistentry> - <term>ZONE</term> - <listitem><para> - Displays the timezone in hours from GMT on the remote computer. - </para></listitem> - </varlistentry> - </variablelist> -</refsect1> +<refsect3> +<title>TIME SYSTEM</title> -<refsect1> - <title>RPC</title> +<para> Displays the time on the remote server in a format ready for <command>/bin/date</command></para> - <para>The <command>NET RPC</command> command allows you to do various - NT4 operations.</para> +</refsect3> - <variablelist> - <varlistentry> - <term>JOIN -U username[%password] [options]</term> - <listitem><para> - Join a domain with specified username and password. Password - will be prompted if none is specified.</para> - </listitem> - </varlistentry> +<refsect3> +<title>TIME SET</title> +<para>Tries to set the date and time of the local server to that on +the remote server using <command>/bin/date</command>. </para> - <varlistentry> - <term>JOIN [options except -U]</term> - <listitem><para> - to join a domain created in server manager - </para></listitem> - </varlistentry> +</refsect3> - <varlistentry> - <term>USER [misc. options] [targets]</term> - <listitem><para> - List users - </para></listitem> - </varlistentry> +<refsect3> +<title>TIME ZONE</title> - <varlistentry> - <term>USER DELETE <name> [misc options]</term> - <listitem><para> - delete specified user - </para></listitem> - </varlistentry> +<para>Displays the timezone in hours from GMT on the remote computer.</para> - <varlistentry> - <term>USER INFO <name> [misc options]</term> - <listitem><para> - list the domain groups of the specified user - </para></listitem> - </varlistentry> +</refsect3> +</refsect2> - <varlistentry> - <term>USER ADD <name> [password] [-F user flags] [misc. options]</term> - <listitem><para> - Add specified user - </para></listitem> - </varlistentry> +<refsect2> +<title>[RPC|ADS] JOIN [OLDSTYLE] [-U username[%password]] [options]</title> - <varlistentry> - <term>GROUP [misc options] [targets]</term> - <listitem><para> - List user groups - </para></listitem> - </varlistentry> +<para> +Join a domain with specified username and password. Password +will be prompted if none is specified. If no +user name is specified, a domain created in server manager +can be joined. +</para> - <varlistentry> - <term>GROUP DELETE <name> [misc. options] [targets]</term> - <listitem><para> - Delete specified group - </para></listitem> - </varlistentry> +<para>Specify [OLDSTYLE] to join the domain using the old +style of domain joining - you need to create a trust +account in server manager first.</para> +</refsect2> + +<refsect2> +<title>[RPC|ADS] USER</title> - <varlistentry> - <term>GROUP ADD <name> [-C comment]</term> - <listitem><para> - Create specified group - </para></listitem> - </varlistentry> +<refsect3> +<title>[RPC|ADS] USER DELETE <replaceable>target</replaceable></title> - <varlistentry> - <term>SHARE [misc. options] [targets]</term> - <listitem><para> - enumerates all exported resources (network shares) on target server - </para></listitem> - </varlistentry> +<para>Delete specified user</para> - <varlistentry> - <term>SHARE ADD <name=serverpath> [misc. options] [targets]</term> - <listitem><para> - Adds a share from a server (makes the export active) - </para></listitem> - </varlistentry> +</refsect3> + +<refsect3> +<title>[RPC|ADS] USER LIST</title> + +<para>List all users</para> + +</refsect3> + +<refsect3> +<title>[RPC|ADS] USER INFO <replaceable>target</replaceable></title> + +<para>List the domain groups of a the specified user.</para> + +</refsect3> + +<refsect3> +<title>[RPC|ADS] USER ADD <replaceable>name</replaceable> [password] [-F user flags] [-C comment]</title> + +<para>Add specified user.</para> +</refsect3> +</refsect2> + +<refsect2> +<title>[RPC|ADS] GROUP</title> + +<refsect3> +<title>[RPC|ADS] GROUP [misc options] [targets]</title> +<para>List user groups.</para> +</refsect3> + +<refsect3> +<title>[RPC|ADS] GROUP DELETE <replaceable>name</replaceable> [misc. options]</title> + +<para>Delete specified group.</para> + +</refsect3> + +<refsect3> +<title>[RPC|ADS] GROUP ADD <replaceable>name</replaceable> [-C comment]</title> + +<para>Create specified group.</para> + +</refsect3> +</refsect2> + +<refsect2> +<title>[RAP|RPC] SHARE</title> + +<refsect3> +<title>[RAP|RPC] SHARE [misc. options] [targets]</title> + +<para>Enumerates all exported resources (network shares) on target server.</para> + +</refsect3> + +<refsect3> +<title>[RAP|RPC] SHARE ADD <replaceable>name=serverpath</replaceable> [-C comment] [-M maxusers] [targets]</title> + +<para>Adds a share from a server (makes the export active). Maxusers +specifies the number of users that can be connected to the +share simultaneously.</para> + +</refsect3> + +<refsect3> +<title>SHARE DELETE <replaceable>sharenam</replaceable></title> + +<para>Delete specified share.</para> +</refsect3> +</refsect2> + +<refsect2> +<title>[RPC|RAP] FILE</title> + +<refsect3> +<title>[RPC|RAP] FILE</title> + +<para>List all open files on remote server.</para> + +</refsect3> + +<refsect3> +<title>[RPC|RAP] FILE CLOSE <replaceable>fileid</replaceable></title> + +<para>Close file with specified <replaceable>fileid</replaceable> on +remote server.</para> + +</refsect3> + +<refsect3> +<title>[RPC|RAP] FILE INFO <replaceable>fileid</replaceable></title> + +<para> +Print information on specified <replaceable>fileid</replaceable>. +Currently listed are: file-id, username, locks, path, permissions. +</para> + +</refsect3> + +<refsect3> +<title>[RAP|RPC] FILE USER</title> + +¬.implemented; + +</refsect3> + +</refsect2> + +<refsect2> +<title>SESSION</title> + +<refsect3> +<title>RAP SESSION</title> + +<para>Without any other options, SESSION enumerates all active SMB/CIFS +sessions on the target server.</para> + +</refsect3> + +<refsect3> +<title>RAP SESSION DELETE|CLOSE <replaceable>CLIENT_NAME</replaceable></title> + +<para>Close the specified sessions.</para> + +</refsect3> + +<refsect3> +<title>RAP SESSION INFO <replaceable>CLIENT_NAME</replaceable></title> + +<para>Give a list with all the open files in specified session.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>RAP SERVER <replaceable>DOMAIN</replaceable></title> + +<para>List all servers in specified domain or workgroup. Defaults +to local domain.</para> + +</refsect2> + +<refsect2> +<title>RAP DOMAIN</title> + +<para>Lists all domains and workgroups visible on the +current network.</para> + +</refsect2> + +<refsect2> +<title>RAP PRINTQ</title> + +<refsect3> +<title>RAP PRINTQ LIST <replaceable>QUEUE_NAME</replaceable></title> + +<para>Lists the specified print queue and print jobs on the server. +If the <replaceable>QUEUE_NAME</replaceable> is omitted, all +queues are listed.</para> + +</refsect3> + +<refsect3> +<title>RAP PRINTQ DELETE <replaceable>JOBID</replaceable></title> + +<para>Delete job with specified id.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>RAP VALIDATE <replaceable>user</replaceable> [<replaceable>password</replaceable>]</title> + +<para> +Validate whether the specified user can log in to the +remote server. If the password is not specified on the commandline, it +will be prompted. +</para> + +¬.implemented; + +</refsect2> + +<refsect2> +<title>RAP GROUPMEMBER</title> + +<refsect3> +<title>RAP GROUPMEMBER LIST <replaceable>GROUP</replaceable></title> + +<para>List all members of the specified group.</para> + +</refsect3> + +<refsect3> +<title>RAP GROUPMEMBER DELETE <replaceable>GROUP</replaceable> <replaceable>USER</replaceable></title> + +<para>Delete member from group.</para> + +</refsect3> + +<refsect3> +<title>RAP GROUPMEMBER ADD <replaceable>GROUP</replaceable> <replaceable>USER</replaceable></title> + +<para>Add member to group.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>RAP ADMIN <replaceable>command</replaceable></title> + +<para>Execute the specified <replaceable>command</replaceable> on +the remote server. Only works with OS/2 servers. +</para> + +¬.implemented; + +</refsect2> + +<refsect2> +<title>RAP SERVICE</title> + +<refsect3> +<title>RAP SERVICE START <replaceable>NAME</replaceable> [arguments...]</title> + +<para>Start the specified service on the remote server. Not implemented yet.</para> + +¬.implemented; + +</refsect3> + +<refsect3> +<title>RAP SERVICE STOP</title> + +<para>Stop the specified service on the remote server.</para> + +¬.implemented; + +</refsect3> + +</refsect2> + +<refsect2> +<title>RAP PASSWORD <replaceable>USER</replaceable> <replaceable>OLDPASS</replaceable> <replaceable>NEWPASS</replaceable></title> + +<para> +Change password of <replaceable>USER</replaceable> from <replaceable>OLDPASS</replaceable> to <replaceable>NEWPASS</replaceable>. +</para> + +</refsect2> + +<refsect2> +<title>LOOKUP</title> + +<refsect3> +<title>LOOKUP HOST <replaceable>HOSTNAME</replaceable> [<replaceable>TYPE</replaceable>]</title> + +<para> +Lookup the IP address of the given host with the specified type (netbios suffix). +The type defaults to 0x20 (workstation). +</para> + +</refsect3> + +<refsect3> +<title>LOOKUP LDAP [<replaceable>DOMAIN</replaceable></title> + +<para>Give IP address of LDAP server of specified <replaceable>DOMAIN</replaceable>. Defaults to local domain.</para> + +</refsect3> + +<refsect3> +<title>LOOKUP KDC [<replaceable>REALM</replaceable>]</title> + +<para>Give IP address of KDC for the specified <replaceable>REALM</replaceable>. +Defaults to local realm.</para> + +</refsect3> + +<refsect3> +<title>LOOKUP DC [<replaceable>DOMAIN</replaceable>]</title> + +<para>Give IP's of Domain Controllers for specified <replaceable> +DOMAIN</replaceable>. Defaults to local domain.</para> + +</refsect3> + +<refsect3> +<title>LOOKUP MASTER <replaceable>DOMAIN</replaceable></title> + +<para>Give IP of master browser for specified <replaceable>DOMAIN</replaceable> +or workgroup. Defaults to local domain.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>CACHE</title> + +<para>Interface to samba's internal gencache functions. For debugging +purposes only.</para> + +<!--FIXME--> + +</refsect2> + +<refsect2> +<title>GETLOCALSID [DOMAIN]</title> + +<para>Print the SID of the specified domain, or if the parameter is +omitted, the SID of the domain the local server is in.</para> + +</refsect2> + +<refsect2> +<title>SETLOCALSID S-1-5-21-x-y-z</title> + +<para>Sets domain sid for the local server to the specified SID.</para> + +</refsect2> + +<refsect2> +<title>MAXRID</title> + +<para>Prints out the highest RID currently in use on the local +server (by the active 'passdb backend'). +</para> + +</refsect2> + +<refsect2> +<title>RPC INFO</title> + +<para>Print information about the domain of the remote server, +such as domain name, domain sid and number of users and groups. +</para> + +</refsect2> + +<refsect2> +<title>[RPC|ADS] TESTJOIN</title> + +<para>Check whether participation in a domain is still valid.</para> + +</refsect2> + +<refsect2> +<title>[RPC|ADS] CHANGETRUSTPW</title> + +<para>Force change of domain trust password.</para> + +</refsect2> + +<refsect2> +<title>RPC TRUSTDOM</title> + +<refsect3> +<title>RPC TRUSTDOM ADD <replaceable>DOMAIN</replaceable></title> + +<para>Add a interdomain trust account for +<replaceable>DOMAIN</replaceable> to the remote server. +</para> + +</refsect3> + +<refsect3> +<title>RPC TRUSTDOM DEL <replaceable>DOMAIM</replaceable></title> + +<para>Remove interdomain trust account for +<replaceable>DOMAIN</replaceable> from the remote server. +</para> + +¬.implemented; + +</refsect3> + +<refsect3> +<title>RPC TRUSTDOM ESTABLISH <replaceable>DOMAIN</replaceable></title> + +<para> +Establish a trust relationship to a trusting domain. +Interdomain account must already be created on the remote PDC. +</para> + +</refsect3> + +<refsect3> +<title>RPC TRUSTDOM REVOKE <replaceable>DOMAIN</replaceable></title> +<para>Abandon relationship to trusted domain</para> + +</refsect3> + +<refsect3> +<title>RPC TRUSTDOM LIST</title> + +<para>List all current interdomain trust relationships.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>RPC ABORTSHUTDOWN</title> + +<para>Abort the shutdown of a remote server.</para> + +</refsect2> + +<refsect2> +<title>SHUTDOWN [-t timeout] [-r] [-f] [-C message]</title> + +<para>Shut down the remote server.</para> + +<variablelist> +&net.arg.shutdown; +<varlistentry> +<term>-C message</term> +<listitem><para>Display the specified message on the screen to +announce the shutdown.</para></listitem> +</varlistentry> +</variablelist> + +</refsect2> + +<refsect2> +<title>SAMDUMP</title> + +<para>Print out sam database of remote server. You need +to run this on either a BDC. <!-- +Is that correct? - Jelmer --></para> +</refsect2> + +<refsect2> +<title>VAMPIRE</title> + +<para>Export users, aliases and groups from remote server to +local server. Can only be run an a BDC. +</para> + +</refsect2> + +<refsect2> +<title>GETSID</title> + +<para>Fetch domain SID and store it in the local <filename>secrets.tdb</filename>. </para> + +</refsect2> + +<refsect2> +<title>ADS LEAVE</title> + +<para>Make the remote host leave the domain it is part of. </para> + +</refsect2> + +<refsect2> +<title>ADS STATUS</title> + +<para>Print out status of machine account of the local machine in ADS. +Prints out quite some debug info. Aimed at developers, regular +users should use <command>NET ADS TESTJOIN</command>.</para> + +</refsect2> + +<refsect2> +<title>ADS PRINTER</title> + +<refsect3> +<title>ADS PRINTER INFO [<replaceable>PRINTER</replaceable>] [<replaceable>SERVER</replaceable>]</title> + +<para> +Lookup info for <replaceable>PRINTER</replaceable> on <replaceable>SERVER</replaceable>. The printer name defaults to "*", the +server name defaults to the local host.</para> + +</refsect3> + +<refsect3> +<title>ADS PRINTER PUBLISH <replaceable>PRINTER</replaceable></title> + +<para>Publish specified printer using ADS.</para> + +</refsect3> + +<refsect3> +<title>ADS PRINTER REMOVE <replaceable>PRINTER</replaceable></title> + +<para>Remove specified printer from ADS directory.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>ADS SEARCH <replaceable>EXPRESSION</replaceable> <replaceable>ATTRIBUTES...</replaceable></title> + +<para>Perform a raw LDAP search on a ADS server and dump the results. The +expression is a standard LDAP search expression, and the +attributes are a list of LDAP fields to show in the results.</para> + +<para>Example: <userinput>net ads search '(objectCategory=group)' sAMAccountName</userinput> +</para> + +</refsect2> + +<refsect2> +<title>ADS DN <replaceable>DN</replaceable> <replaceable>(attributes)</replaceable></title> + +<para> +Perform a raw LDAP search on a ADS server and dump the results. The +DN standard LDAP DN, and the attributes are a list of LDAP fields +to show in the result. +</para> + +<para>Example: <userinput>net ads dn 'CN=administrator,CN=Users,DC=my,DC=domain' SAMAccountName</userinput></para> + +</refsect2> + +<refsect2> +<title>WORKGROUP</title> + +<para>Print out workgroup name for specified kerberos realm.</para> + +</refsect2> + + +<refsect2> +<title>HELP [COMMAND]</title> + +<para>Gives usage information for the specified command.</para> + +</refsect2> - <varlistentry> - <term>SHARE DELETE <sharenam</term> - <listitem><para></para></listitem> - </varlistentry> - </variablelist> </refsect1> <refsect1> @@ -342,9 +777,7 @@ by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.</para> - <para>The original Samba man pages were written by Karl Auer. - The current set of manpages and documentation is maintained - by the Samba Team in the same fashion as the Samba source code.</para> + <para>The net manpage was written by Jelmer Vernooij.</para> </refsect1> |