docs: Add man samba-regedit.8.
[Samba.git] / docs-xml / manpages / samba-regedit.8.xml
blobe7ec7616ab8cc333237ffb299b66e84749ab16b8
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="samba-regedit.8">
5 <refmeta>
6         <refentrytitle>samba-regedit</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">4.1</refmiscinfo>
11 </refmeta>
14 <refnamediv>
15         <refname>samba-regedit</refname>
16         <refpurpose>ncurses based tool to manage the Samba registry</refpurpose>
17 </refnamediv>
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>samba-regedit</command>
22                 <arg choice="opt">--help</arg>
23                 <arg choice="opt">--usage</arg>
24                 <arg choice="opt">-d &lt;debug level&gt;</arg>
25                 <arg choice="opt">-s &lt;configuration file&gt;</arg>
26                 <arg choice="opt">-l &lt;log directory&gt;</arg>
27                 <arg choice="opt">-V</arg>
28                 <arg choice="opt">--option=&lt;parameter&gt;=&lt;value&gt;</arg>
29                 <arg choice="opt">--socket-options=&lt;SOCKETOPTIONS&gt;</arg>
30                 <arg choice="opt">--netbiosname=&lt;NETBIOSNAME&gt;</arg>
31                 <arg choice="opt">--workgroup=&lt;WORKGROUP&gt;</arg>
32                 <arg choice="opt">--scope=&lt;SCOPE&gt;</arg>
33                 <arg choice="opt">--user=&lt;USERNAME&gt;</arg>
34                 <arg choice="opt">-N</arg>
35                 <arg choice="opt">-k</arg>
36                 <arg choice="opt">--authentication-file=&lt;FILE&gt;</arg>
37                 <arg choice="opt">--signing=[on|off|required]</arg>
38                 <arg choice="opt">-P</arg>
39                 <arg choice="opt">-e</arg>
40                 <arg choice="opt">-C</arg>
41                 <arg choice="opt">--pw-nt-hash</arg>
42         </cmdsynopsis>
43 </refsynopsisdiv>
45 <refsect1>
46         <title>DESCRIPTION</title>
48         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
49         <manvolnum>7</manvolnum></citerefentry> suite.</para>
50         <para><command>samba-regedit</command> is a ncurses based tool to manage the Samba
51         registry. It can be used to show/edit registry keys/subkeys and
52         their values.</para>
53 </refsect1>
55 <refsect1>
56         <title>OPTIONS</title>
57         <variablelist>
58                 &stdarg.help;
59                 <varlistentry>
60                 <term>--usage</term>
61                 <listitem><para>Display brief usage message.</para></listitem>
62                 </varlistentry>
63                 <varlistentry>
64                 <term>-d|--debuglevel=&lt;debuglevel&gt;</term>
65                 <listitem><para>Set debug level.</para></listitem>
66                 </varlistentry>
67                 &popt.common.samba;
68                 <varlistentry>
69                 <term>--option=&lt;parameter&gt;=&lt;value&gt;</term>
70                 <listitem><para>Set smb.conf option from command line.</para></listitem>
71                 </varlistentry>
72                 &popt.common.connection;
73                 <varlistentry>
74                 <term>-S|--signing</term>
75                 <listitem><para>Set the client signing state.</para></listitem>
76                 </varlistentry>
77                 <varlistentry>
78                 <term>-P|--machine-pass</term>
79                 <listitem><para>Use stored machine account password.</para></listitem>
80                 </varlistentry>
81                 &popt.common.credentials;
82                 <varlistentry>
83                 <term>-e|--encrypt</term>
84                 <listitem><para>Encrypt SMB transport (UNIX extended servers only).</para>
85                 </listitem>
86                 </varlistentry>
87                 <varlistentry>
88                 <term>--pw-nt-hash</term>
89                 <listitem><para>The supplied password is the NT hash.</para>
90                 </listitem>
91                 </varlistentry>
92         </variablelist>
93 </refsect1>
96 <refsect1>
97         <title>VERSION</title>
99         <para>This man page is correct for version 4 of the Samba suite.</para>
100 </refsect1>
102 <refsect1>
103         <title>SEE ALSO</title>
104         <para><citerefentry><refentrytitle>smbd</refentrytitle>
105         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba</refentrytitle>
106         <manvolnum>7</manvolnum></citerefentry> and <citerefentry><refentrytitle>net</refentrytitle>
107         <manvolnum>8</manvolnum></citerefentry>.</para>
108 </refsect1>
110 <refsect1>
111         <title>AUTHOR</title>
113         <para>The original Samba software and related utilities
114         were created by Andrew Tridgell. Samba is now developed
115         by the Samba Team as an Open Source project similar
116         to the way the Linux kernel is developed.</para>
118         <para>The samba-regedit man page was written by Karolin Seeger.</para>
119 </refsect1>
121 </refentry>