docs: updating man page for ldap2csv

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
 
 .SH SYNOPSIS
 \fBldap2csv\fR
-[\fBFILL IN OPTIONS\fR]
+[\fB-b\fR \fIbasedn\fR]
+[\fB-c\fR]
+[\fB-d\fR \fIlevel\fR]
+[\fB-D\fR \fIbinddn\fR]
+[\fB-H\fR \fIURI\fR]
+[\fB-l\fR \fIlimit\fR]
+[\fB-L\fR[\fB-L\fR]]
+[\fB-n\fR]
+[\fB-v\fR | \fB--version\fR]
+[\fB-s\fR \fIscope\fR]
+[\fB-S\fR \fIattr\fR]
+[\fB-w\fR \fIpasswd\fR]
+[\fB-W\fR]
+[\fB-x\fR]
+[\fB-y\fR \fIfile\fR]
+[\fB-Y\fR \fImech\fR]
+[\fB-z\fR \fIlimit\fR]
+[\fB-Z\fR[\fB-Z\fR]]
+\fIfilter\fR
+\fIattributes...\fR
 .sp
 \fBldap2csv\fR [ \fB-h\fR | \fB--help\fR ]
 .sp
 \fBldap2csv\fR [ \fB-V\fR | \fB--version\fR ]
 
+
 .SH DESCRIPTION
+ldap2csv is a shell utilty which performs an LDAP search and prints the results
+in CSV format. 
 
 
 .SH OPTIONS
+.TP
+\fB-c\fR
+do not stop if an error is encountered
+.TP
+\fB-d\fR
+set OpenLDAP debug level to `level'
+.TP
+\fB-D\fR \fIbinddn\fR
+bind DN used for simple bind
+.TP
+\fB-H\fR \fIURI\fR
+specifies list of LDAP Uniform Resource Identifier(s) used to connect to LDAP server
+.TP
+\fB-l\fR \fIlimit\fR
+time limit (in seconds) for search
+.TP
+\fB-L\fR
+two \fB-L\fR disables comments
+.TP
+\fB-v\fR   \fB--version\fR
+run in verbose mode
+.TP
+\fB-s\fR \fIscope\fR
+specifies search filter. Must be one of \fIbase\fR, \fIone\fR, \fIsub\fR, or \fIchild\fR
+.TP
+\fB-S\fR \fIattr\fR
+sort results by attribute \fIattr\fR
+.TP
+\fB-w\fR \fIpasswd\fR
+bind password used for simple bind
+.TP
+\fB-W\fR
+prompt for bind password used in simple bind
+.TP
+\fB-x\fR
+use simple authentication for bind
+.TP
+\fB-y\fR \fIfile\fR
+read bind password from file
+.TP
+\fB-Y\fR \fImech\fR
+SASL mechanism used during bind
+.TP
+\fB-z\fR \fIlimit\fR
+size limit for search
+.TP
+\fB-Z\fR[\fB-Z\fR]
+Issue  StartTLS before bind request. \fB-ZZ\fR requires TLS operations to be successful. 
 
 
 .SH EXAMPLE
+The following command:
+.in +4n
+.nf
+
+ldap2csv -LLL -x -b o=internet -S sn '(uid=*)' uid givenname sn mail title rdn
+
+.fi
+.in
+
+will perform search on the LDAP server.  The output might look something the following:
+.in +4n
+.nf
+
+"uid","givenname","sn","mail","title","rdn"
+"jdough","John","Dough","doughboy42@example.com","'Dough' Master","uid=jdough"
+"dnullman","Devian","Nullman","noreply@example.com","Linux Device : /dev/null","uid=dnullman"
+"syzdek","David M.","Syzdek","david@syzdek.net","Slackware Linux Administrator","uid=syzdek"
+
+.fi
+.in
+
+Similar search performed with \fBldapsearch\fR might produce output which looks something like the following:
+
+.in +4n
+.nf
+
+dn: uid=jdough,ou=People,dc=example,dc=net,o=internet
+uid: jdough
+givenname: John
+sn: Dough 
+mail: doughboy42@example.com
+title: "Dough" Master
+
+dn: uid=dnullman,ou=People,dc=example,dc=net,o=internet
+uid: dnullman
+givenname: Devian
+sn: Nullman
+mail: noreply@example.com
+title: Linux Device | /dev/null
+
+dn: uid=syzdek,ou=People,dc=syzdek,dc=net,o=internet
+uid: syzdek
+givenname: David M.
+sn: Syzdek
+mail: david@syzdek.net
+title: Slackware Linux Administrator
+
+.fi
+.in
 
 
 .SH "SEE ALSO"