From: Hendrik S. <po...@he...> - 2008-12-05 01:08:51
|
The files comply to docbook-XML 4.2 and xsltproc, xalan2 and saxon-6.5 can be used to convert them. --- doc/openobex-apps.xml | 359 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 359 insertions(+), 0 deletions(-) create mode 100644 doc/openobex-apps.xml diff --git a/doc/openobex-apps.xml b/doc/openobex-apps.xml new file mode 100644 index 0000000..97f8006 --- /dev/null +++ b/doc/openobex-apps.xml @@ -0,0 +1,359 @@ +<?xml version="1.0" ?> +<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook XML V4.2//DE" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<reference> + <referenceinfo> + <date>2008-11-23</date> + <productname>openobex</productname> + <productnumber>1.4</productnumber> + <authorgroup> + <author> + <firstname>Hendrik</firstname> + <surname>Sattler</surname> + <contrib>initial version of manpage</contrib> + <email>po...@he...</email> + </author> + </authorgroup> + </referenceinfo> + + <title>openobex</title> + + <refentry> + <refmeta> + <refentrytitle>ircp</refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo class="manual">User commands</refmiscinfo> + </refmeta> + <refnamediv> + <refname>ircp</refname> + <refpurpose>send or receive files via infrared connection</refpurpose> + </refnamediv> + <refsynopsisdiv> + <cmdsynopsis> + <command>ircp</command> + <arg choice="opt"><option>-r <replaceable><optional>destination</optional></replaceable></option></arg> + </cmdsynopsis> + <cmdsynopsis> + <command>ircp</command> + <arg><replaceable>file...</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + <refsect1> + <title>Description</title> + <para> + ircp is a small utility to transfer files + from or to a remote Linux machine, Windows computer, or various PDAs + by using an infrared (IrDA) port. + It is designed for working e.g. with Quickbeam. + </para> + <para> + This program is designed to be an example application for the openobex + library. + </para> + </refsect1> + <refsect1> + <title>Options</title> + <variablelist> + <varlistentry> + <term><option>-r</option></term> + <listitem> + <para> + Use ircp to receive files. If destination is given, the + received files are stored in that directory; if not, the files + are copied to your current directory. + If this options is not given, the specified files are sent + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1> + <title>See also</title> + <para>irobex_palm3(1), irxfer(1)</para> + </refsect1> + </refentry> + + + <refentry> + <refmeta> + <refentrytitle>irobex_palm3</refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo class="manual">User commands</refmiscinfo> + </refmeta> + <refnamediv> + <refname>irobex_palm3</refname> + <refpurpose>Send to or receive files from a Palm handheld device</refpurpose> + </refnamediv> + <refsynopsisdiv> + <cmdsynopsis> + <command>irobex_palm3</command> + <arg choice="opt"><option>-h <replaceable>creator_id</replaceable></option></arg> + <arg choice="opt"><replaceable>file...</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + <refsect1> + <title>Description</title> + <para> + irobex_palm3 is a small utility to transfer files + from or to a Palm handheld device by using an infrared (IrDA) port. + If no parameter is specified, the program goes into receive mode. + </para> + <para> + This program is designed to be an example application for the openobex + library. + </para> + </refsect1> + <refsect1> + <title>Options</title> + <variablelist> + <varlistentry> + <term><option>-h</option></term> + <listitem> + <para> + Choose a creator ID, e.g. "memo", "addr", "todo", "date" or "Inch". + The id must be exactly 4 characters long and serves as hint for the + remote device and thus may be case-sensitive. The default is "memo". + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1> + <title>See also</title> + <para>ircp(1), irxfer(1)</para> + </refsect1> + </refentry> + + + <refentry> + <refmeta> + <refentrytitle>irxfer</refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo class="manual">User commands</refmiscinfo> + </refmeta> + <refnamediv> + <refname>irxfer</refname> + <refpurpose>Send to or receive files from a Palm handheld device</refpurpose> + </refnamediv> + <refsynopsisdiv> + <cmdsynopsis> + <command>irxfer</command> + <arg><replaceable>file</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + <refsect1> + <title>Description</title> + <para> + irxfer is a small utility to transfer files + by using an infrared (IrDA) port. It uses the "OBEX:IrXfer" identifier. + If no parameter is specified, the program goes into receive mode. + </para> + <para> + This program is designed to be an example application for the openobex + library. + </para> + </refsect1> + <refsect1> + <title>See also</title> + <para>ircp(1), irobex_palm3(1)</para> + </refsect1> + </refentry> + + + <refentry> + <refmeta> + <refentrytitle>obex_tcp</refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo class="manual">User commands</refmiscinfo> + </refmeta> + <refnamediv> + <refname>obex_tcp</refname> + <refpurpose>Send or receive files via TCP</refpurpose> + </refnamediv> + <refsynopsisdiv> + <cmdsynopsis> + <command>obex_tcp</command> + <arg><replaceable>file</replaceable></arg> + <arg><replaceable>target</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + <refsect1> + <title>Description</title> + <para> + obex_tcp is a small utility to transfer files + from or to a remote machine. The target is either an IPv4 numeric address + or a hostname. + If no parameter is specified, the program goes into receive mode. + </para> + <para> + This program is designed to be an example application for the openobex + library. + </para> + </refsect1> + </refentry> + + + <refentry> + <refmeta> + <refentrytitle>obex_test</refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo class="manual">User commands</refmiscinfo> + </refmeta> + <refnamediv> + <refname>obex_test</refname> + <refpurpose>interactive test application for the openobex library</refpurpose> + </refnamediv> + <refsynopsisdiv> + <cmdsynopsis> + <command>obex_test</command> + <group> + <arg> + <option>-s</option> + <replaceable>port</replaceable> + </arg> + <arg> + <option>-r</option> + <replaceable>port</replaceable> + </arg> + <arg><option>-i</option></arg> + <arg> + <option>-b</option> + <replaceable><optional>address</optional></replaceable> + <replaceable><optional>channel</optional></replaceable> + </arg> + <arg> + <option>-u</option> + <replaceable>interface</replaceable> + </arg> + </group> + </cmdsynopsis> + </refsynopsisdiv> + <refsect1> + <title>Description</title> + <para> + obex_test is a test application for the openobex + library. It uses an interactive mode but the access method is + selcted with command line arguments. + </para> + <para> + This program is designed to be an example application for the openobex + library. + </para> + </refsect1> + <refsect1> + <title>Options</title> + <variablelist> + <varlistentry> + <term><option>-s</option></term> + <listitem> + <para> + This is the default. It selects cable obex. + The port argument is optional (default: /dev/ttyS0) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>-r</option></term> + <listitem> + <para> + Select cable obex for the Ericsson R320 mobile phone. + The port argument is optional (default: /dev/ttyS0) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>-i</option></term> + <listitem> + <para> + Select obex over IrDA. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>-b</option></term> + <listitem> + <para> + Select obex over bluetooth. Both, address and channel are actually + optional. Default channel is 4, default address is ANY. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>-u</option></term> + <listitem> + <para> + Select usb obex (CDC). If the interface argument is omitted, + a list of available interface is written to stdout. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1> + <title>Interactive Mode: Commands</title> + <variablelist> + <varlistentry> + <term><option>c</option></term> + <listitem> + <para>connect to the remote side (client mode)</para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term><option>d</option></term> + <listitem> + <para>disconnect from the remote side</para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term><option>g</option></term> + <listitem> + <para>issue a GET request</para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term><option>p</option></term> + <listitem> + <para>issue a PUT request</para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term><option>q</option></term> + <listitem> + <para>quit the program</para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term><option>s</option></term> + <listitem> + <para>go into server mode</para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term><option>t</option></term> + <listitem> + <para>change the path on the remote side</para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term><option>x</option></term> + <listitem> + <para>issue a PUSH request</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + </refentry> +</reference> -- 1.5.6.5 |