From 98e521f8ddecf14dba20d1e19d821b16d676447b Mon Sep 17 00:00:00 2001 From: Chris Frey Date: Tue, 19 Feb 2013 16:24:38 -0500 Subject: [PATCH] doc: clarified the upldif.1 manpage based on feedback from YuGiOhJCJ --- man/upldif.1 | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/man/upldif.1 b/man/upldif.1 index bede0248..3c2f91f7 100644 --- a/man/upldif.1 +++ b/man/upldif.1 @@ -2,7 +2,7 @@ .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) -.TH UPLDIF 1 "November 24, 2009" +.TH UPLDIF 1 "February 19, 2013" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: @@ -26,7 +26,12 @@ .B upldif reads a list of contacts in LDAP LDIF format from stdin, and overwrites the Blackberry's Address Book database with those -contents. +contents. In other words, upldif is for +.B writing +to your Blackberry. If you want to +.B read +data from your Blackberry into various formats, you want some other +tool, such as btool or bio. .SH OPTIONS .TP .B \-p pin @@ -37,8 +42,8 @@ multiple Blackberries plugged into your system at once. Simplistic method to specify device password. .TP .B \-u -Actually do the upload. If not specified, upldif only dumps the parsed -LDIF data to stdout for verification. +Actually do the upload. If not specified, upldif only dumps the +LDIF data that it parsed from stdin, back to stdout for verification. Note! If this option is specified, all existing contacts on your Blackberry will be deleted and replaced with the LDIF contacts. @@ -55,6 +60,14 @@ In the event of a fatal error, the message will be written to stderr, with an error code of 1. +.SH EXAMPLES +.TP +1) Have Barry parse your default ldap contacts as best it can, and send +the output to stdout. +.IP +ldapsearch \-x | upldif + + .SH AUTHOR .nh .B upldif @@ -62,5 +75,5 @@ is part of the Barry project. This manual page was written by Chris Frey. .SH SEE ALSO .PP -http://www.netdirect.ca/software/packages/barry +http://netdirect.ca/barry -- 2.11.4.GIT