xref: /openbsd/usr.sbin/ldapctl/ldapctl.8 (revision a6445c1d)
1.\"	$OpenBSD: ldapctl.8,v 1.4 2010/07/21 06:32:14 martinh Exp $
2.\"
3.\" Copyright (c) 2009, 2010 Martin Hedenfalk <martin@bzero.se>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: July 21 2010 $
18.Dt LDAPCTL 8
19.Os
20.Sh NAME
21.Nm ldapctl
22.Nd LDAP daemon control program
23.Sh SYNOPSIS
24.Nm ldapctl
25.Op Fl v
26.Op Fl f Ar file
27.Op Fl s Ar socket
28.Ar command
29.Op Ar argument ...
30.Sh DESCRIPTION
31The
32.Nm
33program controls the
34.Xr ldapd 8
35daemon.
36.Pp
37The options are as follows:
38.Bl -tag -width Ds
39.It Fl f Ar file
40Use
41.Ar file
42as the configuration file, instead of the default
43.Pa /etc/ldapd.conf .
44.It Fl s Ar socket
45Use
46.Ar socket
47instead of the default
48.Pa /var/run/ldapd.sock
49to communicate with
50.Xr ldapd 8 .
51.It Fl v
52Produce more verbose output.
53.El
54.Pp
55The commands are as follows:
56.Bl -tag -width xxxxxx
57.It Cm stats
58Show statistics counters.
59.It Cm log brief
60Disable verbose debug logging.
61.It Cm log verbose
62Enable verbose debug logging.
63.It Cm compact
64Compact all databases.
65.Xr ldapd 8
66does not have to be running.
67When compaction of a database file is complete, a special marker is appended
68to the database file that tells
69.Xr ldapd 8
70to reopen the file and perform new requests against the compacted database.
71A write transaction is opened to force other processes to buffer write
72requests while performing compaction.
73Read requests are handled without disruption.
74.It Cm index
75Re-index all databases.
76.Xr ldapd 8
77does not have to be running.
78.El
79.Sh FILES
80.Bl -tag -width "/var/run/ldapd.sockXXXXXXX" -compact
81.It Pa /var/run/ldapd.sock
82default
83.Nm
84control socket
85.It Pa /etc/ldapd.conf
86default
87.Xr ldapd 8
88configuration file
89.El
90.Sh SEE ALSO
91.Xr ldapd.conf 5 ,
92.Xr ldapd 8
93.Sh HISTORY
94The
95.Nm
96program first appeared in
97.Ox 4.8 .
98