From dde05bc78735a111e814ab5ece9e79af4555153b Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Mon, 30 May 2005 15:11:10 +0000 Subject: r7113: Move manpages from docs repository to source repository (This used to be commit f16d346032b9052c9dcd6b15cf65dd62e6943cd3) --- source4/lib/com/README | 9 ++ source4/lib/ldb/man/man1/ldbadd.1.xml | 99 ++++++++++++++++ source4/lib/ldb/man/man1/ldbdel.1.xml | 97 ++++++++++++++++ source4/lib/ldb/man/man1/ldbedit.1.xml | 125 ++++++++++++++++++++ source4/lib/ldb/man/man1/ldbmodify.1.xml | 87 ++++++++++++++ source4/lib/ldb/man/man1/ldbrename.1.xml | 101 +++++++++++++++++ source4/lib/ldb/man/man1/ldbsearch.1.xml | 113 +++++++++++++++++++ source4/lib/registry/man/regdiff.1.xml | 102 +++++++++++++++++ source4/lib/registry/man/regpatch.1.xml | 88 +++++++++++++++ source4/lib/registry/man/regshell.1.xml | 188 +++++++++++++++++++++++++++++++ source4/lib/registry/man/regtree.1.xml | 101 +++++++++++++++++ 11 files changed, 1110 insertions(+) create mode 100644 source4/lib/com/README create mode 100644 source4/lib/ldb/man/man1/ldbadd.1.xml create mode 100644 source4/lib/ldb/man/man1/ldbdel.1.xml create mode 100644 source4/lib/ldb/man/man1/ldbedit.1.xml create mode 100644 source4/lib/ldb/man/man1/ldbmodify.1.xml create mode 100644 source4/lib/ldb/man/man1/ldbrename.1.xml create mode 100644 source4/lib/ldb/man/man1/ldbsearch.1.xml create mode 100644 source4/lib/registry/man/regdiff.1.xml create mode 100644 source4/lib/registry/man/regpatch.1.xml create mode 100644 source4/lib/registry/man/regshell.1.xml create mode 100644 source4/lib/registry/man/regtree.1.xml (limited to 'source4') diff --git a/source4/lib/com/README b/source4/lib/com/README new file mode 100644 index 0000000000..361024e02c --- /dev/null +++ b/source4/lib/com/README @@ -0,0 +1,9 @@ +This directory contains Samba's very simple COM implementation. +It is by no means finished yet. + +The main aim of this implementation is for use by our DCOM implementation, +which lives in the dcom subdirectory. The local version is used mostly for +testing. + +More information on this effort can be found in the DCOM whitepaper in +the lorikeet repository. diff --git a/source4/lib/ldb/man/man1/ldbadd.1.xml b/source4/lib/ldb/man/man1/ldbadd.1.xml new file mode 100644 index 0000000000..0b3122ab32 --- /dev/null +++ b/source4/lib/ldb/man/man1/ldbadd.1.xml @@ -0,0 +1,99 @@ + + + + + + ldbadd + 1 + + + + + ldbadd + Command-line utility for adding records to an LDB + + + + + ldbadd + -h + -H LDB-URL + ldif-file1 + ldif-file2 + ... + + + + + DESCRIPTION + + ldbadd adds records to an ldb(7) database. It reads + the ldif(5) files specified on the command line and adds + the records from these files to the LDB database, which is specified + by the -H option or the LDB_URL environment variable. + + + If - is specified as a ldb file, the ldif input is read from + standard input. + + + + + + OPTIONS + + + + -h + + Show list of available options. + + + + -H <ldb-url> + + LDB URL to connect to. See ldb(7) for details. + + + + + + + + + ENVIRONMENT + + + LDB_URL + LDB URL to connect to (can be overrided by using the + -H command-line option.) + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbmodify, ldbdel, ldif(5) + + + + + AUTHOR + + &man.credits.samba; + + ldbadd was written by Andrew Tridgell. + + This manpage was written by Jelmer Vernooij. + + + + diff --git a/source4/lib/ldb/man/man1/ldbdel.1.xml b/source4/lib/ldb/man/man1/ldbdel.1.xml new file mode 100644 index 0000000000..2f98f9d427 --- /dev/null +++ b/source4/lib/ldb/man/man1/ldbdel.1.xml @@ -0,0 +1,97 @@ + + + + + + ldbdel + 1 + + + + + ldbdel + Command-line program for deleting LDB records + + + + + ldbdel + -h + -H LDB-URL + dn + ... + + + + + DESCRIPTION + + ldbdel deletes records from an ldb(7) database. + It deletes the records identified by the dn's specified + on the command-line. + + ldbdel uses either the database that is specified with + the -H option or the database specified by the LDB_URL environment + variable. + + + + + + OPTIONS + + + + -h + + Show list of available options. + + + + -H <ldb-url> + + LDB URL to connect to. See ldb(7) for details. + + + + + + + + + ENVIRONMENT + + + LDB_URL + LDB URL to connect to (can be overrided by using the + -H command-line option.) + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbmodify, ldbadd, ldif(5) + + + + + AUTHOR + + &man.credits.samba; + + ldbdel was written by Andrew Tridgell. + + This manpage was written by Jelmer Vernooij. + + + + diff --git a/source4/lib/ldb/man/man1/ldbedit.1.xml b/source4/lib/ldb/man/man1/ldbedit.1.xml new file mode 100644 index 0000000000..0b5c63a17a --- /dev/null +++ b/source4/lib/ldb/man/man1/ldbedit.1.xml @@ -0,0 +1,125 @@ + + + + + + ldbedit + 1 + + + + + ldbedit + Edit LDB databases using your favorite editor + + + + + ldbedit + -h + -s base|one|sub + -b basedn + -a + -e editor + -H LDB-URL + expression + attributes + + + + + DESCRIPTION + + ldbedit is a utility that allows you to edit LDB files using + your favorite editor. ldbedit generates an LDIF file based on + your query, allows you to edit it and then merges it back + into the LDB database. + + + + + + + OPTIONS + + + + -h + + Show list of available options. + + + + -H <ldb-url> + + LDB URL to connect to. See ldb(7) for details. + + + + + -s one|sub|base + Search scope to use. One-level, subtree or base. + + + + -a + Edit all records. + + + + -e editor + Specify the editor that should be used (overrides + the VISUAL and EDITOR environment variables). + + + + -b basedn + Specify Base DN to use. + + + + + + + + ENVIRONMENT + + + LDB_URL + LDB URL to connect to (can be overrided by using the + -H command-line option.) + + VISUAL and EDITOR + Environment variables used to determine what + editor to use. If VISUAL isn't set, EDITOR is used. + + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbmodify, ldbdel, ldif(5) + + + + + AUTHOR + + &man.credits.samba; + + ldbedit was written by Andrew Tridgell. + + This manpage was written by Jelmer Vernooij. + + + + diff --git a/source4/lib/ldb/man/man1/ldbmodify.1.xml b/source4/lib/ldb/man/man1/ldbmodify.1.xml new file mode 100644 index 0000000000..e39f74fffa --- /dev/null +++ b/source4/lib/ldb/man/man1/ldbmodify.1.xml @@ -0,0 +1,87 @@ + + + + + + ldbmodify + 1 + + + + + ldbmodify + Modify records in a LDB database + + + + + ldbmodify + -H LDB-URL + ldif-file + + + + + DESCRIPTION + + + ldbmodify changes, adds and deletes records in a LDB database. + The changes that should be made to the LDB database are read from + the specified LDIF-file. If - is specified as the filename, input is read from stdin. + + + For now, see ldapmodify(1) for details on the LDIF file format. + + + + + + OPTIONS + + + + -H <ldb-url> + + LDB URL to connect to. See ldb(7) for details. + + + + + + + ENVIRONMENT + + + LDB_URL + LDB URL to connect to (can be overrided by using the + -H command-line option.) + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbedit + + + + + AUTHOR + + &man.credits.samba; + + ldbmodify was written by Andrew Tridgell. + + This manpage was written by Jelmer Vernooij. + + + + diff --git a/source4/lib/ldb/man/man1/ldbrename.1.xml b/source4/lib/ldb/man/man1/ldbrename.1.xml new file mode 100644 index 0000000000..32456243af --- /dev/null +++ b/source4/lib/ldb/man/man1/ldbrename.1.xml @@ -0,0 +1,101 @@ + + + + + + ldbrename + 1 + + + + + ldbrename + Edit LDB databases using your favorite editor + + + + + ldbrename + -h + -o options + olddn + newdb + + + + + DESCRIPTION + + ldbrename is a utility that allows you to rename trees in + an LDB database based by DN. This utility takes + two arguments: the original + DN name of the top element and the DN to change it to. + + + + + + + OPTIONS + + + + -h + + Show list of available options. + + + + -H <ldb-url> + + LDB URL to connect to. See ldb(7) for details. + + + + + -o options + Extra ldb options, such as + modules. + + + + + + + + ENVIRONMENT + + + LDB_URL + LDB URL to connect to (can be overrided by using the + -H command-line option.) + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbmodify, ldbdel, ldif(5) + + + + + AUTHOR + + &man.credits.samba; + + ldbrename was written by Andrew Tridgell. + + This manpage was written by Jelmer Vernooij. + + + + diff --git a/source4/lib/ldb/man/man1/ldbsearch.1.xml b/source4/lib/ldb/man/man1/ldbsearch.1.xml new file mode 100644 index 0000000000..8361aa97ff --- /dev/null +++ b/source4/lib/ldb/man/man1/ldbsearch.1.xml @@ -0,0 +1,113 @@ + + + + + + ldbsearch + 1 + + + + + ldbsearch + Search for records in a LDB database + + + + + ldbsearch + -h + -s base|one|sub + -b basedn + -i + -H LDB-URL + expression + attributes + + + + + DESCRIPTION + + ldbsearch searches a LDB database for records matching the + specified expression (see the ldapsearch(1) manpage for + a description of the expression format). For each + record, the specified attributes are printed. + + + + + + + OPTIONS + + + + -h + + Show list of available options. + + + + -H <ldb-url> + + LDB URL to connect to. See ldb(7) for details. + + + + + -s one|sub|base + Search scope to use. One-level, subtree or base. + + + + -i + Read search expressions from stdin. + + + + -b basedn + Specify Base DN to use. + + + + + + + + ENVIRONMENT + + + LDB_URL + LDB URL to connect to (can be overrided by using the + -H command-line option.) + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbedit + + + + + AUTHOR + + &man.credits.samba; + + ldbsearch was written by Andrew Tridgell. + + This manpage was written by Jelmer Vernooij. + + + + diff --git a/source4/lib/registry/man/regdiff.1.xml b/source4/lib/registry/man/regdiff.1.xml new file mode 100644 index 0000000000..d4d9d75b91 --- /dev/null +++ b/source4/lib/registry/man/regdiff.1.xml @@ -0,0 +1,102 @@ + + + + + + regdiff + 1 + + + + + regdiff + Diff program for Windows registry files + + + + + regdiff + --help + --backend=BACKEND + --backend=BACKEND + --credentials=CREDENTIALS + --credentials=CREDENTIALS + location + location + + + + + DESCRIPTION + + regdiff compares two Windows registry files key by key + and value by value and generates a text file that contains the + differences between the two files. + + A file generated by regdiff can later be applied to a + registry file by the regpatch utility. + + regdiff and regpatch use the same file format as + the regedit32.exe utility from Windows. + + + + + OPTIONS + + + + --help + + Show list of available options. + + + + --backend BACKEND + Name of backend to load. Possible values are: + w95, nt4, gconf, dir and rpc. The default is dir. + + + This argument can be specified twice: once for the first + registry file and once for the second. + + + + + --credentials=CREDENTIALS + + Credentials to use, if any. Password should be separated from user name by a percent sign. + + + This argument can be specified twice: once for the first + registry file and once for the second. + + + + + +&man.registry.backends; + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + gregedit, regshell, regpatch, regtree, samba, patch, diff + + + + + AUTHOR + + &man.credits.samba; + + This manpage and regdiff were written by Jelmer Vernooij. + + + + diff --git a/source4/lib/registry/man/regpatch.1.xml b/source4/lib/registry/man/regpatch.1.xml new file mode 100644 index 0000000000..f1792d8bc9 --- /dev/null +++ b/source4/lib/registry/man/regpatch.1.xml @@ -0,0 +1,88 @@ + + + + + + regpatch + 1 + + + + + regpatch + Applies registry patches to registry files + + + + + regpatch + --help + --backend=BACKEND + --credentials=CREDENTIALS + location + patch-file + + + + + DESCRIPTION + + The regpatch utility applies registry patches to Windows registry + files. The patch files should have the same format as is being used + by the regdiff utility and regedit32.exe from Windows. + + If no patch file is specified on the command line, + regpatch attempts to read it from standard input. + + + + + OPTIONS + + + + --help + + Show list of available options. + + + + --backend BACKEND + Name of backend to load. Possible values are: + w95, nt4, gconf, dir and rpc. The default is dir. + + + + + --credentials=CREDENTIALS + + Credentials to use, if any. Password should be separated from user name by a percent sign. + + + + +&man.registry.backends; + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + regdiff, regtree, regshell, gregedit, samba, diff, patch + + + + + AUTHOR + + &man.credits.samba; + + This manpage and regpatch were written by Jelmer Vernooij. + + + + diff --git a/source4/lib/registry/man/regshell.1.xml b/source4/lib/registry/man/regshell.1.xml new file mode 100644 index 0000000000..fbfff86b09 --- /dev/null +++ b/source4/lib/registry/man/regshell.1.xml @@ -0,0 +1,188 @@ + + + + + + regshell + 1 + + + + + regshell + Windows registry file browser using readline + + + + + regshell + --help + --backend=BACKEND + --credentials=CREDENTIALS + location + + + + + DESCRIPTION + + + regshell is a utility that lets you browse thru a Windows registry + file as if you were using a regular unix shell to browse thru a + file system. + + + + + + + OPTIONS + + + + --help + + Show list of available options. + + + + --backend BACKEND + Name of backend to load. Possible values are: + w95, nt4, gconf, dir and rpc. The default is dir. + + + + + --credentials=CREDENTIALS + + Credentials to use, if any. Password should be separated from user name by a percent sign. + + + + + + COMMANDS + + + + ck|cd <keyname> + + Go to the specified subkey. + + + + + ch|predef [predefined-key-name] + + Go to the specified predefined key. + + + + + list|ls + + List subkeys and values of the current key. + + + + + mkkey|mkdir <keyname> + + Create a key with the specified keyname as a subkey of the current key. + + + + + rmval|rm <valname> + + Delete the specified value. + + + + + rmkey|rmdir <keyname> + + Delete the specified subkey recursively. + + + + + pwd|pwk + Print the full name of the current key. + + + + set|update + Update the value of a key value. Not implemented at the moment. + + + + help|? + Print a list of available commands. + + + exit|quit + Leave regshell. + + + + +&man.registry.backends; + + + EXAMPLES + + Browsing thru a nt4 registry file + +regshell -b nt4 NTUSER.DAT +$$$PROTO.HIV> ls +K AppEvents +K Console +K Control Panel +K Environment +K Identities +K Keyboard Layout +K Network +K Printers +K Software +K UNICODE Program Groups +K Windows 3.1 Migration Status +$$$PROTO.HIV> exit + + +Listing the subkeys of HKEY_CURRENT_USER\AppEvents on a remote computer: + +regshell --remote=ncacn_np:aurelia -c "jelmer%secret" +HKEY_CURRENT_MACHINE> predef HKEY_CURRENT_USER +HKEY_CURRENT_USER> cd AppEvents +Current path is: HKEY_CURRENT_USER\AppEvents +HKEY_CURRENT_USER\AppEvents> ls +K EventLabels +K Schemes +HKEY_CURRENT_USER\AppEvents> exit + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + regtree, regdiff, regpatch, gregedit, samba + + + + + AUTHOR + + &man.credits.samba; + + This manpage and regshell were written by Jelmer Vernooij. + + + + diff --git a/source4/lib/registry/man/regtree.1.xml b/source4/lib/registry/man/regtree.1.xml new file mode 100644 index 0000000000..7fc0de2721 --- /dev/null +++ b/source4/lib/registry/man/regtree.1.xml @@ -0,0 +1,101 @@ + + + + + + regtree + 1 + + + + + regtree + Text-mode registry viewer + + + + + regtree + --help + --backend=BACKEND + --fullpath + --no-values + --credentials=CREDENTIALS + location + + + + + DESCRIPTION + + The regtree utility prints out all the contents of a + Windows registry file. Subkeys are printed with one level + more indentation then their parents. + + + + + + OPTIONS + + + + --help + + Show list of available options. + + + + --backend BACKEND + Name of backend to load. Possible values are: + w95, nt4, gconf, dir and rpc. The default is dir. + + + + + --credentials=CREDENTIALS + + Credentials to use, if any. Password should be separated from user name by a percent sign. + + + + --fullpath + + Print the full path to each key instead of only its name. + + + + + --no-values + Don't print values, just keys. + + + + + + +&man.registry.backends; + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + gregedit, regshell, regdiff, regpatch, samba + + + + + AUTHOR + + &man.credits.samba; + + This manpage and regtree were written by Jelmer Vernooij. + + + + -- cgit