source: vendor/current/docs/manpages/ldbedit.1@ 740

Last change on this file since 740 was 740, checked in by Silvan Scherrer, 12 years ago

Samba Server: update vendor to 3.6.0

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