Add basic documentation on editreg
authorJelmer Vernooij <jelmer@samba.org>
Mon, 31 Mar 2003 21:01:05 +0000 (21:01 +0000)
committerJelmer Vernooij <jelmer@samba.org>
Mon, 31 Mar 2003 21:01:05 +0000 (21:01 +0000)
(This used to be commit 137254a16cf48a37be53477713dd41af7a81f505)

docs/docbook/Makefile.in
docs/docbook/manpages/editreg.1.sgml [new file with mode: 0644]
docs/docbook/manpages/profiles.1.sgml

index 94987ff3a2c525b08561dce97185542b225a8167..dae5b81e7122953f6a73cd8909304b885195258b 100644 (file)
@@ -22,7 +22,8 @@ MANPAGES_NAMES=findsmb.1 smbclient.1 \
        smb.conf.5 wbinfo.1 pdbedit.8 \
        smbcacls.1 smbsh.1 winbindd.8 \
        smbgroupedit.8 vfstest.1 \
        smb.conf.5 wbinfo.1 pdbedit.8 \
        smbcacls.1 smbsh.1 winbindd.8 \
        smbgroupedit.8 vfstest.1 \
-       profiles.1 smbtree.1 ntlm_auth.1
+       profiles.1 smbtree.1 ntlm_auth.1 \
+       editreg.1
 
 ## This part contains only rules. You shouldn't need to change it 
 ## if you are adding docs
 
 ## This part contains only rules. You shouldn't need to change it 
 ## if you are adding docs
diff --git a/docs/docbook/manpages/editreg.1.sgml b/docs/docbook/manpages/editreg.1.sgml
new file mode 100644 (file)
index 0000000..22c3c3e
--- /dev/null
@@ -0,0 +1,85 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
+]>
+<refentry id="editreg.1">
+
+<refmeta>
+       <refentrytitle>editreg</refentrytitle>
+       <manvolnum>1</manvolnum>
+</refmeta>
+
+
+<refnamediv>
+       <refname>editreg</refname>
+       <refpurpose>A utility to report and change SIDs in registry files
+       </refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+       <cmdsynopsis>
+               <command>editreg</command>
+               <arg choice="opt">-v</arg>
+               <arg choice="opt">-c file</arg>
+               <arg choice="req">file</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>editreg</command> is a utility that 
+       can visualize windows registry files (currently only NT4) and apply 
+       so-called commandfiles to them. 
+       </para>
+</refsect1>
+
+
+<refsect1>
+       <title>OPTIONS</title>
+
+       <variablelist>
+               <varlistentry>
+               <term>registry_file</term>
+               <listitem><para>Registry file to view or edit.  </para></listitem>
+               </varlistentry>
+
+
+               <varlistentry>
+               <term>-v,--verbose</term>
+               <listitem><para>Increases verbosity of messages. 
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>-c commandfile</term>
+               <listitem><para>Read commands to execute on <filename>registry_file</filename> from <filename>commandfile</filename>. Currently not yet supported!
+               </para></listitem>
+               </varlistentry>
+
+               &stdarg.help;
+               
+       </variablelist>
+</refsect1>
+
+<refsect1>
+       <title>VERSION</title>
+
+       <para>This man page is correct for version 3.0 of the Samba 
+       suite.</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 editreg man page was written by Jelmer Vernooij. </para>
+</refsect1>
+
+</refentry>
index 6ec8055c288ce542dfa20bf78565b8ce948a6e47..6fd2b6fd86abc59ca1d653877e660111504b0c34 100644 (file)
@@ -54,9 +54,6 @@
                </para></listitem>
                </varlistentry>
 
                </para></listitem>
                </varlistentry>
 
-               &stdarg.help;
-
-
                <varlistentry>
                <term>-c SID1 -n SID2</term>
                <listitem><para>Change all occurences of SID1 in <filename>file</filename> by SID2.
                <varlistentry>
                <term>-c SID1 -n SID2</term>
                <listitem><para>Change all occurences of SID1 in <filename>file</filename> by SID2.