source/lib/registry/man/regshell.1.xml

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