Changeset 213 for trunk

Timestamp:

06/17/08 20:13:39 (5 months ago)

Author:

zany

Message:

switching from POD to asciidoc

Location:

trunk/doc

Files:

• Makefile.am (modified) (1 diff)
• obexftp.1 (deleted)
• obexftp.1.txt (moved) (moved from trunk/doc/obexftp.pod) (2 diffs)
• obexftpd.1 (deleted)
• obexftpd.1.txt (moved) (moved from trunk/doc/obexftpd.pod) (1 diff)

trunk/doc/Makefile.am

@@ -1 +1 @@
 # only maintainer needs to build doc
-# perl's pod2man, pod2html and pod2text needed
+# asciidoc, docbook2X needed
 
 EXTRA_DIST =            $(man_MANS) $(noinst_DATA)
 
-man_MANS =              obexftp.1 obexftpd.1
+man_MANS =                      obexftp.1 obexftpd.1
 
-noinst_DATA =           obexftp.pod obexftp.1.txt obexftp.1.html \
-                        obexftpd.pod obexftpd.1.txt obexftpd.1.html
+noinst_DATA =           obexftp.1.txt obexftp.1.html \
+                                        obexftpd.1.txt obexftpd.1.html
 
 if BUILD_DOCS
 
-SUFFIXES = .1 .pod .1.html .1.txt
+SUFFIXES = .1 .1.txt .1.html
 
-.pod.1:
-        pod2man --center "ObexFTP" --release `stat --format=%y $< | cut -f 1 -d " "` --section 1 $< $@
-#       txt2man -v "ObexFTP" -t "obexftp" -s 1 -r `date -I` \
-#       -I ObexFTP -I gObexFtp -I vfs-obexftp $< > $@
-## and this one for BSD I guess...
-##      pod2man --center "ObexFTP" --release `stat -f %m $< | cut -f 1 -d " "` --section 1 $< $@
+.1.txt.1:
+        asciidoc --doctype=manpage --backend=docbook $<
+        docbook2man $*.1.xml
 
-.pod.1.html:
-        pod2html --title "ObexFTP" --infile=$< --outfile=$@
+.1.txt.1.html:
+        asciidoc --doctype=manpage --backend=xhtml11 $<
 
-.pod.1.txt:
-        pod2text $< $@
-
-#clean-local:
-#       rm -f *.1
+CLEANFILES =            obexftp.1.xml obexftp.1 obexftp.1.html \
+                                        obexftpd.1.xml obexftpd.1 obexftpd.1.html
 
 endif

trunk/doc/obexftp.1.txt

@@ -1 @@
-=head1 NAME
+= OBEXFTP(1)
+
+== NAME
 
 obexftp - Mobile Equipment file transfer tool
 
-=head1 SYNOPSIS
-
-B<obexftp> [I<OPTION>] [I<COMMANDS>]
-
-=head1 DESCRIPTION
-
-B<obexftp> is used to access files on mobile equipment,
-i.e. cell phones. With B<obexftpd> you can transfer files between any
-computers using B<IrDA>, B<Bluetooth> and B<TCP/IP>.
-
-This tool lets you access the B<ObexFTP> library by the means of
+== SYNOPSIS
+
+*obexftp* [_OPTION_] [_COMMANDS_]
+
+== DESCRIPTION
+
+*obexftp* is used to access files on mobile equipment,
+i.e. cell phones. With *obexftpd* you can transfer files between any
+computers using *IrDA*, *Bluetooth* and *TCP/IP*.
+
+This tool lets you access the *ObexFTP* library by the means of
 a command line interface.
 You might consider using the other means available.
-E.g. the B<ObexFS> filesystem for Linux.
-
-=head1 OPTIONS
+E.g. the *ObexFS* filesystem for Linux.
+
+== OPTIONS
 
 The ordering of options is important. Every command will use the most
 recent device set. Every file without command switch will apply to the
-command given most recent. See B<EXAMPLES>
-
-=head2 Transport Options
-
-=over
-
-=item B<-i>, B<--irda>
-
+command given most recent. See *EXAMPLES*
+
+=== Transport Options
+
+*-i*, *--irda*::
 Connect using the IrDA protocol. This is the default.
 
-=item B<-b> I<device>, B<--bluetooth> I<device>
-
+*-b* _device_, *--bluetooth* _device_::
 Connect to this bluetooth device. If the device is not given the first
 device found will be used.
 
-=item B<-B> I<number>, B<--channel> I<number>
+*-B* _number_, *--channel* _number_::
 
 Use this bluetooth channel when connecting.
 The channel will be discoverd automatically if this option is not used.
 
-=item B<-d> I<no/address>, B<--hci> I<no/address>
+*-d* _no/address_, *--hci* _no/address_::
 
 Use the bluetooth device referenced by number or address as
 source device for the connection.
 
-=item B<-u> I<intf no>, B<--usb> I<intf no>
+*-u* _intf no_, *--usb* _intf no_::
 
 Connect to this usb interface or list all available usb interfaces.
 
-=item B<-t> I<device>, B<--tty> I<device>
+*-t* _device_, *--tty* _device_::
 
 Connect to this tty device.
 
-=item B<-n> I<host>, B<--network> I<host>
+*-n* _host_, *--network* _host_::
 
 Connect to this network host.
 
-=back
-
-
-=head2 Compatibility Options
-
-=over
-
-=item B<-U> I<uuid>, B<--uuid> I<uuid>
+
+=== Compatibility Options
+
+
+*-U* _uuid_, *--uuid* _uuid_::
 
 Select the UUID to connect with. Recognized values are currently
@@ -75 +70 @@
 "SHARP" for PCSOFTWARE UUID with Sharp devices.
 
-=item B<-H>, B<--noconn>
+*-H*, *--noconn*::
 
 Suppress connection IDs (i.e. send no connection header to the mobile).
 
-=item B<-S>, B<--nopath>
+*-S*, *--nopath*::
 
 Don't use "setpath" commands (i.e. send the whole path as filename to the
 mobile).
-Can be used together with B<--noconn> and B<--uuid none> to send an OBEX-PUSH.
-
-=back
-
-
-=head2 Setting The File Path
-
-=over
-
-=item B<-c> I<folder>, B<--chdir> I<folder>
+Can be used together with *--noconn* and *--uuid none* to send an OBEX-PUSH.
+
+
+=== Setting The File Path
+
+
+*-c* _folder_, *--chdir* _folder_::
 
 Set the mobiles current working directory.
 
-=item B<-C> I<folder>, B<--mkdir> I<folder>
+*-C* _folder_, *--mkdir* _folder_::
 
 Set the mobiles current working directory.
 The folder will be created if it doesn't exist.
 
-=item B<-l> I<folder>, B<--list> I<folder>
+*-l* _folder_, *--list* _folder_::
 
 List a folder.
 
-=back
-
-
-=head2 Sending And Retrieving Files
-
-=over
-
-=item B<-o> I<path>, B<--output> I<path>
-
-Specify the target file name, overriding the implicit local name from B<--get>
-or the implicit remote name from B<--put>
-
-=item B<-g> I<source>, B<--get> I<source>
+
+=== Sending And Retrieving Files
+
+*-o* _path_, *--output* _path_::
+
+Specify the target file name, overriding the implicit local name from *--get*
+or the implicit remote name from *--put*
+
+*-g* _source_, *--get* _source_::
 
 Retrieve files from mobile.
 
-=item B<-G> I<source>, B<--getdelete> I<source>
+*-G* _source_, *--getdelete* _source_::
 
 Retrieve files from mobile and delete them on the mobile
 
-=item B<-p> I<source>, B<--put> I<source>
+*-p* _source_, *--put* _source_::
 
 Send files to the mobile.
 
-=item B<-k> I<source>, B<--delete> I<source>
+*-k* _source_, *--delete* _source_::
 
 Delete files from the mobile.
 
-=back
-
-
-=head2 Experimental Extras
-
-=over
-
-=item B<-X>, B<--capability>
+
+=== Experimental Extras
+
+*-X*, *--capability*::
 
 Retrieve the capability object from the mobile (if available).
 
-=item B<-Y>, B<--probe>
+*-Y*, *--probe*::
 
 Probe and report device characteristics
 
-=item B<-x>, B<--info>
+*-x*, *--info*::
 
 Retrieve misc infos from mobile. I.e. memory size and free memory.
 Siemens specific for now.
 
-=item B<-m> I<src> I<dest>, B<--move> I<src> I<dest>
+*-m* _src_ _dest_, *--move* _src_ _dest_::
 
 Move (rename) files on the mobile. Siemens specific for now.
 
-=back
-
-
-=head2 Version Information And Help
-
-=over
-
-=item B<-v>, B<--verbose>
+
+=== Version Information And Help
+
+*-v*, *--verbose*::
 
 Be verbose and give some additional infos.
 
-=item B<-V>, B<--version>
+*-V*, *--version*::
 
 Print version string and exit.
 
-=item B<-h>, B<--help>, B<--usage>
+*-h*, *--help*, *--usage*::
 
 Print short usage instructions.
 
-=back
-
-=head1 EXAMPLES
-
-=over
-
-=item To get the directory listing from the first irda device:
-
-B<obexftp -i -l>
+
+== EXAMPLES
+
+To get the directory listing from the first irda device::
+
+*obexftp -i -l*
 or just
-B<obexftp -l>
+*obexftp -l*
 as IrDA is the default.
 
-=item To get the file bar from directory foo from the first bluetooth device:
-
-B<obexftp -b -c foo -g bar>
-
-=item To send the file bar to directory foo with device on first serial port:
-
-B<obexftp -t /dev/ttyS0 -c foo -p bar>
-
-=item It is possible to use RfComm (serial port over bluetooth):
-
-B<obexftp -t /dev/rfcomm0 -c foo -p bar>
-
-=item And also IrComm (serial port over IrDA):
-
-B<obexftp -t /dev/ircomm0 -c foo -p bar>
-
-=item To send the file bar using plain OBEX PUSH:
-
-B<obexftp --bluetooth --nopath --noconn --uuid none --put bar>
-
-
-=back
-
-=head1 SEE ALSO
-
-L<obexftpd>(1), L<openobex>(3), L<obexftp>(3), L<multicobex>(3), L<libbfb>(3).
-
-=head1 BUGS
+To get the file bar from directory foo from the first bluetooth device::
+
+*obexftp -b -c foo -g bar*
+
+To send the file bar to directory foo with device on first serial port::
+
+*obexftp -t /dev/ttyS0 -c foo -p bar*
+
+It is possible to use RfComm (serial port over bluetooth)::
+
+*obexftp -t /dev/rfcomm0 -c foo -p bar*
+
+And also IrComm (serial port over IrDA)::
+
+*obexftp -t /dev/ircomm0 -c foo -p bar*
+
+To send the file bar using plain OBEX PUSH::
+
+*obexftp --bluetooth --nopath --noconn --uuid none --put bar*
+
+
+== SEE ALSO
+
+obexftpd(1), openobex(3), obexftp(3), multicobex(3), libbfb(3).
+
+== BUGS
 
 Bugs ? Features !
 
-=head1 NOTES
+== NOTES
 
 The software has been tested and reported working on at least Siemens, Ericsson, and Nokia phones.
 
-=head1 AUTHOR
-
-Christian W. Zuckschwerdt E<lt>zany@triq.netE<gt>
-
+== AUTHOR
+
+Christian W. Zuckschwerdt <zany@triq.net>
+

trunk/doc/obexftpd.1.txt

@@ -1 @@
-=head1 NAME
+= OBEXFTPD(1)
+
+== NAME
 
 obexftpd - Mobile Equipment file transfer server
 
-=head1 SYNOPSIS
+== SYNOPSIS
 
-B<obexftpd> [I<OPTIONS>] [I<TRANSPORT>]
+*obexftpd* [_OPTIONS_] [_TRANSPORT_]
 
-=head1 DESCRIPTION
+== DESCRIPTION
 
-With B<obexftpd> you can set up an obex server on any
-computers using B<IrDA>, B<Bluetooth> or B<TCP/IP>.
-Use e.g. B<obexftp> or the B<ObexFS> to access the files on this server.
+With *obexftpd* you can set up an obex server on any
+computers using *IrDA*, *Bluetooth* or *TCP/IP*.
+Use e.g. *obexftp* or the *ObexFS* to access the files on this server.
 
-=head1 OPTIONS
+== OPTIONS
 
 The ordering of options is important. The first transport option will
 start the server. Use basedir and verbose options prior to any transport.
-See B<EXAMPLES>
+See *EXAMPLES*
 
 
-=head2 Transport Options
+=== Transport Options
 
-=over
-
-=item B<-i>, B<--irda>
+*-i*, *--irda*::
 
 Acceopt connections using the IrDA protocol.
 
-=item B<-b>, B<--bluetooth>
+*-b*, *--bluetooth*::
 
 Accept connections via bluetooth.
 
-=item B<-t> I<device>, B<--tty> I<device>
+*-t* _device_, *--tty* _device_::
 
 Accept connections from this tty device. NOT WORKING!
 
-=item B<-n> I<host>, B<--network> I<host>
+*-n* _host_, *--network* _host_::
 
 Accept connections from the network to this port.
 
-=back
 
+=== Setting The File Path
 
-=head2 Setting The File Path
-
-=over
-
-=item B<-c> I<folder>, B<--chdir> I<folder>
+*-c* _folder_, *--chdir* _folder_::
 
 Set the base directory for the server.
 
-=back
 
+=== Version Information And Help
 
-=head2 Version Information And Help
-
-=over
-
-=item B<-v>, B<--verbose>
+*-v*, *--verbose*::
 
 Be verbose and give some additional infos.
 
-=item B<-V>, B<--version>
+*-V*, *--version*::
 
 Print version string and exit.
 
-=item B<-h>, B<--help>, B<--usage>
+*-h*, *--help*, *--usage*::
 
 Print short usage instructions.
 
-=back
 
-=head1 EXAMPLES
+== EXAMPLES
 
-=over
+Start listening for bluetooth connections and use a safe basedir:::
 
-=item Start listening for bluetooth connections and use a safe basedir:
+*obexftpd -c /tmp/inbox -b*
 
-B<obexftpd -c /tmp/inbox -b>
 
-=back
+== SEE ALSO
 
-=head1 SEE ALSO
+obexftp(1), openobex(3), obexftp(3), multicobex(3), libbfb(3).
 
-L<obexftp>(1), L<openobex>(3), L<obexftp>(3), L<multicobex>(3), L<libbfb>(3).
-
-=head1 BUGS
+== BUGS
 
 Bugs ? Features !
 
-=head1 NOTES
+== NOTES
 
 The software has been tested and reported working on at least Siemens, Ericsson, and Nokia phones.
 
-=head1 AUTHOR
+== AUTHOR
 
-Christian W. Zuckschwerdt E<lt>zany@triq.netE<gt>
-Alan Zhang E<lt>vibra@tom.comE<gt>
+Christian W. Zuckschwerdt <zany@triq.net>
+Alan Zhang <vibra@tom.com>