Hi Paul,
Can you consider applying the two patches (in attachment).
* fix-manpage-generation.patch: this patch ensure that included files
are really included at the right place
* manpage-typo.patch: this patch fixes many typo (found by Debian
automatic QA tool, ie lintian)
Regards,
Vincent
PS: I'm working on the ruby bindings, improving the current implementation.
I will submit it to this list soon.
--
Vincent Danjean Adresse: Laboratoire d'Informatique de Grenoble
Téléphone: +33 4 76 61 20 11 ENSIMAG - antenne de Montbonnot
Fax: +33 4 76 61 20 99 ZIRST 51, avenue Jean Kuntzmann
Email: vincent.danj...@imag.fr 38330 Montbonnot Saint Martin
Fix inclusion of common part
- includes done in reverse order so that address are always correct
(ie not modified by previous includes)
- add "-" to ed script to go back one line (to insert at the right place)
--- a/src/man/Makefile.am
+++ b/src/man/Makefile.am
@@ -50,13 +50,13 @@
list="$$list $$i"; \
done; \
for manfile in $$list; do \
- for i in `sed -n '2,$$ s/^.so //p' $(DESTDIR)/$$manfile`; do \
- printf "%s\n" H /$$i/d ".r $(srcdir)/$$i" g/^.\\\\\"/d ",w" | ed -s $(DESTDIR)/$$manfile ; \
+ for i in `sed -n '2,$$ s/^.so //p' $(DESTDIR)/$$manfile | tac`; do \
+ printf "%s\n" H /$$i/d - ".r $(srcdir)/$$i" g/^.\\\\\"/d ",w" | ed -s $(DESTDIR)/$$manfile ; \
done; \
done; \
for manfile in $$list; do \
- for i in `sed -n '2,$$ s/^.so //p' $(DESTDIR)/$$manfile`; do \
- printf "%s\n" H /$$i/d ".r $(srcdir)/$$i" g/^.\\\"/d ",w" | ed -s $(DESTDIR)/$$manfile ; \
+ for i in `sed -n '2,$$ s/^.so //p' $(DESTDIR)/$$manfile | tac`; do \
+ printf "%s\n" H /$$i/d - ".r $(srcdir)/$$i" g/^.\\\"/d ",w" | ed -s $(DESTDIR)/$$manfile ; \
done; \
done
Fix many typo in manpages found by lintian
--- a/src/man/DS1971.3
+++ b/src/man/DS1971.3
@@ -1 +1 @@
-.so DS2430A.3
+.so man3/DS2430A.3
--- a/src/man/DS2406.3
+++ b/src/man/DS2406.3
@@ -10,7 +10,7 @@
'\"
.TH DS2406 3 2003 "OWFS Manpage" "One-Wire File System"
.SH NAME
-DS2406 \- Dual Addressable Switch with 1kbit Memory
+DS2406, DS2407 \- Dual Addressable Switch with 1kbit Memory
.SH SYNOPSIS
Dual Switch, Write-once Memory
.PP
--- a/src/man/DS2755.3
+++ b/src/man/DS2755.3
@@ -10,7 +10,7 @@
'\"
.TH DS2755 3 2003 "OWFS Manpage" "One-Wire File System"
.SH NAME
-DS2755 \- Multichemistry Battery Fuel Gauge
+DS2755, DS2756 \- Multichemistry Battery Fuel Gauge
.SH SYNOPSIS
Temperature Voltage, Current, Memory, and Switch.
.PP
--- a/src/man/DS2760.3
+++ b/src/man/DS2760.3
@@ -10,7 +10,7 @@
'\"
.TH DS2760 3 2003 "OWFS Manpage" "One-Wire File System"
.SH NAME
-DS2760 \- High-Precision Li+ Battery Monitor
+DS2760, DS2761, DS2762 \- High-Precision Li+ Battery Monitor
.SH SYNOPSIS
Temperature Voltage and Current.
.PP
--- a/src/man/EEEF.3
+++ b/src/man/EEEF.3
@@ -8,9 +8,9 @@
'\" Free for all use. No waranty. None. Use at your own risk.
'\" $Id: EEEF.3,v 1.4 2011/03/09 02:17:39 alfille Exp $
'\"
-.TH HobbyBoards EE/EF 3 2009 "OWFS Manpage" "One-Wire File System"
+.TH HobbyBoards_EE/EF 3 2009 "OWFS Manpage" "One-Wire File System"
.SH NAME
-EEEF \-HobbyBoards EE/EF Microprocessor-based slaves
+EEEF \- HobbyBoards EE/EF Microprocessor-based slaves
.br
UVI \- Ultra Violet (UV) Index sensor
.SH SYNOPSIS
--- a/src/man/Makefile.am
+++ b/src/man/Makefile.am
@@ -33,9 +33,8 @@
owperl.3 \
owtcl.3 \
owfs.5 owfs.conf.5 \
- owtcl.n ow.n \
- *.?so
-EXTRA_DIST = ${man_MANS}
+ ow.3
+EXTRA_DIST = ${man_MANS} *.?so
install-data-am: install-man install-so-man
--- a/src/man/device.1so
+++ b/src/man/device.1so
@@ -86,22 +86,22 @@
.P
There are also bus masters based on the serial chip with a USB to serial conversion built in. These are supported by the serial bus master protocol.
.TP
-.I -u \fR|\ \fI--usb
+.I \-u \fR|\ \fI\-\-usb
DS2490 based bus master (like the DS9490R).
.TP
-.I -u2 \fR|\ \fI--usb=2
+.I \-u2 \fR|\ \fI\-\-usb=2
Use the second USB bus master. (The order isn't predicatble, however, since the operating system does not conssitently order USB devices).
.TP
-.I -uall \fR|\ \fI--usb=ALL
+.I \-uall \fR|\ \fI\-\-usb=ALL
Use all the USB devices.
.TP
-.I --usb_flextime | --usb_regulartime
+.I \-\-usb_flextime | \-\-usb_regulartime
Changes the details of 1-wire waveform timing for certain network configurations.
.TP
-.I --altusb
+.I \-\-altusb
Willy Robion's alternative USB timing.
.TP
-.I --timeout_usb=5
+.I \-\-timeout_usb=5
Timeout for USB communications. This has a 5 second default and can be changed dynamically under
.I /settings/timeout/usb
.SH "* I2C devices"
@@ -123,13 +123,13 @@
for i2c masters have the form
.I /dev/i2c-0, /dev/i2c-1, ...
.TP
-\fI-d port\fR | \fI--device=port
+\fI\-d port\fR | \fI\-\-device=port
This simple form only permits a specific
.I port
and the first available
.I i2c_address
.TP
-\fI--i2c=port\fR | \fI--i2c=port:i2c_address\fR | \fI--i2c=port:ALL
+\fI\-\-i2c=port\fR | \fI\-\-i2c=port:i2c_address\fR | \fI\-\-i2c=port:ALL
Specific i2c
.I port
and the
@@ -138,7 +138,7 @@
.I i2c_address
is 0,1,2,...
.TP
-\fI--i2c\fR | \fI--i2c=:\fR | \fI--i2c=ALL:ALL
+\fI\-\-i2c\fR | \fI\-\-i2c=:\fR | \fI\-\-i2c=ALL:ALL
Search the available i2c buses for either the first, the first, or every i2c adapter.
.P
The
@@ -154,26 +154,26 @@
.P
E.g. 192.168.0.1:3000 or localhost:3000
.TP
-.I --link=network_address
+.I \-\-link=network_address
LinkHubE network LINK adapter by
.B iButtonLink
.TP
-.I --ha7net=network_address | --ha7net
+.I \-\-ha7net=network_address | \-\-ha7net
HA7Net network 1-wire adapter with specified tcp address or discovered by udp multicast. By
.B Embedded Data Systems
.br
-.I --timeout_ha7=60
+.I \-\-timeout_ha7=60
specific timeout for HA7Net communications (60 second default).
.TP
-.I --etherweather=network_address
+.I \-\-etherweather=network_address
Etherweather adapter
.TP
-\fI-s network_address\fR | \fI--server=network_address
+\fI\-s network_address\fR | \fI\-\-server=network_address
Location of an
.B owserver (1)
program that talks to the 1-wire bus. The default port is 4304.
.TP
-.I --timeout_network=5
+.I \-\-timeout_network=5
Timeout for network bus master communications. This has a 1 second default and can be changed dynamically under
.I /settings/timeout/network
.SH "* Simulated devices"
@@ -193,16 +193,16 @@
DS2408,DS2489
The 1-wire device name. (Full ID cannot be speciifed in this format).
.TP
-.I --fake=devices
+.I \-\-fake=devices
Random address and random values for each read. The device ID is also random (unless specified).
.TP
-.I --temperature_low=12 --temperature_high=44
+.I \-\-temperature_low=12 \-\-temperature_high=44
Specify the temperature limits for the
.I fake
adapter simulation. These should be in the same temperature scale that is specified in the command line. It is possible to change the limits dynamically for each adapter under
.I /bus.x/interface/settings/simulated/[temperature_low|temperature_high]
.TP
-.I --tester=devices
+.I \-\-tester=devices
Predictable address and predictable values for each read. (See the website for the algorhythm).
.SH "* w1 kernel module"
This a linux-specific option for using the operating system's access to bus masters. Root access is required and the implementation was still in progress as of owfs v2.7p12 and linux 2.6.30.
@@ -211,9 +211,9 @@
.P
Access is restrict to superuser due to the netlink broadcast protocol employed by w1. Multitasking must be configured (threads) on the compilation.
.TP
-.I --w1
+.I \-\-w1
Use the linux kernel w1 virtual bus master.
.TP
-.I --timeout_w1=10
+.I \-\-timeout_w1=10
Timeout for w1 netlink communications. This has a 10 second default and can be changed dynamically under
.I /settings/timeout/w1
--- a/src/man/ow.n
+++ /dev/null
@@ -1,2 +0,0 @@
-.so owtcl.n
-
--- a/src/man/owhttpd.1
+++ b/src/man/owhttpd.1
@@ -46,15 +46,15 @@
.so timeout.1so
.SH EXAMPLE
.TP
-owhttpd -p 3001 -d /dev/ttyS0
+owhttpd \-p 3001 \-d /dev/ttyS0
Web server runs on tcp port 3001, serial adapter at ttyS0
.TP
-owhttpd -p 3001 -s littlehost:4304 --error_level=3
+owhttpd \-p 3001 \-s littlehost:4304 \-\-error_level=3
Web server on port 3001, from
.I owserver
process on host "littlehost", extensive error messages.
.TP
-owhttpd -p 3001 -u -u2 -r
+owhttpd \-p 3001 \-u \-u2 \-r
Read-only web server on port 3001, using two usb adapters.
.SH AVAILABILITY
http://www.owfs.org
--- a/src/man/owtcl.3
+++ b/src/man/owtcl.3
@@ -1,2 +1,398 @@
-.so owtcl.n
+'\"
+'\" The definitions below are for supplemental macros used in Tcl/Tk
+'\" manual entries.
+'\"
+'\" .AP type name in/out ?indent?
+'\" Start paragraph describing an argument to a library procedure.
+'\" type is type of argument (int, etc.), in/out is either "in", "out",
+'\" or "in/out" to describe whether procedure reads or modifies arg,
+'\" and indent is equivalent to second arg of .IP (shouldn't ever be
+'\" needed; use .AS below instead)
+'\"
+'\" .AS ?type? ?name?
+'\" Give maximum sizes of arguments for setting tab stops. Type and
+'\" name are examples of largest possible arguments that will be passed
+'\" to .AP later. If args are omitted, default tab stops are used.
+'\"
+'\" .BS
+'\" Start box enclosure. From here until next .BE, everything will be
+'\" enclosed in one large box.
+'\"
+'\" .BE
+'\" End of box enclosure.
+'\"
+'\" .CS
+'\" Begin code excerpt.
+'\"
+'\" .CE
+'\" End code excerpt.
+'\"
+'\" .VS ?br?
+'\" Begin vertical sidebar, for use in marking newly-changed parts
+'\" of man pages. If an argument is present, then a line break is
+'\" forced before starting the sidebar.
+'\"
+'\" .VE
+'\" End of vertical sidebar.
+'\"
+'\" .DS
+'\" Begin an indented unfilled display.
+'\"
+'\" .DE
+'\" End of indented unfilled display.
+'\"
+'\" .SO
+'\" Start of list of standard options for a Tk widget. The
+'\" options follow on successive lines, in four columns separated
+'\" by tabs.
+'\"
+'\" .SE
+'\" End of list of standard options for a Tk widget.
+'\"
+'\" .OP cmdName dbName dbClass
+'\" Start of description of a specific option. cmdName gives the
+'\" option's name as specified in the class command, dbName gives
+'\" the option's name in the option database, and dbClass gives
+'\" the option's class in the option database.
+'\"
+'\" .UL arg1 arg2
+'\" Print arg1 underlined, then print arg2 normally.
+'\"
+'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
+.if t .wh -1.3i ^B
+.nr ^l \n(.l
+.ad b
+'\" # Start an argument description
+.de AP
+.ie !'\\$4'' .TP \\$4
+.el \{\
+. ie !'\\$2'' .TP \\n()Cu
+. el .TP 15
+.\}
+.ie !'\\$3'' \{\
+.ta \\n()Au \\n()Bu
+\&\\$1 \\fI\\$2\\fP (\\$3)
+.\".b
+.\}
+.el \{\
+.br
+.ie !'\\$2'' \{\
+\&\\$1 \\fI\\$2\\fP
+.\}
+.el \{\
+\&\\fI\\$1\\fP
+.\}
+.\}
+..
+'\" # define tabbing values for .AP
+.de AS
+.nr )A 10n
+.if !'\\$1'' .nr )A \\w'\\$1'u+3n
+.nr )B \\n()Au+15n
+.\"
+.if !'\\$2'' .nr )B \\w'\\$2'u+\\n()Au+3n
+.nr )C \\n()Bu+\\w'(in/out)'u+2n
+..
+.AS Tcl_Interp Tcl_CreateInterp in/out
+'\" # BS - start boxed text
+'\" # ^y = starting y location
+'\" # ^b = 1
+.de BS
+.br
+.mk ^y
+.nr ^b 1u
+.if n .nf
+.if n .ti 0
+.if n \l'\\n(.lu\(ul'
+.if n .fi
+..
+'\" # BE - end boxed text (draw box now)
+.de BE
+.nf
+.ti 0
+.mk ^t
+.ie n \l'\\n(^lu\(ul'
+.el \{\
+.\" Draw four-sided box normally, but don't draw top of
+.\" box if the box started on an earlier page.
+.ie !\\n(^b-1 \{\
+\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
+.\}
+.el \}\
+\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
+.\}
+.\}
+.fi
+.br
+.nr ^b 0
+..
+'\" # VS - start vertical sidebar
+'\" # ^Y = starting y location
+'\" # ^v = 1 (for troff; for nroff this doesn't matter)
+.de VS
+.if !'\\$1'' .br
+.mk ^Y
+.ie n 'mc \s12\(br\s0
+.el .nr ^v 1u
+..
+'\" # VE - end of vertical sidebar
+.de VE
+.ie n 'mc
+.el \{\
+.ev 2
+.nf
+.ti 0
+.mk ^t
+\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
+.sp -1
+.fi
+.ev
+.\}
+.nr ^v 0
+..
+'\" # Special macro to handle page bottom: finish off current
+'\" # box/sidebar if in box/sidebar mode, then invoked standard
+'\" # page bottom macro.
+.de ^B
+.ev 2
+'ti 0
+'nf
+.mk ^t
+.if \\n(^b \{\
+.\" Draw three-sided box if this is the box's first page,
+.\" draw two sides but no top otherwise.
+.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
+.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
+.\}
+.if \\n(^v \{\
+.nr ^x \\n(^tu+1v-\\n(^Yu
+\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
+.\}
+.bp
+'fi
+.ev
+.if \\n(^b \{\
+.mk ^y
+.nr ^b 2
+.\}
+.if \\n(^v \{\
+.mk ^Y
+.\}
+..
+'\" # DS - begin display
+.de DS
+.RS
+.nf
+.sp
+..
+'\" # DE - end display
+.de DE
+.fi
+.RE
+.sp
+..
+'\" # SO - start of list of standard options
+.de SO
+.SH "STANDARD OPTIONS"
+.LP
+.nf
+.ta 4c 8c 12c
+.ft B
+..
+'\" # SE - end of list of standard options
+.de SE
+.fi
+.ft R
+.LP
+See the \\fBoptions\\fR manual entry for details on the standard options.
+..
+'\" # OP - start of full description for a single option
+.de OP
+.LP
+.nf
+.ta 4c
+Command-Line Name: \\fB\\$1\\fR
+Database Name: \\fB\\$2\\fR
+Database Class: \\fB\\$3\\fR
+.fi
+.IP
+..
+'\" # CS - begin code excerpt
+.de CS
+.RS
+.nf
+.ta .25i .5i .75i 1i
+..
+'\" # CE - end code excerpt
+.de CE
+.fi
+.RE
+..
+.de UL
+\\$1\l'|0\(ul'\\$2
+..
+.TH "Owtcl" 3 "20/January/2005" "Tcl"
+.SH NAME
+Owtcl \- OWFS library access commands for Tcl
+.SH SYNOPSIS
+\fBpackage \fBrequire \fBow
+.sp
+\fBow\fI \fIoption \fR?\fIarg ...\fR?
+.sp
+\fB::OW::init\fI \fIinterface \fR?\fIinterface ...\fR? \fR?\fIarg ...\fR?
+.br
+\fB::OW::finish
+.br
+\fB::OW::isconnect
+.br
+\fB::OW::get\fI \fR?\fIpath\fR? \fR?\fIarg ...\fR?
+.br
+\fB::OW::put\fI \fIpath \fR?\fIvalue\fR?
+.br
+\fB::OW::isdirectory\fI \fIpath
+.br
+\fB::OW::isdir\fI \fIpath
+.br
+\fB::OW::exists\fI \fIpath
+\fR
+.SH DESCRIPTION
+.so description.nso
+.SS owtcl
+.B owtcl (3)
+is a Tcl extension that provides an interface to OWFS. The underlying interface to the 1-wire bus is identical to
+.B owfs (1)
+(filesystem view) and
+.B owhttpd (1)
+web server interface. Only the top
+layer has been modified to return native Tcl data.
+.SH COMMANDS
+Performs one of several operations, depending on \fIoption\fR.
+The legal \fIoption\fRs (which may be abbreviated) are:
+.TP
+\fBow open \fIarg ...\fR
+Connect to 1-wire adapter or \fIowserver\fR. \fIarg ...\fR defines a way of
+connection to the 1-wire bus.
+.br
+The full set of initialization args is extensive. They correspond roughly to the command line args of
+.B owfs (1)
+.B owhttpd (1)
+and
+.B owftpd (1)
+
+.TP
+\fBow close
+Close connection to 1-wire bus or owserver.
+
+.TP
+\fBow version\fR ?\fI-list\fR?
+Return version of the owtcl and owlib/
+
+.TP
+\fBow opened
+Return 1 if connected to 1-wire adapter or \fIowserver\fR, otherwise 0.
+
+.TP
+\fBow error\fR \fIlevel\fR \fIvalue\fR
+Set debug options. See
+.B owfs (5)
+
+.TP
+\fBow error\fR \fIprint\fR \fIvalue\fR
+Set debug options. See
+.B owfs (5)
+
+.TP
+\fBow get\fR \fIpath\fR \fR?\fI-list\fR?
+Returns contents of OWFS directory as the list if path contains name OWFS directory.
+If path is name of OWFS file, returns of contents of this file. For files *.ALL
+returns a values list.
+
+
+.TP
+\fBow put \fIpath \fR\fIvalue\fR
+Puts \fIvalue\fR in OWFS file indicated in \fIpath\fR. For files *.ALL use a value
+list.
+
+.TP
+\fBow isdirectory \fIpath
+If \fIpath\fR is the directory return 1. Otherwise return 0.
+
+.TP
+\fBow isdir \fIpath
+Synonym of \fBow isdirectory
+
+.TP
+\fBow set \fIpath
+Creates a new \fBow\fR-like command with root in the \fIpath\fR.
+A new command allows options \fIget\fR, \fIput\fR, \fIisdirectory\fR, \fIisdir\fR and \fIset\fR.
+
+
+.SH LOW-LEVEL COMMANDS
+The following low-level commands are possible:
+.TP
+\fB::OW::init \fIinterface \fR?\fIinterface ...\fR? \fR?\fIarg ...\fR?
+Connect to 1-wire adapter or \fIowserver\fR. \fIinterface\fR and \fIarg ...\fR defines a way of
+connection to the 1-wire bus.
+.br
+The full set of initialization options is extensive. They correspond roughly to the command line options of
+,B owfs (1)
+.B owhttpd (1)
+and
+.B owftpd (1)
+
+.TP
+\fB::OW::finish
+Close connection to 1-wire bus or owserver.
+
+.TP
+\fB::OW::isconnect
+Return 1 if connected to 1-wire adapter or \fIowserver\fR, otherwise 0.
+
+.TP
+\fB::OW::get \fR?\fIpath\fR? \fR?\fI-list\fR?
+Returns contents of OWFS directory as the list if path contains name OWFS directory.
+If path is name of OWFS file, returns of contents of this file. For files *.ALL
+returns a values list. If path is not defined, contents of root OWFS directory come
+back.
+
+.TP
+\fB::OW::put \fIpath \fR?\fIvalue\fR?
+Puts \fIvalue\fR in OWFS file indicated in \fIpath\fR. For files *.ALL use a value
+list. If /fIvalue\fR is not defined, puts a empty string.
+
+.TP
+\fB::OW::isdirectory \fIpath
+If \fIpath\fR is the directory - return 1. Otherwise return 0.
+
+.TP
+\fB::OW::isdir \fIpath
+Synonym of \fB::OW::isdirectory
+
+.TP
+\fB::OW::exists \fIpath
+If \fIpath\fR is exists - return 1. Otherwise return 0.
+
+.SH EXAMPLE
+.CS
+package require ow
+
+ow open \-d /dev/ttyS0 \-t 60
+
+set save_templow [ow get /28.86BF80000000/templow]
+ow put /28.86BF80000000/templow 10
+
+set room_sensor [ow set /28.86BF80000000]
+$room_sensor put temphigh 50
+
+set room_temp [$room_sensor set temperature]
+set current_temp [$room_temp get]
+.CE
+
+.SH SEE ALSO
+.so seealso.nso
+.SH AVAILABILITY
+http://www.owfs.org
+.SH AUTHOR
+Serg Oskin (s...@oskin.ru)
+.sp
--- a/src/man/owtcl.n
+++ /dev/null
@@ -1,400 +0,0 @@
-'\"
-'\" The definitions below are for supplemental macros used in Tcl/Tk
-'\" manual entries.
-'\"
-'\" .AP type name in/out ?indent?
-'\" Start paragraph describing an argument to a library procedure.
-'\" type is type of argument (int, etc.), in/out is either "in", "out",
-'\" or "in/out" to describe whether procedure reads or modifies arg,
-'\" and indent is equivalent to second arg of .IP (shouldn't ever be
-'\" needed; use .AS below instead)
-'\"
-'\" .AS ?type? ?name?
-'\" Give maximum sizes of arguments for setting tab stops. Type and
-'\" name are examples of largest possible arguments that will be passed
-'\" to .AP later. If args are omitted, default tab stops are used.
-'\"
-'\" .BS
-'\" Start box enclosure. From here until next .BE, everything will be
-'\" enclosed in one large box.
-'\"
-'\" .BE
-'\" End of box enclosure.
-'\"
-'\" .CS
-'\" Begin code excerpt.
-'\"
-'\" .CE
-'\" End code excerpt.
-'\"
-'\" .VS ?br?
-'\" Begin vertical sidebar, for use in marking newly-changed parts
-'\" of man pages. If an argument is present, then a line break is
-'\" forced before starting the sidebar.
-'\"
-'\" .VE
-'\" End of vertical sidebar.
-'\"
-'\" .DS
-'\" Begin an indented unfilled display.
-'\"
-'\" .DE
-'\" End of indented unfilled display.
-'\"
-'\" .SO
-'\" Start of list of standard options for a Tk widget. The
-'\" options follow on successive lines, in four columns separated
-'\" by tabs.
-'\"
-'\" .SE
-'\" End of list of standard options for a Tk widget.
-'\"
-'\" .OP cmdName dbName dbClass
-'\" Start of description of a specific option. cmdName gives the
-'\" option's name as specified in the class command, dbName gives
-'\" the option's name in the option database, and dbClass gives
-'\" the option's class in the option database.
-'\"
-'\" .UL arg1 arg2
-'\" Print arg1 underlined, then print arg2 normally.
-'\"
-'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
-.if t .wh -1.3i ^B
-.nr ^l \n(.l
-.ad b
-'\" # Start an argument description
-.de AP
-.ie !'\\$4'' .TP \\$4
-.el \{\
-. ie !'\\$2'' .TP \\n()Cu
-. el .TP 15
-.\}
-.ie !'\\$3'' \{\
-.ta \\n()Au \\n()Bu
-\&\\$1 \\fI\\$2\\fP (\\$3)
-.\".b
-.\}
-.el \{\
-.br
-.ie !'\\$2'' \{\
-\&\\$1 \\fI\\$2\\fP
-.\}
-.el \{\
-\&\\fI\\$1\\fP
-.\}
-.\}
-..
-'\" # define tabbing values for .AP
-.de AS
-.nr )A 10n
-.if !'\\$1'' .nr )A \\w'\\$1'u+3n
-.nr )B \\n()Au+15n
-.\"
-.if !'\\$2'' .nr )B \\w'\\$2'u+\\n()Au+3n
-.nr )C \\n()Bu+\\w'(in/out)'u+2n
-..
-.AS Tcl_Interp Tcl_CreateInterp in/out
-'\" # BS - start boxed text
-'\" # ^y = starting y location
-'\" # ^b = 1
-.de BS
-.br
-.mk ^y
-.nr ^b 1u
-.if n .nf
-.if n .ti 0
-.if n \l'\\n(.lu\(ul'
-.if n .fi
-..
-'\" # BE - end boxed text (draw box now)
-.de BE
-.nf
-.ti 0
-.mk ^t
-.ie n \l'\\n(^lu\(ul'
-.el \{\
-.\" Draw four-sided box normally, but don't draw top of
-.\" box if the box started on an earlier page.
-.ie !\\n(^b-1 \{\
-\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
-.\}
-.el \}\
-\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
-.\}
-.\}
-.fi
-.br
-.nr ^b 0
-..
-'\" # VS - start vertical sidebar
-'\" # ^Y = starting y location
-'\" # ^v = 1 (for troff; for nroff this doesn't matter)
-.de VS
-.if !'\\$1'' .br
-.mk ^Y
-.ie n 'mc \s12\(br\s0
-.el .nr ^v 1u
-..
-'\" # VE - end of vertical sidebar
-.de VE
-.ie n 'mc
-.el \{\
-.ev 2
-.nf
-.ti 0
-.mk ^t
-\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
-.sp -1
-.fi
-.ev
-.\}
-.nr ^v 0
-..
-'\" # Special macro to handle page bottom: finish off current
-'\" # box/sidebar if in box/sidebar mode, then invoked standard
-'\" # page bottom macro.
-.de ^B
-.ev 2
-'ti 0
-'nf
-.mk ^t
-.if \\n(^b \{\
-.\" Draw three-sided box if this is the box's first page,
-.\" draw two sides but no top otherwise.
-.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
-.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
-.\}
-.if \\n(^v \{\
-.nr ^x \\n(^tu+1v-\\n(^Yu
-\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
-.\}
-.bp
-'fi
-.ev
-.if \\n(^b \{\
-.mk ^y
-.nr ^b 2
-.\}
-.if \\n(^v \{\
-.mk ^Y
-.\}
-..
-'\" # DS - begin display
-.de DS
-.RS
-.nf
-.sp
-..
-'\" # DE - end display
-.de DE
-.fi
-.RE
-.sp
-..
-'\" # SO - start of list of standard options
-.de SO
-.SH "STANDARD OPTIONS"
-.LP
-.nf
-.ta 4c 8c 12c
-.ft B
-..
-'\" # SE - end of list of standard options
-.de SE
-.fi
-.ft R
-.LP
-See the \\fBoptions\\fR manual entry for details on the standard options.
-..
-'\" # OP - start of full description for a single option
-.de OP
-.LP
-.nf
-.ta 4c
-Command-Line Name: \\fB\\$1\\fR
-Database Name: \\fB\\$2\\fR
-Database Class: \\fB\\$3\\fR
-.fi
-.IP
-..
-'\" # CS - begin code excerpt
-.de CS
-.RS
-.nf
-.ta .25i .5i .75i 1i
-..
-'\" # CE - end code excerpt
-.de CE
-.fi
-.RE
-..
-.de UL
-\\$1\l'|0\(ul'\\$2
-..
-.TH "Owtcl" TCL "20/January/2005" "Tcl"
-.HS table tk
-.BS
-.SH NAME
-Owtcl \- OWFS library access commands for Tcl
-.SH SYNOPSIS
-\fBpackage \fBrequire \fBow
-.sp
-\fBow\fI \fIoption \fR?\fIarg ...\fR?
-.sp
-\fB::OW::init\fI \fIinterface \fR?\fIinterface ...\fR? \fR?\fIarg ...\fR?
-.br
-\fB::OW::finish
-.br
-\fB::OW::isconnect
-.br
-\fB::OW::get\fI \fR?\fIpath\fR? \fR?\fIarg ...\fR?
-.br
-\fB::OW::put\fI \fIpath \fR?\fIvalue\fR?
-.br
-\fB::OW::isdirectory\fI \fIpath
-.br
-\fB::OW::isdir\fI \fIpath
-.br
-\fB::OW::exists\fI \fIpath
-\fR
-.SH DESCRIPTION
-.so description.nso
-.SS owtcl
-.B owtcl (3)
-is a Tcl extension that provides an interface to OWFS. The underlying interface to the 1-wire bus is identical to
-.B owfs (1)
-(filesystem view) and
-.B owhttpd (1)
-web server interface. Only the top
-layer has been modified to return native Tcl data.
-.SH COMMANDS
-Performs one of several operations, depending on \fIoption\fR.
-The legal \fIoption\fRs (which may be abbreviated) are:
-.TP
-\fBow open \fIarg ...\fR
-Connect to 1-wire adapter or \fIowserver\fR. \fIarg ...\fR defines a way of
-connection to the 1-wire bus.
-.br
-The full set of initialization args is extensive. They correspond roughly to the command line args of
-.B owfs (1)
-.B owhttpd (1)
-and
-.B owftpd (1)
-
-.TP
-\fBow close
-Close connection to 1-wire bus or owserver.
-
-.TP
-\fBow version\fR ?\fI-list\fR?
-Return version of the owtcl and owlib/
-
-.TP
-\fBow opened
-Return 1 if connected to 1-wire adapter or \fIowserver\fR, otherwise 0.
-
-.TP
-\fBow error\fR \fIlevel\fR \fIvalue\fR
-Set debug options. See
-.B owfs (5)
-
-.TP
-\fBow error\fR \fIprint\fR \fIvalue\fR
-Set debug options. See
-.B owfs (5)
-
-.TP
-\fBow get\fR \fIpath\fR \fR?\fI-list\fR?
-Returns contents of OWFS directory as the list if path contains name OWFS directory.
-If path is name of OWFS file, returns of contents of this file. For files *.ALL
-returns a values list.
-
-
-.TP
-\fBow put \fIpath \fR\fIvalue\fR
-Puts \fIvalue\fR in OWFS file indicated in \fIpath\fR. For files *.ALL use a value
-list.
-
-.TP
-\fBow isdirectory \fIpath
-If \fIpath\fR is the directory - return 1. Otherwise return 0.
-
-.TP
-\fBow isdir \fIpath
-Synonym of \fBow isdirectory
-
-.TP
-\fBow set \fIpath
-Creates a new \fBow\fR-like command with root in the \fIpath\fR.
-A new command allows options \fIget\fR, \fIput\fR, \fIisdirectory\fR, \fIisdir\fR and \fIset\fR.
-
-
-.SH LOW-LEVEL COMMANDS
-The following low-level commands are possible:
-.TP
-\fB::OW::init \fIinterface \fR?\fIinterface ...\fR? \fR?\fIarg ...\fR?
-Connect to 1-wire adapter or \fIowserver\fR. \fIinterface\fR and \fIarg ...\fR defines a way of
-connection to the 1-wire bus.
-.br
-The full set of initialization options is extensive. They correspond roughly to the command line options of
-,B owfs (1)
-.B owhttpd (1)
-and
-.B owftpd (1)
-
-.TP
-\fB::OW::finish
-Close connection to 1-wire bus or owserver.
-
-.TP
-\fB::OW::isconnect
-Return 1 if connected to 1-wire adapter or \fIowserver\fR, otherwise 0.
-
-.TP
-\fB::OW::get \fR?\fIpath\fR? \fR?\fI-list\fR?
-Returns contents of OWFS directory as the list if path contains name OWFS directory.
-If path is name of OWFS file, returns of contents of this file. For files *.ALL
-returns a values list. If path is not defined, contents of root OWFS directory come
-back.
-
-.TP
-\fB::OW::put \fIpath \fR?\fIvalue\fR?
-Puts \fIvalue\fR in OWFS file indicated in \fIpath\fR. For files *.ALL use a value
-list. If /fIvalue\fR is not defined, puts a empty string.
-
-.TP
-\fB::OW::isdirectory \fIpath
-If \fIpath\fR is the directory - return 1. Otherwise return 0.
-
-.TP
-\fB::OW::isdir \fIpath
-Synonym of \fB::OW::isdirectory
-
-.TP
-\fB::OW::exists \fIpath
-If \fIpath\fR is exists - return 1. Otherwise return 0.
-
-.SH EXAMPLE
-.CS
-package require ow
-
-ow open -d /dev/ttyS0 -t 60
-
-set save_templow [ow get /28.86BF80000000/templow]
-ow put /28.86BF80000000/templow 10
-
-set room_sensor [ow set /28.86BF80000000]
-$room_sensor put temphigh 50
-
-set room_temp [$room_sensor set temperature]
-set current_temp [$room_temp get]
-.CE
-
-.SH SEE ALSO
-.so seealso.nso
-.SH AVAILABILITY
-http://www.owfs.org
-.SH AUTHOR
-Serg Oskin (s...@oskin.ru)
-.sp
-
--- a/src/man/owperl.3
+++ b/src/man/owperl.3
@@ -48,7 +48,7 @@
.B owperl (3)
is a perl module that provides an interface to OWFS. The path to each 1-wire device is the same as
.B owfs (1)
-. Only the top layer has been modified to return native perl strings.
+\&. Only the top layer has been modified to return native perl strings.
.PP
.B owperl (3)
is created by
@@ -81,11 +81,11 @@
.I owhttpd
programs can access the
.I owserver
-process simultaneously. In fact, this will probably be the prefered mode of access to OWFS for
+process simultaneously. In fact, this will probably be the preferred mode of access to OWFS for
.I owperl
except in trivial applications.
.SH EXAMPLE
-perl -MOW -e "OW::init('/dev/ttyS1'); printf OW::get('\');"
+perl \-MOW \-e "OW::init('/dev/ttyS1'); printf OW::get('\');"
.SH SEE ALSO
.so seealso.3so
.SH AVAILABILITY
--- /dev/null
+++ b/src/man/ow.3
@@ -0,0 +1,2 @@
+.so man3/owtcl.3
+
--- a/src/man/OWNet.3
+++ b/src/man/OWNet.3
@@ -130,7 +130,7 @@
.if n .ad l
.nh
.SH "NAME"
-\&\fBOWNet\fR
+OWNet \-
Light weight access to \fBowserver\fR
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
--- a/src/man/owcapi.1
+++ b/src/man/owcapi.1
@@ -77,7 +77,7 @@
for full syntax.
.TP
.I Returns
-0 for success. -1 on error and
+0 for success. \-1 on error and
.I errno
will be set.
.I OW_finish
@@ -107,7 +107,7 @@
the arguments are in argv/argc format.
.TP
.I Returns
-0 for success. -1 on error and
+0 for success. \-1 on error and
.I errno
will be set.
.I OW_finish
@@ -130,7 +130,7 @@
is the path to the directory or file (property).
.TP
.I Returns
-0 on success. -1 on error (and
+0 on success. \-1 on error (and
.I errno
is set).
.TP
@@ -154,7 +154,7 @@
.I buffer
.TP
.I Returns
-number of bytes on success. -1 on error (and
+number of bytes on success. \-1 on error (and
.I errno
is set).
.TP
@@ -198,7 +198,7 @@
is the position in file to start reading.
.TP
.I Returns
-number of bytes on success. -1 on error (and
+number of bytes on success. \-1 on error (and
.I errno
is set).
.TP
@@ -221,7 +221,7 @@
is the length of the value
.I buffer.
.I Returns
-number of bytes on success. -1 on error (and
+number of bytes on success. \-1 on error (and
.I errno
is set).
.TP
@@ -256,7 +256,7 @@
is the position in file to start writing.
.TP
.I Returns
-number of bytes on success. -1 on error (and
+number of bytes on success. \-1 on error (and
.I errno
is set).
.TP
--- a/src/man/ownet.1
+++ b/src/man/ownet.1
@@ -10,7 +10,9 @@
'\"
.TH OWNET 1 2008 "OWFS Manpage" "One-Wire File System"
.SH NAME
-.B ownet (libownet)
+.B ownet
+,
+.B (libownet)
\- easy C-language 1-wire interface to the owserver protocol
.SH SYNOPSIS
.B libownet
@@ -163,7 +165,7 @@
for full syntax.
.TP
.I Returns
-0 for success. -1 on error and
+0 for success. \-1 on error and
.I errno
will be set.
.I OW_finish
@@ -193,7 +195,7 @@
the arguments are in argv/argc format.
.TP
.I Returns
-0 for success. -1 on error and
+0 for success. \-1 on error and
.I errno
will be set.
.I OW_finish
@@ -221,7 +223,7 @@
.I buffer
.TP
.I Returns
-number of bytes on success. -1 on error (and
+number of bytes on success. \-1 on error (and
.I errno
is set).
.TP
@@ -265,7 +267,7 @@
is the position in file to start reading.
.TP
.I Returns
-number of bytes on success. -1 on error (and
+number of bytes on success. \-1 on error (and
.I errno
is set).
.TP
@@ -288,7 +290,7 @@
is the length of the value
.I buffer.
.I Returns
-number of bytes on success. -1 on error (and
+number of bytes on success. \-1 on error (and
.I errno
is set).
.TP
@@ -323,7 +325,7 @@
is the position in file to start writing.
.TP
.I Returns
-number of bytes on success. -1 on error (and
+number of bytes on success. \-1 on error (and
.I errno
is set).
.TP
--- a/src/man/owshell.1
+++ b/src/man/owshell.1
@@ -10,7 +10,7 @@
'\"
.TH OWSHELL 1 2004 "OWSHELL Manpage" "One-Wire File System"
.SH NAME
-owshell \- lightweight owserver access
+owdir, owread, owwrite, owget, owpresent \- lightweight owserver access
.SH SYNOPSIS
.B owdir
.I -s
@@ -266,7 +266,7 @@
.I owserver
Temperature in fahrenheit.
.TP
-owwrite -\s 10.0.1.2:3001 32.000800AD23110/pages/page.1 "Passed"
+owwrite \-s 10.0.1.2:3001 32.000800AD23110/pages/page.1 "Passed"
Connect to a OWFS server process (
.I owserver
) that was started on another machine at tcp port 3001 and write to the memory of a DS2780
--- a/src/man/owtap.1
+++ b/src/man/owtap.1
@@ -57,7 +57,7 @@
TCP port or IPaddress:port for
.I owtap
.br
-Other OWFS programs will access owtap via this address. (e.g. owdir -s IP:port /)
+Other OWFS programs will access owtap via this address. (e.g. owdir \-s IP:port /)
.SS \-s
TCP port or IPaddress:port for
.I owserver
@@ -68,7 +68,7 @@
.B owserver (1)
is started:
.br
-.B owserver -p 4304 -d /dev/ttyS0
+.B owserver \-p 4304 \-d /dev/ttyS0
.br
owserver on tcp port 4304 and connects to a physical 1-wire bus on a serial port.
.PP
@@ -76,13 +76,13 @@
.B owserver (1)
with
.br
-.B owdir -s 4304 /
+.B owdir \-s 4304 /
.PP
To see the protocol in action:
.br
-.B owtap -s 4304 -p 3000
+.B owtap \-s 4304 \-p 3000
.br
-.B owdir -p 3000 /
+.B owdir \-p 3000 /
.PP
In this case
.B owtap (1)
--- a/src/man/libownet.1
+++ b/src/man/libownet.1
@@ -1 +1 @@
-.so ownet.1
+.so man1/ownet.1
--- a/src/man/ownetapi.1
+++ b/src/man/ownetapi.1
@@ -1 +1 @@
-.so ownet.1
+.so man1/ownet.1
--- a/src/man/ownetlib.1
+++ b/src/man/ownetlib.1
@@ -1 +1 @@
-.so ownet.1
+.so man1/ownet.1
--- a/src/man/owftpd.1
+++ b/src/man/owftpd.1
@@ -47,10 +47,10 @@
.so timeout.1so
.SH EXAMPLE
.TP
-owftpd -d /dev/ttyS0
+owftpd \-d /dev/ttyS0
Ftp server runs on default tcp port 21, serial adapter at ttyS0
.TP
-owftpd -s littlehost:4304 --error_level=3
+owftpd \-s littlehost:4304 \-\-error_level=3
Ftp server on default port 21, from
.B owserver (1)
process on host "littlehost", extensive error messages.
--- a/src/man/EDS.3
+++ b/src/man/EDS.3
@@ -168,11 +168,11 @@
.SS EDS006X/temperature
.I read-only, floating-point
.br
-Temperature for the EDS006X series of chips. In the -55C to 125C range, with 0.0636C precision. The temperature is read every second, continually. Data is presented in the specified temperature scale, Celsius by default.
+Temperature for the EDS006X series of chips. In the \-55C to 125C range, with 0.0636C precision. The temperature is read every second, continually. Data is presented in the specified temperature scale, Celsius by default.
.SS EDS007X/temperature
.I read-only, floating-point
.br
-Temperature for the EDS007X series of chips. Read using a wide-range precise RTD sensor. Typical range is -60C to 260C with 0.15C accuracy, although a range of -200C to 850C is possible. The temperature is read every second unless a longer
+Temperature for the EDS007X series of chips. Read using a wide-range precise RTD sensor. Typical range is \-60C to 260C with 0.15C accuracy, although a range of \-200C to 850C is possible. The temperature is read every second unless a longer
.I EDS007X/delay
is given. Data is presented in the specified temperature scale, Celsius by default.
.SS EDS007X/resistance
@@ -215,11 +215,11 @@
Ambient light in Lux. Measured every 0.2 seconds.
.SH PRESSURE
.SS EDS006X/pressure
-.read-only, floating-point
+.I read-only, floating-point
.br
Ambient pressure, measured every 0.2 seconds. Data in the selected pressure scale (default mBar).
.SS EDS006X/inHg
-.read-only, floating-point
+.I read-only, floating-point
.br
Ambient pressure, measured every 0.2 seconds. Data in the inHg scale.
.SH THRESHOLD
--- a/src/man/DS1963L.3
+++ b/src/man/DS1963L.3
@@ -10,7 +10,7 @@
'\"
.TH DS1963L 3 2003 "OWFS Manpage" "One-Wire File System"
.SH NAME
-DS1963L-\ 256 byte Monetary iButton
+DS1963L \- 256 byte Monetary iButton
.SH SYNOPSIS
Non-volatile R/W memory with counters
.PP
--- a/src/man/DS28EA00.3
+++ b/src/man/DS28EA00.3
@@ -10,7 +10,7 @@
'\"
.TH DS28EA00 3 2003 "OWFS Manpage" "One-Wire File System"
.SH NAME
-DS28EA00-\ 1-Wire Digital Thermometer with Sequence Detect and PIO
+DS28EA00 \- 1-Wire Digital Thermometer with Sequence Detect and PIO
.SH SYNOPSIS
Thermometer, PIO and Chain.
.PP
--- a/module/ownet/perl5/OWNet/lib/OWNet.pm
+++ b/module/ownet/perl5/OWNet/lib/OWNet.pm
@@ -10,7 +10,7 @@
=head1 NAME
-B<OWNet>
+OWNet -
Light weight access to B<owserver>
=head1 SYNOPSIS
------------------------------------------------------------------------------
Enable your software for Intel(R) Active Management Technology to meet the
growing manageability and security demands of your customers. Businesses
are taking advantage of Intel(R) vPro (TM) technology - will your software
be a part of the solution? Download the Intel(R) Manageability Checker
today! http://p.sf.net/sfu/intel-dev2devmar
_______________________________________________
Owfs-developers mailing list
Owfs-developers@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/owfs-developers
