From c08329983c1899f20c08d07a5e9a56478f683420 Mon Sep 17 00:00:00 2001 From: Michael Adam Date: Thu, 18 Oct 2007 12:47:49 +0000 Subject: Add documentation for the "net conf" commands to the manpage. Michael (This used to be commit 79a37e04b4c95397c7dd37e512574e4b913c0df4) --- docs/manpages-3/net.8.xml | 142 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 142 insertions(+) diff --git a/docs/manpages-3/net.8.xml b/docs/manpages-3/net.8.xml index afc79133c4..70ee5d47b7 100644 --- a/docs/manpages-3/net.8.xml +++ b/docs/manpages-3/net.8.xml @@ -1354,6 +1354,148 @@ shares created by other users. + +CONF + +Starting with version 3.2.0, a Samba server can be configured by data +stored in registry. This configuration data can be edited with the new "net +conf" commands. + + + +The deployment of this configuration data can be activated in two levels from the +smb.conf file: Share definitions from registry are +activated by setting registry shares to +yes in the [global] section and global configuration options are +activated by setting registry in +the [global] section. +See the smb.conf +5 manpage for details. + + +The conf commands are: + +net conf list - Dump the complete configuration in smb.conf like +format. +net conf import - Import configuration from file in smb.conf +format. +net conf listshares - List the registry shares. +net conf drop - Delete the complete configuration from +registry. +net conf showshare - Show the definition of a registry share. +net conf addshare - Create a new registry share. +net conf delshare - Delete a registry share. +net conf setparm - Store a parameter. +net conf getparm - Retrieve the value of a parameter. +net conf delparm - Delete a parameter. + + + + +CONF LIST + + +Print the configuration data stored in the registry in a smb.conf-like format to +standard output. + + + + +CONF IMPORT <replaceable>[--test|-T]</replaceable> <replaceable>filename</replaceable> <replaceable>[section]</replaceable> + + +This command imports configuration from a file in smb.conf format. +If a section encountered in the input file is present in registry, +its contents is replaced. Sections of registry configuration that have +no counterpart in the input file are not affected. If you want to delete these, +you will have to use the "net conf drop" or "net conf delshare" commands. +Optionally, a section may be specified to restrict the effect of the +import command to that specific section. A test mode is enabled by specifying +the parameter "-T" on the commandline. In test mode, no changes are made to the +registry, and the resulting configuration is printed to standard output instead. + + + + +CONF LISTSHARES + + +List the names of the shares defined in registry. + + + + +CONF DROP + + +Delete the complete configuration data from registry. + + + + +CONF SHOWSHARE <replaceable>sharename</replaceable> + + +Show the definition of the share or section specified. It is valid to specify +"global" as sharename to retrieve the global configuration options from +registry. + + + + +CONF ADDSHARE <replaceable>sharename</replaceable> <replaceable>path</replaceable> [<replaceable>writeable={y|N}</replaceable> [<replaceable>guest_ok={y|N}</replaceable> [<replaceable>comment</replaceable>]]] + +Create a new share definition in registry. +The sharename and path have to be given. The share name may +not be "global". Optionally, values for the very +common options "writeable", "guest ok" and a "comment" may be specified. +The same result may be obtained by a sequence of "net conf setparm" +commands. + + + + +CONF DELSHARE <replaceable>sharename</replaceable> + + +Delete a share definition from registry. + + + + +CONF SETPARM <replaceable>section</replaceable> <replaceable>parameter</replaceable> <replaceable>value</replaceable> + + +Store a parameter in registry. The section may be global or a sharename. +The section is created if it does not exist yet. + + + + +CONF GETPARM <replaceable>section</replaceable> <replaceable>parameter</replaceable> + + +Show a parameter stored in registry. + + + + +CONF DELPARM <replaceable>section</replaceable> <replaceable>parameter</replaceable> + + +Delete a parameter stored in registry. + + + + + + + + + + + + HELP [COMMAND] -- cgit