Skip to content

Commit

Permalink
docs: Add man samba-regedit.8.
Browse files Browse the repository at this point in the history
Fix bug #10001 - Man page for samba-regedit tool missing.

Signed-off-by: Karolin Seeger <[email protected]>
Signed-off-by: Björn Jacke <[email protected]>

Autobuild-User(master): Björn Jacke <[email protected]>
Autobuild-Date(master): Thu Aug 29 03:15:51 CEST 2013 on sn-devel-104
  • Loading branch information
kseeger authored and Bjoern Jacke committed Aug 29, 2013
1 parent 6e3650e commit 4dd1523
Show file tree
Hide file tree
Showing 2 changed files with 122 additions and 0 deletions.
121 changes: 121 additions & 0 deletions docs-xml/manpages/samba-regedit.8.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="samba-regedit.8">

<refmeta>
<refentrytitle>samba-regedit</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="source">Samba</refmiscinfo>
<refmiscinfo class="manual">System Administration tools</refmiscinfo>
<refmiscinfo class="version">4.1</refmiscinfo>
</refmeta>


<refnamediv>
<refname>samba-regedit</refname>
<refpurpose>ncurses based tool to manage the Samba registry</refpurpose>
</refnamediv>

<refsynopsisdiv>
<cmdsynopsis>
<command>samba-regedit</command>
<arg choice="opt">--help</arg>
<arg choice="opt">--usage</arg>
<arg choice="opt">-d &lt;debug level&gt;</arg>
<arg choice="opt">-s &lt;configuration file&gt;</arg>
<arg choice="opt">-l &lt;log directory&gt;</arg>
<arg choice="opt">-V</arg>
<arg choice="opt">--option=&lt;parameter&gt;=&lt;value&gt;</arg>
<arg choice="opt">--socket-options=&lt;SOCKETOPTIONS&gt;</arg>
<arg choice="opt">--netbiosname=&lt;NETBIOSNAME&gt;</arg>
<arg choice="opt">--workgroup=&lt;WORKGROUP&gt;</arg>
<arg choice="opt">--scope=&lt;SCOPE&gt;</arg>
<arg choice="opt">--user=&lt;USERNAME&gt;</arg>
<arg choice="opt">-N</arg>
<arg choice="opt">-k</arg>
<arg choice="opt">--authentication-file=&lt;FILE&gt;</arg>
<arg choice="opt">--signing=[on|off|required]</arg>
<arg choice="opt">-P</arg>
<arg choice="opt">-e</arg>
<arg choice="opt">-C</arg>
<arg choice="opt">--pw-nt-hash</arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
<title>DESCRIPTION</title>

<para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><command>samba-regedit</command> is a ncurses based tool to manage the Samba
registry. It can be used to show/edit registry keys/subkeys and
their values.</para>
</refsect1>

<refsect1>
<title>OPTIONS</title>
<variablelist>
&stdarg.help;
<varlistentry>
<term>--usage</term>
<listitem><para>Display brief usage message.</para></listitem>
</varlistentry>
<varlistentry>
<term>-d|--debuglevel=&lt;debuglevel&gt;</term>
<listitem><para>Set debug level.</para></listitem>
</varlistentry>
&popt.common.samba;
<varlistentry>
<term>--option=&lt;parameter&gt;=&lt;value&gt;</term>
<listitem><para>Set smb.conf option from command line.</para></listitem>
</varlistentry>
&popt.common.connection;
<varlistentry>
<term>-S|--signing</term>
<listitem><para>Set the client signing state.</para></listitem>
</varlistentry>
<varlistentry>
<term>-P|--machine-pass</term>
<listitem><para>Use stored machine account password.</para></listitem>
</varlistentry>
&popt.common.credentials;
<varlistentry>
<term>-e|--encrypt</term>
<listitem><para>Encrypt SMB transport (UNIX extended servers only).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>--pw-nt-hash</term>
<listitem><para>The supplied password is the NT hash.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>


<refsect1>
<title>VERSION</title>

<para>This man page is correct for version 4 of the Samba suite.</para>
</refsect1>

<refsect1>
<title>SEE ALSO</title>
<para><citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> and <citerefentry><refentrytitle>net</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>.</para>
</refsect1>

<refsect1>
<title>AUTHOR</title>

<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>

<para>The samba-regedit man page was written by Karolin Seeger.</para>
</refsect1>

</refentry>
1 change: 1 addition & 0 deletions docs-xml/wscript_build
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ manpages='''
manpages/samba.7
manpages/samba.8
manpages/samba-tool.8
manpages/samba-regedit.8
manpages/sharesec.1
manpages/smbcacls.1
manpages/smbclient.1
Expand Down

0 comments on commit 4dd1523

Please sign in to comment.