1
0
mirror of https://github.com/samba-team/samba.git synced 2024-12-24 21:34:56 +03:00
samba-mirror/lib/ldb/man/ldbedit.1.xml
Björn Jacke c44e1916eb man pages: change http://samba.org to https://www.samba.org
Signed-off-by: Bjoern Jacke <bj@sernet.de>
Reviewed-by: Karolin Seeger <kseeger@samba.org>
2016-12-09 13:10:26 +01:00

204 lines
5.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<refentry id="ldbedit.1">
<refmeta>
<refentrytitle>ldbedit</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="source">LDB</refmiscinfo>
<refmiscinfo class="manual">System Administration tools</refmiscinfo>
<refmiscinfo class="version">1.1</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ldbedit</refname>
<refpurpose>Edit LDB databases using your preferred editor</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ldbedit</command>
<arg choice="opt">-?</arg>
<arg choice="opt">--usage</arg>
<arg choice="opt">-s base|one|sub</arg>
<arg choice="opt">-b basedn</arg>
<arg choice="opt">-a</arg>
<arg choice="opt">-e editor</arg>
<arg choice="opt">-H LDB-URL</arg>
<arg choice="opt">expression</arg>
<arg rep="repeat" choice="opt">attributes</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>ldbedit is a utility that allows you to edit LDB entries (in
tdb files, sqlite files or LDAP servers) using your preferred editor.
ldbedit generates an LDIF file based on your query, allows you to edit
the LDIF, and then merges that LDIF back into the LDB backend.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-?</term>
<term>--help</term>
<listitem>
<para>
Show list of available options, and a phrase describing what that option
does.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>--usage</term>
<listitem>
<para>
Show list of available options. This is similar to the help option,
however it does not provide any description, and is hence shorter.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-H &lt;ldb-url&gt;</term>
<listitem>
<para>
LDB URL to connect to. For a tdb database,
this will be of the form
tdb://<replaceable>filename</replaceable>.
For a LDAP connection over unix domain
sockets, this will be of the form
ldapi://<replaceable>socket</replaceable>. For
a (potentially remote) LDAP connection over
TCP, this will be of the form
ldap://<replaceable>hostname</replaceable>. For
an SQLite database, this will be of the form
sqlite://<replaceable>filename</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-s one|sub|base</term>
<listitem><para>Search scope to use. One-level, subtree or base.</para></listitem>
</varlistentry>
<varlistentry>
<term>-a</term>
<term>-all</term>
<listitem>
<para>Edit all records. This allows you to
apply the same change to a number of records
at once. You probably want to combine this
with an expression of the form
"objectclass=*".
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-e editor</term>
<term>--editor editor</term>
<listitem>
<para>Specify the editor that should be used (overrides
the VISUAL and EDITOR environment
variables). If this option is not used, and
neither VISUAL nor EDITOR environment variables
are set, then the vi editor will be used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-b basedn</term>
<listitem><para>Specify Base Distinguished Name to use.</para></listitem>
</varlistentry>
<varlistentry>
<term>-v</term>
<term>--verbose</term>
<listitem>
<para>Make ldbedit more verbose about the
operations that are being performed. Without
this option, ldbedit will only provide a
summary change line.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>ENVIRONMENT</title>
<variablelist>
<varlistentry>
<term>LDB_URL</term>
<listitem>
<para>LDB URL to connect to. This can be
overridden by using the -H command-line option.)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>VISUAL and EDITOR</term>
<listitem>
<para>
Environment variables used to determine what
editor to use. VISUAL takes precedence over
EDITOR, and both are overridden by the
-e command-line option.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 1.1 of LDB.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>ldb(3), ldbmodify(1), ldbdel(1), ldif(5), vi(1)</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>
ldb was written by
<ulink url="https://www.samba.org/~tridge/">Andrew Tridgell</ulink>.
</para>
<para>
If you wish to report a problem or make a suggestion then please see
the <ulink url="http://ldb.samba.org/"/> web site for
current contact and maintainer information.
</para>
<para>
This manpage was written by Jelmer Vernooij and updated
by Brad Hards.
</para>
</refsect1>
</refentry>