File: owfs.man

package info (click to toggle)
owfs 3.2p3+dfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster
  • size: 8,688 kB
  • sloc: ansic: 65,085; pascal: 5,957; tcl: 2,688; makefile: 1,357; python: 1,114; sh: 891; cs: 623; php: 600; perl: 587; java: 404; ruby: 289; cpp: 105; asm: 102; xml: 53
file content (341 lines) | stat: -rw-r--r-- 6,090 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
'\"
'\" Copyright (c) 2003-2008 Paul H Alfille, MD
'\" (paul.alfille@gmail.com)
'\"
'\" Program manual page for the OWFS -- 1-wire filesystem package
'\" Based on Dallas Semiconductor, Inc's datasheets, and trial and error.
'\"
'\" Free for all use. No warranty. None. Use at your own risk.
'\"
.TH OWFS 5 2006 "OWFS Configuration File Manpage" "One-Wire File System"
.SH NAME
.B owfs.conf
\- owfs programs configuration file
.SH SYNOPSIS
An OWFS configuration file is specified on the command line:
.TP 
.B owfs -c config_file [other options]
The file name is arbitrary, there is no default configuration file used.
.SH USAGE
A configuration file can be invoked for any of the OWFS programs (
.B owfs (1) owhttpd (1) owserver (1) owftpd (1)
) or any of the language bindings (
.B owperl (1) owcapi (1) owtcl (1) owphp owpython
) to set command line parameters.
.SH SYNTAX
.P
Similar to Unix shell script or perl syntax
.TP
Comments
# Any 
.I #
marks the start of a comment
.br
# blank lines are ignored

.TP
Options
.B option 
# some options (like 'foreground') take no values
.br
.B option = value 
# other options need a value
.br
.B option value   
# '=' can be omitted if whitespace separates
.br
.B Option
# Case is ignored (for options, not values)
.br
.B opt            
# non-ambiguous abbreviation allowed
.br
.B -opt --opt     
# hyphens ignored
.TP
.I owserver
.B server: 
opt = value # only
.I owserver
effected by this line
.br
.B ! server: 
opt = value # 
.I owserver
NOT effected by this line
.TP
.I owhttpd
.B http: 
opt = value # only
.I owhttpd
effected by this line
.br
.B ! http: 
opt = value # 
.I owhttpd
NOT effected by this line
.TP
.I owftpd
.B ftp: 
opt = value # only
.I owftpd
effected by this line
.br
.B ! ftp: 
opt = value # 
.I owftpd
NOT effected by this line
.TP
.I owfs
.B owfs: 
opt = value # only
.I owfs
effected by this line
.br
.B ! owfs: 
opt = value # 
.I owfs
NOT effected by this line
.TP
Limits
# maximum line length of 250 characters
.br
# no limit on number of lines
.SH "DESCRIPTION"
.so man5/description.5so
.SS Configuration
.B owfs.conf (5)
allows a uniform set of command line parameters to be set.
.P
Not all OWFS programs use the same command line options, but the non-relevant ones will be ignored.
.P
Command line and configuration options can mixed. They will be invoked in the order presented. Left to right for the command line. Top to bottom for the configuration file.
.P
Configuration files can call other configuration files. There is an arbitrary depth of 5 levels to prevent infinite loops. More than one configuration file can be specified.
.SH SAMPLE
.TP
Here is a sample configuration file with all the possible parameters included.
#
.B Sources
.br
.I device
= /dev/ttyS0 # serial port: DS9097U DS9097 ECLO or LINK
.br
.I device
= /dev/i2c-0 # i2c port: DS2482-100 or DS2482-800
.br
.I usb
#       USB device: DS9490 PuceBaboon
.br
.I usb
= 2 #   Second DS9490
.br
.I usb
= all # All DS9490s
.br
.I altUSB
# Willy Robison's tweaks
.br
.I LINK
= /dev/ttyS0 #     serial LINK in ascii mode
.br
.I LINK
= [address:]port # LINK-HUB-E (tcp access)
.br
.I HA7
# HA7Net autodiscovery mode
.br
.I HA7
= address[:port] # HA7Net at tcp address (port 80)
.br
.I etherweather
= address[:port] # Etherweather device
.br
.I server
= [address:]port #
.B owserver
tcp address
.br
.I FAKE
= 10,1B # Random simulated device with family codes (hex)
.br
.I TESTER
= 28,3E # Predictable simulated device with family codes
.br
#
.br
#
.B Sinks
.br
# #
.B owfs
specific
.br
.I mountpoint
= filelocation #
.I FUSE
mount point
.br
.I allow_other #
Short hand for
.I FUSE
mount option "\"\-o allow_other\""
.br
# #
.B owhttpd owserver owftpd
specific
.br
.I port
= [address:]port # tcp out port
.br
#
.br
#
.B Temperature scales
.br
.I Celsius
# default
.br
.I Fahrenheit
.br
.I Kelvin
.br
.I Rankine
.br
#
.br
#
.B Timeouts (all in seconds)
.br
#                    cache for values that change on their own
.br
.I timeout_volatile
= value # seconds "volatile" values remain in cache
.br
#                    cache for values that change on command
.br
.I timeout_stable
= value # seconds "stable" values remain in cache
.br
#                    cache for directory lists (non-alarm)
.br
.I timeout_directory
= value # seconds "directory" values remain in cache
.br
#                    cache for 1-wire device location
.br
.I timeout_presence
= value # seconds "device presence" (which bus)
.br
.I timeout_serial
= value # seconds to wait for serial response
.br
.I timeout_usb
= value # seconds to wait for USB response
.br
.I timeout_network
= value # seconds to wait for tcp/ip response
.br
.I timeout_ftp
= value # seconds inactivity before closing ftp session
.br
#
.br
#
.B Process control
.br
.I configuration
= filename # file (like this) of program options
.br
.I pid_file
= filename # file to store PID number
.br
.I foreground
.br
.I background
# default
.br
.I readonly
# prevent changing 1-wire device contents
.br
.I write
# default
.br
.I error_print
= 0-3 # 0-mixed 1-syslog 2-stderr 3-suppressed
.br
.I error_level
= 0-9 # increasing noise
.br
#
.br
#
.B zeroconf / Bonjour
.br
.I zero
#   turn on zeroconf announcement (default)
.br
.I nozero
#   turn off zeroconf announcement
.br
. I announce
= name  # name of announced service (optional)
.br
.I autoserver
#   Add owservers descovered by zeroconf/Bonjour
.br
.I noautoserver
#   Don't use zeroconf/Bonjour owservers (default)
.br
#
.br
#
.B tcp persistence
.br
.I timeout_persistent_low
= 600 # minimum time a persistent socket will stay open
.br
.I timeout_persistent_high
= 3600 # max time an idle client socket will stay around
.br
.I
.br
#
.br
#
.B Display
.br
.I format
= f[.]i[[.]c] # 1-wire address
.I f
amily
.I i
d code
.I c
rc
.br
#
.br
#
.B Cache
.br
.I cache_size
= 1000000 # maximum cache size (in bytes) or 0 for no limit (default 0)
#
.br
#
.B Information
.br
# (silly in a configuration file)
.br
.I version
.br
.I help
.br
.I morehelp
.SH SEE ALSO
.so man5/seealso.5so
.SH AVAILABILITY
http://www.owfs.org
.SH AUTHOR
Paul Alfille (paul.alfille@gmail.com)