summaryrefslogtreecommitdiffabout
path: root/doc/iiid.8.in
Unidiff
Diffstat (limited to 'doc/iiid.8.in') (more/less context) (ignore whitespace changes)
-rw-r--r--doc/iiid.8.in106
1 files changed, 106 insertions, 0 deletions
diff --git a/doc/iiid.8.in b/doc/iiid.8.in
new file mode 100644
index 0000000..63a941e
--- a/dev/null
+++ b/doc/iiid.8.in
@@ -0,0 +1,106 @@
1.TH iiid 8 "March 8th, 2009" "iiid(8)" "Klever Group (http://www.klever.net/)"
2.hla en
3
4.SH NAME
5
6iiid \- An eye-fi card management daemon
7
8.SH SYNOPSYS
9
10\fBiiid\fR
11[\fB-h\fR] [\fB--help\fR] [\fB--usage\fR]
12[\fB-V\fR] [\fB--version\fR]
13[\fB-L\fR] [\fB--license\fR]
14[\fB-p\fR \fIport\fR] [\fB--port=\fR\fIport\fR]
15
16.SH DESCRIPTION
17
18iiid daemon is a minimalistic open source eye-fi management daemon
19implementation. It is listening for incoming connections and accepts files from
20eye-fi card, optionally invoking scripts to sort out files or send out
21notifications.
22
23.SH OPTIONS
24
25.TP
26\fB-p\fR \fIport\fR, \fB--port=\fR\fIport\fR
27Set the port to listen to. You're not likely to ever need to change this,
28perhaps for debugging purpose or if you want to proxy connections.
29.TP
30\fB-h\fR, \fB--help\fR, \fB--usage\fR
31Display short usage instructions and exit.
32.TP
33\fB-V\fR, \fB--version\fR
34Report version and exit.
35.TP
36\fB-L\fR, \fB--license\fR
37Show licensing terms.
38
39.SH EXIT STATUS
40
41The daemon isn't supposed to exit at this point, but, like most executables, it returns zero in case of success, non-zero otherwise.
42
43.SH FILES
44
45.TP
46@sysconfdir@/iii/\fBXXXXXXXXXXXX.conf/fR
47Upon successfull connection, the daemon reads the configuration from this file,
48where XXXXXXXXXXXX is the macaddress of your eyefi card. You can lookup the mac
49address of your card in your Mac/Windows Settings.xml file. Be sure to remove
50dashes from it.
51
52.SH CONFIGURATION OPTIONS
53
54.TP
55\fBtargetdir\fR = "\fI/var/lib/iii/%s/\fR"
56Sets the target directory for uploaded files. If the \fI%s\fR placeholder is
57present in the string, it is replaced with card mac address.
58.TP
59\fBuploadkey\fR = "\fIxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\fR"
60The upload key as seen in Mac/Windows Settings.xml file.
61.TP
62\fBon-start-session\fR = "\fIlogger iii-StartSession ${EYEFI_MACADDRESS} ${EYEFI_TRANSFER_MODE} ${EYEFI_TRANSFERMODETIMESTAMP}\fR"
63The command to execute on \fBStartSession\fR request. The command receives some
64information via environment variables.
65.TP
66\fBon-upload-photo\fR = "\fIlogger iii-UploadPhoto ${EYEFI_MACADDRESS} ${EYEFI_UPLOADED}\fR"
67The command to execute after successfull photo upload. The information about
68the card mac address and uploaded file name is passed via environment
69variables.
70.TP
71\fBon-mark-last-photo-in-roll\fR = "\fIlogger iii-MarkLastPhotoInRoll ${EYEFI_MACADDRESS} ${EYEFI_MERGEDELTA}\fR"
72The command to execute on \fBMarkLastPhotoInRoll\fR request. The information
73about request is passed via environment variables.
74.TP
75\fBumask\fR = \fI002\fR
76The file mode creation mask.
77
78.SH AUTHOR
79
80Written by Michael Krelin <hacker@klever.net>
81
82.SH COPYRIGHT
83
84Copyright (c) 2009 Klever Group (http://www.klever.net/)
85
86Permission is hereby granted, free of charge, to any person obtaining a copy of
87this software and associated documentation files (the "Software"), to deal in
88the Software without restriction, including without limitation the rights to
89use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
90of the Software, and to permit persons to whom the Software is furnished to do
91so, subject to the following conditions:
92
93The above copyright notice and this permission notice shall be included in all
94copies or substantial portions of the Software.
95
96THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
97IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
98FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
99AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
100LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
101OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
102SOFTWARE.
103
104.SH BUGS
105
106You tell me. Send reports to <iii-bugs@klever.net>