aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/ldap2csv.1.in121
1 files changed, 120 insertions, 1 deletions
diff --git a/doc/ldap2csv.1.in b/doc/ldap2csv.1.in
index 4868e74..48c4639 100644
--- a/doc/ldap2csv.1.in
+++ b/doc/ldap2csv.1.in
@@ -38,19 +38,138 @@ ldap2csv \- LDAP search tool which outputs CSV
38 38
39.SH SYNOPSIS 39.SH SYNOPSIS
40\fBldap2csv\fR 40\fBldap2csv\fR
41[\fBFILL IN OPTIONS\fR] 41[\fB-b\fR \fIbasedn\fR]
42[\fB-c\fR]
43[\fB-d\fR \fIlevel\fR]
44[\fB-D\fR \fIbinddn\fR]
45[\fB-H\fR \fIURI\fR]
46[\fB-l\fR \fIlimit\fR]
47[\fB-L\fR[\fB-L\fR]]
48[\fB-n\fR]
49[\fB-v\fR | \fB--version\fR]
50[\fB-s\fR \fIscope\fR]
51[\fB-S\fR \fIattr\fR]
52[\fB-w\fR \fIpasswd\fR]
53[\fB-W\fR]
54[\fB-x\fR]
55[\fB-y\fR \fIfile\fR]
56[\fB-Y\fR \fImech\fR]
57[\fB-z\fR \fIlimit\fR]
58[\fB-Z\fR[\fB-Z\fR]]
59\fIfilter\fR
60\fIattributes...\fR
42.sp 61.sp
43\fBldap2csv\fR [ \fB-h\fR | \fB--help\fR ] 62\fBldap2csv\fR [ \fB-h\fR | \fB--help\fR ]
44.sp 63.sp
45\fBldap2csv\fR [ \fB-V\fR | \fB--version\fR ] 64\fBldap2csv\fR [ \fB-V\fR | \fB--version\fR ]
46 65
66
47.SH DESCRIPTION 67.SH DESCRIPTION
68ldap2csv is a shell utilty which performs an LDAP search and prints the results
69in CSV format.
48 70
49 71
50.SH OPTIONS 72.SH OPTIONS
73.TP
74\fB-c\fR
75do not stop if an error is encountered
76.TP
77\fB-d\fR
78set OpenLDAP debug level to `level'
79.TP
80\fB-D\fR \fIbinddn\fR
81bind DN used for simple bind
82.TP
83\fB-H\fR \fIURI\fR
84specifies list of LDAP Uniform Resource Identifier(s) used to connect to LDAP server
85.TP
86\fB-l\fR \fIlimit\fR
87time limit (in seconds) for search
88.TP
89\fB-L\fR
90two \fB-L\fR disables comments
91.TP
92\fB-v\fR \fB--version\fR
93run in verbose mode
94.TP
95\fB-s\fR \fIscope\fR
96specifies search filter. Must be one of \fIbase\fR, \fIone\fR, \fIsub\fR, or \fIchild\fR
97.TP
98\fB-S\fR \fIattr\fR
99sort results by attribute \fIattr\fR
100.TP
101\fB-w\fR \fIpasswd\fR
102bind password used for simple bind
103.TP
104\fB-W\fR
105prompt for bind password used in simple bind
106.TP
107\fB-x\fR
108use simple authentication for bind
109.TP
110\fB-y\fR \fIfile\fR
111read bind password from file
112.TP
113\fB-Y\fR \fImech\fR
114SASL mechanism used during bind
115.TP
116\fB-z\fR \fIlimit\fR
117size limit for search
118.TP
119\fB-Z\fR[\fB-Z\fR]
120Issue StartTLS before bind request. \fB-ZZ\fR requires TLS operations to be successful.
51 121
52 122
53.SH EXAMPLE 123.SH EXAMPLE
124The following command:
125.in +4n
126.nf
127
128ldap2csv -LLL -x -b o=internet -S sn '(uid=*)' uid givenname sn mail title rdn
129
130.fi
131.in
132
133will perform search on the LDAP server. The output might look something the following:
134.in +4n
135.nf
136
137"uid","givenname","sn","mail","title","rdn"
138"jdough","John","Dough","doughboy42@example.com","'Dough' Master","uid=jdough"
139"dnullman","Devian","Nullman","noreply@example.com","Linux Device : /dev/null","uid=dnullman"
140"syzdek","David M.","Syzdek","david@syzdek.net","Slackware Linux Administrator","uid=syzdek"
141
142.fi
143.in
144
145Similar search performed with \fBldapsearch\fR might produce output which looks something like the following:
146
147.in +4n
148.nf
149
150dn: uid=jdough,ou=People,dc=example,dc=net,o=internet
151uid: jdough
152givenname: John
153sn: Dough
154mail: doughboy42@example.com
155title: "Dough" Master
156
157dn: uid=dnullman,ou=People,dc=example,dc=net,o=internet
158uid: dnullman
159givenname: Devian
160sn: Nullman
161mail: noreply@example.com
162title: Linux Device | /dev/null
163
164dn: uid=syzdek,ou=People,dc=syzdek,dc=net,o=internet
165uid: syzdek
166givenname: David M.
167sn: Syzdek
168mail: david@syzdek.net
169title: Slackware Linux Administrator
170
171.fi
172.in
54 173
55 174
56.SH "SEE ALSO" 175.SH "SEE ALSO"