source: branches/samba-3.2.x/docs/manpages/ldbedit.1@ 229

Last change on this file since 229 was 229, checked in by Herwig Bauernfeind, 16 years ago

Update 3.2 branch to 3.2.7 docs

File size: 3.1 KB
Line 
1.\" Title: ldbedit
2.\" Author:
3.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
4.\" Date: 12/19/2008
5.\" Manual: User Commands
6.\" Source: Samba 3.2
7.\"
8.TH "LDBEDIT" "1" "12/19/2008" "Samba 3\.2" "User Commands"
9.\" disable hyphenation
10.nh
11.\" disable justification (adjust text to left margin only)
12.ad l
13.SH "NAME"
14ldbedit - Edit LDB databases using your preferred editor
15.SH "SYNOPSIS"
16.HP 1
17ldbedit [\-?] [\-\-usage] [\-s\ base|one|sub] [\-b\ basedn] [\-a] [\-e\ editor] [\-H\ LDB\-URL] [expression] [attributes...]
18.SH "DESCRIPTION"
19.PP
20ldbedit 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\.
21.SH "OPTIONS"
22.PP
23\-?, \-\-help
24.RS 4
25Show list of available options, and a phrase describing what that option does\.
26.RE
27.PP
28\-\-usage
29.RS 4
30Show list of available options\. This is similar to the help option, however it does not provide any description, and is hence shorter\.
31.RE
32.PP
33\-H <ldb\-url>
34.RS 4
35LDB URL to connect to\. For a tdb database, this will be of the form tdb://\fIfilename\fR\. For a LDAP connection over unix domain sockets, this will be of the form ldapi://\fIsocket\fR\. For a (potentially remote) LDAP connection over TCP, this will be of the form ldap://\fIhostname\fR\. For an SQLite database, this will be of the form sqlite://\fIfilename\fR\.
36.RE
37.PP
38\-s one|sub|base
39.RS 4
40Search scope to use\. One\-level, subtree or base\.
41.RE
42.PP
43\-a, \-all
44.RS 4
45Edit 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=*"\.
46.RE
47.PP
48\-e editor, \-\-editor editor
49.RS 4
50Specify 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\.
51.RE
52.PP
53\-b basedn
54.RS 4
55Specify Base Distinguished Name to use\.
56.RE
57.PP
58\-v, \-\-verbose
59.RS 4
60Make ldbedit more verbose about the operations that are being performed\. Without this option, ldbedit will only provide a summary change line\.
61.RE
62.SH "ENVIRONMENT"
63.PP
64LDB_URL
65.RS 4
66LDB URL to connect to\. This can be overridden by using the \-H command\-line option\.)
67.RE
68.PP
69VISUAL and EDITOR
70.RS 4
71Environment variables used to determine what editor to use\. VISUAL takes precedence over EDITOR, and both are overridden by the \-e command\-line option\.
72.RE
73.SH "VERSION"
74.PP
75This man page is correct for version 4\.0 of the Samba suite\.
76.SH "SEE ALSO"
77.PP
78ldb(7), ldbmodify(1), ldbdel(1), ldif(5), vi(1)
79.SH "AUTHOR"
80.PP
81ldb was written by
82Andrew Tridgell\.
83.PP
84If you wish to report a problem or make a suggestion then please see the
85: http://ldb.samba.org/
86web site for current contact and maintainer information\.
87.PP
88This manpage was written by Jelmer Vernooij and updated by Brad Hards\.
Note: See TracBrowser for help on using the repository browser.