docs: man regtree: Add missing meta data.
[kai/samba.git] / source4 / lib / registry / man / regtree.1.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
3 <refentry id="regtree.1">
4
5 <refmeta>
6         <refentrytitle>regtree</refentrytitle>
7         <manvolnum>1</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">4.0</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>regtree</refname>
16         <refpurpose>Text-mode registry viewer</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>regtree</command>
22                 <arg choice="opt">--help</arg>
23                 <arg choice="opt">--backend=BACKEND</arg>
24                 <arg choice="opt">--fullpath</arg>
25                 <arg choice="opt">--no-values</arg>
26                 <arg choice="opt">--credentials=CREDENTIALS</arg>
27                 <arg choice="opt">location</arg>
28         </cmdsynopsis>
29 </refsynopsisdiv>
30
31 <refsect1>
32         <title>DESCRIPTION</title>
33
34         <para>The regtree utility prints out all the contents of a 
35                 Windows registry file. Subkeys are printed with one level 
36                 more indentation than their parents. </para>
37
38 </refsect1>
39
40
41 <refsect1>
42         <title>OPTIONS</title>
43
44         <variablelist>
45                 <varlistentry>
46                 <term>--help</term>
47                 <listitem><para>
48                 Show list of available options.</para></listitem>
49                 </varlistentry>
50                 
51                 <varlistentry>
52                         <term>--backend BACKEND</term>
53                         <listitem><para>Name of backend to load. Possible values are: 
54                                         creg, regf, dir and rpc. The default is <emphasis>dir</emphasis>.
55                 </para></listitem>
56                 </varlistentry>
57                 
58                 <varlistentry>
59                 <term>--credentials=CREDENTIALS</term>
60                 <listitem><para>
61                                 Credentials to use, if any. Password should be separated from user name by a percent sign.</para></listitem>
62                 </varlistentry>
63
64                 <varlistentry>
65                         <term>--fullpath</term>
66                         <listitem><para>
67                                         Print the full path to each key instead of only its name.
68                                 </para>
69                         </listitem>
70                 </varlistentry>
71
72                 <varlistentry><term>--no-values</term>
73                         <listitem><para>Don't print values, just keys.</para></listitem>
74                 </varlistentry>
75         </variablelist>
76         
77 </refsect1>
78
79 <refsect1>
80         <title>VERSION</title>
81
82         <para>This man page is correct for version 4.0 of the Samba suite.</para>
83 </refsect1>
84
85 <refsect1>
86         <title>SEE ALSO</title>
87
88         <para>gregedit, regshell, regdiff, regpatch, samba</para>
89
90 </refsect1>
91
92 <refsect1>
93         <title>AUTHOR</title>
94
95         <para>This utility is part of the <ulink url="http://www.samba.org/">Samba</ulink> suite, which is developed by the global <ulink url="http://www.samba.org/samba/team/">Samba Team</ulink>.</para>
96         
97         <para>This manpage and regtree were written by Jelmer Vernooij. </para>
98         
99 </refsect1>
100
101 </refentry>