source4/lib/registry/man/regshell.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="regshell.1">
   4
   5 <refmeta>
   6         <refentrytitle>regshell</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>regshell</refname>
  16         <refpurpose>Windows registry file browser using readline</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21                 <command>regshell</command>
  22                 <arg choice="opt">--help</arg>
  23                 <arg choice="opt">--backend=BACKEND</arg>
  24                 <arg choice="opt">--credentials=CREDENTIALS</arg>
  25                 <arg choice="opt">location</arg>
  26         </cmdsynopsis>
  27 </refsynopsisdiv>
  28
  29 <refsect1>
  30         <title>DESCRIPTION</title>
  31
  32         <para>
  33                 regshell is a utility that lets you browse thru a Windows registry
  34                 file as if you were using a regular unix shell to browse thru a
  35                 file system.
  36         </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         </variablelist>
  64 </refsect1>
  65
  66 <refsect1>
  67         <title>COMMANDS</title>
  68
  69         <variablelist>
  70                 <varlistentry>
  71                         <term>ck|cd &lt;keyname&gt;</term>
  72                         <listitem><para>
  73                         Go to the specified subkey.
  74                         </para></listitem>
  75                 </varlistentry>
  76
  77                 <varlistentry>
  78                         <term>ch|predef [predefined-key-name]</term>
  79                         <listitem><para>
  80                                         Go to the specified predefined key.
  81                         </para></listitem>
  82                 </varlistentry>
  83
  84                 <varlistentry>
  85                         <term>list|ls</term>
  86                         <listitem><para>
  87                                         List subkeys and values of the current key.
  88                         </para></listitem>
  89                 </varlistentry>
  90
  91                 <varlistentry>
  92                         <term>mkkey|mkdir &lt;keyname&gt;</term>
  93                         <listitem><para>
  94                                         Create a key with the specified <replaceable>keyname</replaceable> as a subkey of the current key.
  95                         </para></listitem>
  96                 </varlistentry>
  97
  98                 <varlistentry>
  99                         <term>rmval|rm &lt;valname&gt;</term>
 100                         <listitem><para>
 101                                         Delete the specified value.
 102                         </para></listitem>
 103                 </varlistentry>
 104
 105                 <varlistentry>
 106                         <term>rmkey|rmdir &lt;keyname&gt;</term>
 107                         <listitem><para>
 108                         Delete the specified subkey recursively.
 109                         </para></listitem>
 110                 </varlistentry>
 111
 112                 <varlistentry>
 113                         <term>pwd|pwk</term>
 114                         <listitem><para>Print the full name of the current key.</para></listitem>
 115                 </varlistentry>
 116
 117                 <varlistentry>
 118                         <term>set|update</term>
 119                         <listitem><para>Update the value of a key value. Not implemented at the moment.</para></listitem>
 120                 </varlistentry>
 121
 122                 <varlistentry>
 123                         <term>help|?</term>
 124                         <listitem><para>Print a list of available commands.</para></listitem>
 125                 </varlistentry>
 126                 <varlistentry>
 127                         <term>exit|quit</term>
 128                         <listitem><para>Leave regshell.</para></listitem>
 129                 </varlistentry>
 130         </variablelist>
 131 </refsect1>
 132
 133 <refsect1>
 134         <title>EXAMPLES</title>
 135
 136         <para>Browsing thru a nt4 registry file</para>
 137         <screen>
 138 <userinput>regshell -b nt4 NTUSER.DAT</userinput>
 139 $$$PROTO.HIV> <userinput>ls</userinput>
 140 K AppEvents
 141 K Console
 142 K Control Panel
 143 K Environment
 144 K Identities
 145 K Keyboard Layout
 146 K Network
 147 K Printers
 148 K Software
 149 K UNICODE Program Groups
 150 K Windows 3.1 Migration Status
 151 $$$PROTO.HIV> <userinput>exit</userinput>
 152 </screen>
 153
 154 <para>Listing the subkeys of HKEY_CURRENT_USER\AppEvents on a remote computer:</para>
 155 <screen>
 156 <userinput>regshell --remote=ncacn_np:aurelia -c "jelmer%secret"</userinput>
 157 HKEY_CURRENT_MACHINE> <userinput>predef HKEY_CURRENT_USER</userinput>
 158 HKEY_CURRENT_USER> <userinput>cd AppEvents</userinput>
 159 Current path is: HKEY_CURRENT_USER\AppEvents
 160 HKEY_CURRENT_USER\AppEvents> <userinput>ls</userinput>
 161 K EventLabels
 162 K Schemes
 163 HKEY_CURRENT_USER\AppEvents> <userinput>exit</userinput>
 164 </screen>
 165 </refsect1>
 166
 167 <refsect1>
 168         <title>VERSION</title>
 169
 170         <para>This man page is correct for version 4.0 of the Samba suite.</para>
 171 </refsect1>
 172
 173 <refsect1>
 174         <title>SEE ALSO</title>
 175
 176         <para>regtree, regdiff, regpatch, gregedit, samba</para>
 177
 178 </refsect1>
 179
 180 <refsect1>
 181         <title>AUTHOR</title>
 182
 183         <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>
 184
 185         <para>This manpage and regshell were written by Jelmer Vernooij. </para>
 186
 187 </refsect1>
 188
 189 </refentry>