'\" t .\" Title: obexpushd .\" Author: Hendrik Sattler .\" Generator: DocBook XSL Stylesheets v1.75.2 .\" Date: 2010-11-02 .\" Manual: User commands .\" Source: obexpushd 0.11 .\" Language: English .\" .TH "OBEXPUSHD" "1" "2010-11-02" "obexpushd 0.11" "User commands" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" obexpushd \- receive files with OBEX protocol via Bluetooth, IrDA or network connection .SH "SYNOPSIS" .HP \w'\fBobexpushd\fR\ 'u \fBobexpushd\fR [\fB\-B\fR\ \fI[[[address]:]channel]\fR] [\fB\-I\fR\fI[app]\fR] [\fB\-N\fR\ \fI[[[address]:]port]\fR] [\fB\-p\fR\ \fIfile\fR] [\fB\-A\fR] [\fB\-a\fR\ \fIfile\fR] [\fB\-o\fR\ \fIdirectory\fR] [\fB\-s\fR\ \fIfile\fR] [\fB\-n\fR | \fB\-d\fR] [\fB\-h\fR | \fB\-v\fR] .SH "DESCRIPTION" .PP obexpushd is a program that can be used to receive files using OBEX (OBject EXchange) protocol over Bluetooth, IrDA or network connection\&. It can be used to receive files from mobile phones and other devices\&. .PP When run without \-d or \-n options obexpushd puts itself to the background and starts to listen for incoming connections via Bluetooth (default) and/or IrDA and/or network connection(TCP)\&. obexpushd saves all received files to it\*(Aqs current directory but can alternativly forward all received data to a script for further processing\&. .SH "OPTIONS" .PP \fB\-B\fR .RS 4 Listen to Bluetooth connections\&. It is possible to specify an address of a local adapter and a channel number to listen to\&. Default is to use \fIchannel\fR 9\&. The \fIaddress\fR can be either a bluetooth adapter interface name (e\&.g\&. "hci0"), only the number of that interface (e\&.g\&. "0") or the interface address enclosed in brackets (e\&.g\&. "[11:22:33:44:55:66]")\&. .RE .PP \fB\-I\fR .RS 4 Listen to IrDA connections on the default inbox and, in addition and optionally, to the inbox identified by \fIapp\fR (example: IrXfer) .RE .PP \fB\-N\fR .RS 4 Listen to network connections\&. If compiled with TcpOBEX support (openobex > 1\&.3), it is possible to specify an address and a port number to listen to (default: *:650)\&. Note that to bind to the default TCP OBEX port, you need root priviledges\&. The \fIaddress\fR can either be an IPv4 address in quad\-dot\-notation (e\&.g\&. "127\&.0\&.0\&.1"), an IPv6 address enclosed in brackets (e\&.g\&. "[::1]") or a "*" as alias for "[::]"\&. .RE .PP \fB\-p\fR .RS 4 Write the process ID of the daemon to \fIfile\fR .RE .PP \fB\-A\fR .RS 4 Enable special security/filter support that is special to the transport layer\&. For bluetooth, this enforces bluetooth pairing (does not conform to protocol specification)\&. For TCP, this enables usage of hosts\&.allow and hosts\&.deny files\&. .RE .PP \fB\-a\fR .RS 4 Read \fIuser\fR:\fIpassword\fR pairs from each line of \fIfile\fR\&. Note that many client cannot handle authentication and will stop working when using this option\&. Note that no encoding is used, the plain byte sequence will be matched\&. .RE .PP \fB\-o\fR .RS 4 Use \fIdirectory\fR for files to read or write\&. This option only affects file output (not scripts)\&. If this option is not specified, the current working directory ("\&.") is used\&. .RE .PP \fB\-s\fR .RS 4 Open pipes to the script or program specified by \fIfile\fR\&. These pipes are seen by the program as stdin and stdout\&. There is one argument which is one of the following: .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} put .sp This requests data to be stored to a specific file\&. obexpushd is waiting for an acknoledge after the list of parameters\&. The script must either print a line with "OK" to stdout to get the data on stdin or a line with any other content to reject the transfer\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} get .sp This requests a specific file to be sent to stdout\&. Just exit the script with a non\-zero exit status to reject the transfer\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} listdir .sp This requests a directory listing to be sent to stdout\&. You can use the provided obex\-folder\-listing to achieve a correctly formatted listing\&. Just exit the script with a non\-zero exit status to reject the transfer\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} capability .sp This requests an obex capability object (XML formatted data) to be sent to stdout\&. Just exit the script with a non\-zero exit status to reject the transfer\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} createdir .sp This requests creation of a new directory\&. No data is transferred\&. Just exit the script with a non\-zero exit status to reject the request\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} delete .sp This requests deletion of a file\&. No data is transferred\&. Just exit the script with a non\-zero exit status to reject the request\&. .RE .sp Further parameters are fed to the script via stdin\&. Parameters that are transmitted via stdin or stdout have the form "\fIParameter\fR: \fIvalue\fR"\&. The first empty line seperates parameters and data\&. The empty line can be the first line\&. In this case, no parameters are present\&. Line delimiter is system specific\&. The possible parameters are: .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} "From: \fItype\fR/\fIclient\-identifier\fR" .sp This specifies the client address\&. Currently, types can be "bluetooth", "irda", "tcp" or "usb"\&. .sp Usage: always present on stdin\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} "Name: \fIutf8\-string\fR" .sp This specifies the file name\&. .sp Usage: present on stdin for "put", "get" and "delete"\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} "Length: \fIuint32\fR" .sp This specifies the amount of data in bytes in the data section that follows\&. .sp Usage: required on stdout for "get", else optional\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} "Type: \fIascii\-string\fR" .sp This specifies the mime type of the data\&. .sp Usage: completely optional\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} "Time: \fItime\-string\fR" .sp This defines a time stamp where \fItime\-string\fR is a time in ISO\-8601 format (YYYYMMDDThhmmssZ)\&. .sp Usage: completely optional\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} "Path: \fIascii\-string\fR" .sp This defines a relative path to the published base directory\&. .sp Usage: present on stdin for "put", "get", "listdir", "createdir" and "delete"\&. .RE .sp Unknown parameters shall be ignored\&. .RE .PP \fB\-n\fR .RS 4 Do not detach from terminal\&. .RE .PP \fB\-d\fR .RS 4 Enable debug messages (implies \-n)\&. .RE .PP \fB\-h\fR .RS 4 Show summary of options\&. .RE .PP \fB\-v\fR .RS 4 Show version of program\&. .RE .SH "AUTHORS" .PP \fBHendrik Sattler\fR <\&post@hendrik-sattler.de\&> .RS 4 conversion to docbook, all other changes .RE .PP \fBEugeniy Meshcheryakov\fR <\&eugen@debian.org\&> .RS 4 texted the first version of the obexpushd manpage .RE