Skip to content

Commit

Permalink
man: add some default man pages
Browse files Browse the repository at this point in the history 
Signed-off-by: Robin Getz <[email protected]>
  • Loading branch information
@rgetz
rgetz committed Feb 4, 2020
1 parent 3c7d514 commit 7f96e80
Show file tree
Hide file tree
Showing 9 changed files with 790 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,9 @@ if(WITH_DOC)
endif()
endif()

option(WITH_MAN "Generate on-line reference manuals (man pages)" OFF)
add_subdirectory(man)

# Create an installer if compiling for OSX
if(OSX_PACKAGE)
set(LIBIIO_PKG ${CMAKE_CURRENT_BINARY_DIR}/libiio-${VERSION}.g${LIBIIO_VERSION_GIT}.pkg)
Expand Down
31 changes: 31 additions & 0 deletions man/CMakeLists.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
if (WITH_MAN)
find_program(BASH_EXECUTABLE bash)
find_program(DATE_EXECUTABLE date)
execute_process(
COMMAND ${DATE_EXECUTABLE} "+%d %B %Y"
OUTPUT_VARIABLE CMAKE_DATE OUTPUT_STRIP_TRAILING_WHITESPACE)
execute_process(
COMMAND ${BASH_EXECUTABLE} "-c" "${CMAKE_CURRENT_SOURCE_DIR}/make_man.sh > ${CMAKE_BINARY_DIR}/libiio.3.in"
)
configure_file(
${CMAKE_BINARY_DIR}/libiio.3.in
${CMAKE_BINARY_DIR}/man/libiio.3 @ONLY)

if (WITH_TESTS)
configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/iio_attr.1.in ${CMAKE_BINARY_DIR}/man/iio_attr.1 @ONLY)
configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/iio_info.1.in ${CMAKE_BINARY_DIR}/man/iio_info.1 @ONLY)
configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/iio_readdev.1.in ${CMAKE_BINARY_DIR}/man/iio_readdev.1 @ONLY)
configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/iio_reg.1.in ${CMAKE_BINARY_DIR}/man/iio_reg.1 @ONLY)
configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/iio_writedev.1.in ${CMAKE_BINARY_DIR}/man/iio_writedev.1 @ONLY)
endif()
# install man files into the BINARY directories,
# section 3 = library functions
install(DIRECTORY ${CMAKE_BINARY_DIR}/man/
DESTINATION ${CMAKE_INSTALL_MANDIR}/man3
COMPONENT doc FILES_MATCHING PATTERN "*.3*")
# section 1 = user commands
install(DIRECTORY ${CMAKE_BINARY_DIR}/man/
DESTINATION ${CMAKE_INSTALL_MANDIR}/man1
COMPONENT doc FILES_MATCHING PATTERN "*.1*")

endif()
8 changes: 8 additions & 0 deletions man/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# README for the man pages for libiio

The man pages are all manually maintained, except for the libiio.3 man page, which is autogenerated from the header file.

If you have questions, please ask on the github issue tracker
https://github.com/analogdevicesinc/libiio/issues


122 changes: 122 additions & 0 deletions man/iio_attr.1.in
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
.\" Copyright (c) 2018-2020 Robin Getz
.\" Copyright (c) 2018-2020 Analog Devices Inc.
.\"
.\" %%%LICENSE_START(GPLv2+_DOC_FULL)
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public
.\" License along with this manual; if not, see
.\" <http://www.gnu.org/licenses/>.
.\" %%%LICENSE_END
.\"
.TH iio_attr 1 "@CMAKE_DATE@" "libiio-@LIBIIO_VERSION_MAJOR@.@LIBIIO_VERSION_MINOR@" "LibIIO Utilities"
.IX iio_attr
.SH NAME
iio_attr \- list IIO devices, and read/write device attributes
.SH SYNOPSIS
.B iio_attr
[
.I options
]
-d [device] [attr] [value]
.br
.B iio_attr
[
.I options
]
-c [device] [channel] [attr] [value]
.br
.B iio_attr
[
.I options
]
-D [device] [attr] [value]
.br
.B iio_attr
[
.I options
]
-C [attr]
.SH DESCRIPTION
.B iio_attr
is a utility for displaying information about local or remote IIO devices.
By providing an optional value,
.B iio_attr
will attempt to write the new value to the attribute.

.SH OPTIONS
.TP
.B \-h, \-\-help
Tells
.I iio_attr
to display some help, and then quit.
.TP
.B \-I, \-\-ignore-case
When pattern matching devices, channels or attributes, ignore case
.TP
.B \-a, \-\-auto
Look around for devices (locally, and usb), and if there is only one device
found, connect to it.
.TP
.B \-u, \-\-uri
The Uniform Resource Identifier
.I (uri)
for connecting to devices, can be one of:
.RS
.IP ip:[address]
network address, either numeric (192.168.0.1) or network hostname
.IP ip:
blank, if compiled with zeroconf support, will find an IIO device on network
.IP usb:[device:port:instance]
normally returned from
.B iio_info -s
.IP serial:[port]
.IP local
with no address part
.RE
.TP
.B \-i, \-\-input-channel
Filters channels by input channels only
.TP
.B \-o, \-\-output-channel
Filters channels by output channels only
.TP
.B \-s, \-\-scan-channel
Filters channels by scan channels only

.SH RETURN VALUE
If the specified device is not found, a non-zero exit code is returned.

.SH "SEE ALSO"
.ad l
.BR iio_attr (1),
.BR iio_info (1),
.BR iio_readdev (1),
.BR iio_reg (1),
.BR iio_writedev (1),
.BR libiio (3)
.PP
libiio home page:
.BR \%https://wiki.analog.com/resources/tools-software/linux-software/libiio
.PP
libiio code:
.BR \%https://github.com/analogdevicesinc/libiio
.PP
Doxygen for libiio
.BR \%https://analogdevicesinc.github.io/libiio/
.SH BUGS
All bugs are tracked at:
.BR \%https://github.com/analogdevicesinc/libiio/issues
109 changes: 109 additions & 0 deletions man/iio_info.1.in
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
.\" Copyright (c) 2018-2020 Robin Getz
.\" Copyright (c) 2018-2020 Analog Devices Inc.
.\"
.\" %%%LICENSE_START(GPLv2+_DOC_FULL)
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public
.\" License along with this manual; if not, see
.\" <http://www.gnu.org/licenses/>.
.\" %%%LICENSE_END
.\"
.TH iio_info 1 "@CMAKE_DATE@" "libiio-@LIBIIO_VERSION_MAJOR@.@LIBIIO_VERSION_MINOR@" "LibIIO Utilities"
.IX iio_info
.SH NAME
iio_info \- list IIO devices and device attributes
.SH SYNOPSIS
.B iio_info
[
.I options
]
-x <xml_file>
.br
.B iio_info
[
.I options
]
-n <hostname>
.br
.B iio_info
[
.I options
]
-u <uri>
.SH DESCRIPTION
.B iio_info
is a utility for displaying information about local or remote IIO devices

.SH OPTIONS
.TP
.B \-h, \-\-help
Tells
.I iio_info
to display some help, and then quit.
.TP
.B \-x, \-\-xml
Use the XML backend with the provided XML file
.TP
.B \-n, \-\-network
Use the network backend with the provided hostname
.TP
.B \-u, \-\-uri
The Uniform Resource Identifier
.I (uri)
for connecting to devices, can be one of:
.RS
.IP ip:[address]
network address, either numeric (192.168.0.1) or network hostname
.IP ip:
blank, if compiled with zeroconf support, will find an IIO device on network
.IP usb:[device:port:instance]
normally returned from
.B iio_info -s
.IP serial:[port]
.IP local
with no address part
.RE
.TP
.B \-s, \-\-scan
Scan for available backends
.TP
.B \-a, \-\-auto
Scan for available contexts and if only one is available use it.

.SH RETURN VALUE
If the specified device is not found, a non-zero exit code is returned.

.SH "SEE ALSO"
.ad l
.BR iio_attr (1),
.BR iio_info (1),
.BR iio_readdev (1),
.BR iio_reg (1),
.BR iio_writedev (1),
.BR libiio (3)
.PP
libiio home page:
.BR \%https://wiki.analog.com/resources/tools-software/linux-software/libiio
.PP
libiio code:
.BR \%https://github.com/analogdevicesinc/libiio
.PP
Doxygen for libiio
.BR \%https://analogdevicesinc.github.io/libiio/
.SH BUGS
All bugs are tracked at:
.BR \%https://github.com/analogdevicesinc/libiio/issues
Loading

0 comments on commit 7f96e80

Please sign in to comment.