1.\" $OpenBSD: ldapctl.8,v 1.6 2016/02/02 17:39:02 jmc 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: February 2 2016 $ 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 r Ar directory 28.Op Fl s Ar socket 29.Ar command 30.Op Ar argument ... 31.Sh DESCRIPTION 32The 33.Nm 34program controls the 35.Xr ldapd 8 36daemon. 37.Pp 38The options are as follows: 39.Bl -tag -width Ds 40.It Fl f Ar file 41Use 42.Ar file 43as the configuration file, instead of the default 44.Pa /etc/ldapd.conf . 45.It Fl r Ar directory 46Store and read database files in 47.Ar directory , 48instead of the default 49.Pa /var/db/ldap . 50.It Fl s Ar socket 51Use 52.Ar socket 53instead of the default 54.Pa /var/run/ldapd.sock 55to communicate with 56.Xr ldapd 8 . 57.It Fl v 58Produce more verbose output. 59.El 60.Pp 61The commands are as follows: 62.Bl -tag -width xxxxxx 63.It Cm stats 64Show statistics counters. 65.It Cm log brief 66Disable verbose debug logging. 67.It Cm log verbose 68Enable verbose debug logging. 69.It Cm compact 70Compact all databases. 71.Xr ldapd 8 72does not have to be running. 73When compaction of a database file is complete, a special marker is appended 74to the database file that tells 75.Xr ldapd 8 76to reopen the file and perform new requests against the compacted database. 77A write transaction is opened to force other processes to buffer write 78requests while performing compaction. 79Read requests are handled without disruption. 80.It Cm index 81Re-index all databases. 82.Xr ldapd 8 83does not have to be running. 84.El 85.Sh FILES 86.Bl -tag -width "/var/run/ldapd.sockXXXXXXX" -compact 87.It Pa /var/run/ldapd.sock 88default 89.Nm 90control socket 91.It Pa /etc/ldapd.conf 92default 93.Xr ldapd 8 94configuration file 95.El 96.Sh SEE ALSO 97.Xr ldapd.conf 5 , 98.Xr ldapd 8 99.Sh HISTORY 100The 101.Nm 102program first appeared in 103.Ox 4.8 . 104