hal: Branch 'master'
David Zeuthen
david at kemper.freedesktop.org
Mon Mar 26 20:50:03 PDT 2007
configure.in | 10 +++
doc/Makefile.am | 2
doc/man/Makefile.am | 13 ++++
doc/man/hal-find-by-capability.1.in | 66 ++++++++++++++++++++++
doc/man/hal-find-by-property.1.in | 69 +++++++++++++++++++++++
doc/man/hal-get-property.1.in | 72 ++++++++++++++++++++++++
doc/man/hal-set-property.1.in | 106 ++++++++++++++++++++++++++++++++++++
doc/man/hald.1.in | 104 +++++++++++++++++++++++++++++++++++
doc/man/lshal.1.in | 61 ++++++++++++++++++++
9 files changed, 502 insertions(+), 1 deletion(-)
New commits:
diff-tree da3c08720658f65cb19edf08112ae1d865165253 (from 35d4c8d611c76c65d8e0126785ee65f937570925)
Author: David Zeuthen <davidz at redhat.com>
Date: Mon Mar 26 23:50:03 2007 -0400
add manual pages
diff --git a/configure.in b/configure.in
index d0efffe..a7a34f4 100644
--- a/configure.in
+++ b/configure.in
@@ -137,6 +137,8 @@ AC_DEFINE_UNQUOTED(HAL_GROUP,"$HAL_GROUP
AC_ARG_ENABLE(ansi, [ --enable-ansi enable -ansi -pedantic gcc flags],enable_ansi=$enableval,enable_ansi=no)
AC_ARG_ENABLE(verbose-mode, [ --enable-verbose-mode support verbose debug mode],enable_verbose_mode=$enableval,enable_verbose_mode=$USE_MAINTAINER_MODE)
AC_ARG_ENABLE(docbook-docs, [ --enable-docbook-docs build documentation (requires xmlto)],enable_docbook_docs=$enableval,enable_docbook_docs=no)
+AC_ARG_ENABLE(man-pages, [ --enable-man-pages build manual pages],enable_man_pages=$enableval,enable_man_pages=yes)
+AM_CONDITIONAL(MAN_PAGES_ENABLED, test x$enable_man_pages = xyes)
GTK_DOC_CHECK([1.3])
@@ -852,6 +854,13 @@ doc/api/libhal-storage/Makefile
doc/api/libhal-storage/version.xml
doc/spec/Makefile
doc/spec/hal-spec.xml.in
+doc/man/Makefile
+doc/man/hald.1
+doc/man/lshal.1
+doc/man/hal-get-property.1
+doc/man/hal-set-property.1
+doc/man/hal-find-by-property.1
+doc/man/hal-find-by-capability.1
po/Makefile.in
])
@@ -911,6 +920,7 @@ echo "
Building verbose mode: ${enable_verbose_mode}
Building api docs: ${enable_gtk_doc}
Building docs: ${enable_docbook_docs}
+ Building man pages: ${enable_man_pages}
"
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 991ba5f..7e073bd 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,7 +1,7 @@
EXTRA_DIST = TODO
-SUBDIRS = api spec
+SUBDIRS = api spec man
MAINTAINERCLEANFILES = \
*~ \
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
new file mode 100644
index 0000000..475db03
--- /dev/null
+++ b/doc/man/Makefile.am
@@ -0,0 +1,13 @@
+
+if MAN_PAGES_ENABLED
+
+MAN_IN_FILES = hald.1.in lshal.1.in hal-get-property.1.in hal-set-property.1.in hal-find-by-property.1.in hal-find-by-capability.1.in
+
+man_MANS = hald.1 lshal.1 hal-get-property.1 hal-set-property.1 hal-find-by-property.1 hal-find-by-capability.1
+
+endif # MAN_PAGES_ENABLED
+
+EXTRA_DIST=$(man_MANS) $(MAN_IN_FILES)
+
+clean-local:
+ rm -f *~
diff --git a/doc/man/hal-find-by-capability.1.in b/doc/man/hal-find-by-capability.1.in
new file mode 100644
index 0000000..5d7e155
--- /dev/null
+++ b/doc/man/hal-find-by-capability.1.in
@@ -0,0 +1,66 @@
+.\"
+.\" hal-find-by-capability manual page.
+.\" Copyright (C) 2007 David Zeuthen <david at fubar.dk>
+.\"
+.TH HAL-FIND-BY-CAPABILITY 1
+.SH NAME
+hal-find-by-capability \- find device objects by capability matching
+.SH SYNOPSIS
+.PP
+.B hal-find-by-capability
+[options]
+
+.SH DESCRIPTION
+
+\fIhal-get-capability\fP finds device object in
+the
+.B HAL
+device database by looking at device capabilities. For
+more information about both the big picture and specific
+.B HAL
+properties, refer to the \fIHAL spec\fP which can be found in
+.I "/usr/share/doc/hal-0.5.9/spec/hal-spec.html"
+depending on the distribution.
+
+.SH OPTIONS
+The following options are supported:
+.TP
+.I "--capability"
+The name of the capability.
+.TP
+.I "--verbose"
+Verbose output.
+.TP
+.I "--help"
+Print out usage.
+.TP
+.I "--version"
+Print the version.
+
+.SH RETURN VALUE
+.PP
+If devices matching the given capability are found each UDI (\fIUnique
+Device Identifier\fP) is printed on stdout and the program exits with
+exit code 0. If no devices are found or an error occured, the program
+exits with a non-zero exit code.
+
+.SH BUGS
+.PP
+Please send bug reports to either the distribution or the HAL
+mailing list, see
+.I "http://lists.freedesktop.org/mailman/listinfo/hal"
+on how to subscribe.
+
+.SH SEE ALSO
+.PP
+\&\fIhald\fR\|(1),
+\&\fIlshal\fR\|(1),
+\&\fIhal-set-property\fR\|(1),
+\&\fIhal-get-property\fR\|(1),
+\&\fIhal-find-by-property\fR\|(1),
+\&\fIdbus-send\fR\|(1)
+
+.SH AUTHOR
+Written by David Zeuthen <david at fubar.dk> with a lot of help from many
+others.
+
diff --git a/doc/man/hal-find-by-property.1.in b/doc/man/hal-find-by-property.1.in
new file mode 100644
index 0000000..0dd29c3
--- /dev/null
+++ b/doc/man/hal-find-by-property.1.in
@@ -0,0 +1,69 @@
+.\"
+.\" hal-find-by-property manual page.
+.\" Copyright (C) 2007 David Zeuthen <david at fubar.dk>
+.\"
+.TH HAL-FIND-BY-PROPERTY 1
+.SH NAME
+hal-find-by-property \- find device objects by property matching
+.SH SYNOPSIS
+.PP
+.B hal-find-by-property
+[options]
+
+.SH DESCRIPTION
+
+\fIhal-get-property\fP finds device object in
+the
+.B HAL
+device database by looking at device properties. For
+more information about both the big picture and specific
+.B HAL
+properties, refer to the \fIHAL spec\fP which can be found in
+.I "/usr/share/doc/hal-0.5.9/spec/hal-spec.html"
+depending on the distribution.
+
+.SH OPTIONS
+The following options are supported:
+.TP
+.I "--key"
+The name of the property.
+.TP
+.I "--string"
+String value of the property
+.TP
+.I "--verbose"
+Verbose output.
+.TP
+.I "--help"
+Print out usage.
+.TP
+.I "--version"
+Print the version.
+
+.SH RETURN VALUE
+.PP
+If devices matching the given property are found each UDI (\fIUnique
+Device Identifier\fP) is printed on stdout and the program exits with
+exit code 0. If no devices are found or an error occured, the program
+exits with a non-zero exit code.
+
+.SH BUGS
+.PP
+Please send bug reports to either the distribution or the HAL
+mailing list, see
+.I "http://lists.freedesktop.org/mailman/listinfo/hal"
+on how to subscribe.
+
+.SH SEE ALSO
+.PP
+\&\fIhald\fR\|(1),
+\&\fIlshal\fR\|(1),
+\&\fIhal-set-property\fR\|(1),
+\&\fIhal-get-property\fR\|(1),
+\&\fIhal-find-by-capability\fR\|(1),
+\&\fIdbus-send\fR\|(1)
+
+.SH AUTHOR
+Written by David Zeuthen <david at fubar.dk> with a lot of help from many
+others.
+
diff --git a/doc/man/hal-get-property.1.in b/doc/man/hal-get-property.1.in
new file mode 100644
index 0000000..d61e459
--- /dev/null
+++ b/doc/man/hal-get-property.1.in
@@ -0,0 +1,72 @@
+.\"
+.\" hal-get-property manual page.
+.\" Copyright (C) 2007 David Zeuthen <david at fubar.dk>
+.\"
+.TH HAL-GET-PROPERTY 1
+.SH NAME
+hal-get-property \- get a property from a device object
+.SH SYNOPSIS
+.PP
+.B hal-get-property
+[options]
+
+.SH DESCRIPTION
+
+\fIhal-get-property\fP retrieves a property from a device object in
+the
+.B HAL
+device database. For
+more information about both the big picture and specific
+.B HAL
+properties, refer to the \fIHAL spec\fP which can be found in
+.I "/usr/share/doc/hal-0.5.9/spec/hal-spec.html"
+depending on the distribution.
+
+.SH OPTIONS
+The following options are supported:
+.TP
+.I "--udi"
+The UDI (\fIUnique Device Identifier\fP) of the device object.
+.TP
+.I "--key"
+The name of the property.
+.TP
+.I "--hex"
+Show int32/uint64 values in hex (without a leading 0x).
+.TP
+.I "--verbose"
+Verbose output.
+.TP
+.I "--help"
+Print out usage.
+.TP
+.I "--version"
+Print the version.
+
+.SH RETURN VALUE
+.PP
+If both the property and device object exists the value of the
+property is printed on
+.I stdout
+and the program will exit with exit code 0. Otherwise the exit code
+will be non-zero.
+
+.SH BUGS
+.PP
+Please send bug reports to either the distribution or the HAL
+mailing list, see
+.I "http://lists.freedesktop.org/mailman/listinfo/hal"
+on how to subscribe.
+
+.SH SEE ALSO
+.PP
+\&\fIhald\fR\|(1),
+\&\fIlshal\fR\|(1),
+\&\fIhal-set-property\fR\|(1),
+\&\fIhal-find-by-property\fR\|(1),
+\&\fIhal-find-by-capability\fR\|(1)
+
+.SH AUTHOR
+Written by David Zeuthen <david at fubar.dk> with a lot of help from many
+others.
+
diff --git a/doc/man/hal-set-property.1.in b/doc/man/hal-set-property.1.in
new file mode 100644
index 0000000..2c4294c
--- /dev/null
+++ b/doc/man/hal-set-property.1.in
@@ -0,0 +1,106 @@
+.\"
+.\" hal-set-property manual page.
+.\" Copyright (C) 2007 David Zeuthen <david at fubar.dk>
+.\"
+.TH HAL-SET-PROPERTY 1
+.SH NAME
+hal-set-property \- set a property on a device object
+.SH SYNOPSIS
+.PP
+.B hal-set-property
+[options]
+
+.SH DESCRIPTION
+
+\fIhal-set-property\fP sets a property on a device object in
+the
+.B HAL
+device database. For
+more information about both the big picture and specific
+.B HAL
+properties, refer to the \fIHAL spec\fP which can be found in
+.I "/usr/share/doc/hal-0.5.9/spec/hal-spec.html"
+depending on the distribution.
+
+.SH OPTIONS
+The following options are supported:
+.TP
+.I "--udi"
+The UDI (\fIUnique Device Identifier\fP) of the device object.
+.TP
+.I "--key"
+The name of the property.
+.TP
+.I "--int"
+Set value property of the property to a 32-bit signed integer. The
+value passed is assumed to be decimal unless it's prefixed with
+.B 0x
+or
+.B x
+for hexadecimal values.
+.TP
+.I "--uint64"
+Set value property of the property to a 64-bit unsigned integer. The
+value passed is assumed to be decimal unless it's prefixed with
+.B 0x
+or
+.B x
+for hexadecimal values.
+.TP
+.I "--string"
+Set value property of the property to a string.
+.TP
+.I "--double"
+Set value property of the property to a floating point number.
+.TP
+.I "--bool"
+Set value property of the property to boolean, e.g.
+.B true
+or
+.B false.
+.TP
+.I "--strlist-pre"
+Prepend an item to a string list.
+.TP
+.I "--strlist-post"
+Append an item to a string list.
+.TP
+.I "--strlist-rem"
+Remove an item from a string list.
+.TP
+.I "--remove"
+Remove a property.
+.TP
+.I "--help"
+Print out usage.
+.TP
+.I "--version"
+Print the version.
+
+.SH RETURN VALUE
+.PP
+If setting the property succeeds, this program will exit with exit
+code 0. On errors a non-zero the program will exit with a non-zero
+exit code. Note that setting properties on the
+.B HAL
+device database usually requires super user privileges.
+
+.SH BUGS
+.PP
+Please send bug reports to either the distribution or the HAL
+mailing list, see
+.I "http://lists.freedesktop.org/mailman/listinfo/hal"
+on how to subscribe.
+
+.SH SEE ALSO
+.PP
+\&\fIhald\fR\|(1),
+\&\fIlshal\fR\|(1),
+\&\fIhal-get-property\fR\|(1),
+\&\fIhal-find-by-property\fR\|(1),
+\&\fIhal-find-by-capability\fR\|(1)
+
+.SH AUTHOR
+Written by David Zeuthen <david at fubar.dk> with a lot of help from many
+others.
+
diff --git a/doc/man/hald.1.in b/doc/man/hald.1.in
new file mode 100644
index 0000000..d7bf88b
--- /dev/null
+++ b/doc/man/hald.1.in
@@ -0,0 +1,104 @@
+.\"
+.\" hald manual page.
+.\" Copyright (C) 2007 David Zeuthen <david at fubar.dk>
+.\"
+.TH HALD 1
+.SH NAME
+hald \- HAL daemon
+.SH SYNOPSIS
+.PP
+.B hald
+[options]
+
+.SH DESCRIPTION
+
+\fIhald\fP is a daemon that maintains a database of the devices
+connected to the system system in real-time. The daemon connects to
+the \fID-Bus\fP system message bus to provide an API that applications
+can use to discover, monitor and invoke operations on devices. For
+more information about both the big picture and specific API details,
+refer to the \fIHAL spec\fP which can be found in
+.I "/usr/share/doc/hal- at VERSION@/spec/hal-spec.html"
+depending on the distribution.
+
+.SH OPTIONS
+The following options are supported:
+.TP
+.I "--daemon=yes|no"
+Specify whether to run in the foreground or the background.
+.TP
+.I "--verbose=yes|no"
+Enable verbose debug output.
+.TP
+.I "--help"
+Print out usage.
+.TP
+.I "--version"
+Print the version of the daemon and exit.
+
+.SH BUGS AND DEBUGGING
+.PP
+Please send bug reports to either the distribution or the HAL
+mailing list, see
+.I "http://lists.freedesktop.org/mailman/listinfo/hal"
+on how to subscribe.
+
+First, to obtain useful debug traces you will need to have
+.B debuginfo
+packages installed. On a Fedora system this is in the
+.B hal-debuginfo
+package and can be installed via the
+.I yum
+update program.
+
+Second, shut down the existing
+.B hald
+daemon instance; on a Fedora system this is achieved by
+
+.I "/etc/init.d/haldaemon stop"
+
+After having shut down the daemon, you might want to run
+
+.I "pkill hald"
+
+to ensure that all the helper processe of
+.B hald
+are killed too. To start the HAL daemon, use
+
+.I "/usr/sbin/hald --daemon=no --verbose=yes"
+
+If the daemon crashes, you can start it under a debugger via
+
+.I "gdb /usr/sbin/hald"
+
+and then typing
+
+.I "run --daemon=no --verbose=yes"
+
+at the
+.B "(gdb)"
+prompt. To capture a back trace, use the
+.B "bt"
+command and attach this to the bug report.
+
+Please also attach the output of \&\fIlshal\fR\|(1) in the bug report
+if possible (it's not possible if the
+.B "hald"
+daemon crashed). If the nature of the bug has to do with hotplugging,
+attach two outputs of \&\fIlshal\fR\|(1) - one before the device
+hotplug event and one after.
+
+.SH SEE ALSO
+.PP
+\&\fIudev\fR\|(7),
+\&\fIdbus-daemon\fR\|(1),
+\&\fIlshal\fR\|(1),
+\&\fIhal-set-property\fR\|(1),
+\&\fIhal-get-property\fR\|(1),
+\&\fIhal-find-by-property\fR\|(1),
+\&\fIhal-find-by-capability\fR\|(1)
+
+.SH AUTHOR
+Written by David Zeuthen <david at fubar.dk> with a lot of help from many
+others.
+
diff --git a/doc/man/lshal.1.in b/doc/man/lshal.1.in
new file mode 100644
index 0000000..3f1e6a5
--- /dev/null
+++ b/doc/man/lshal.1.in
@@ -0,0 +1,61 @@
+.\"
+.\" lshal manual page.
+.\" Copyright (C) 2007 David Zeuthen <david at fubar.dk>
+.\"
+.TH LSHAL 1
+.SH NAME
+lshal \- list HAL devices
+.SH SYNOPSIS
+.PP
+.B lshal
+[options]
+
+.SH DESCRIPTION
+
+\fIlshal\fP is a utility for displaying items in the
+.B HAL
+device database. For
+more information about both the big picture and specific
+.B HAL
+properties, refer to the \fIHAL spec\fP which can be found in
+.I "/usr/share/doc/hal- at VERSION@/spec/hal-spec.html"
+depending on the distribution.
+
+.SH OPTIONS
+The following options are supported:
+.TP
+.I "-m, --monitor"
+Print changes emitted by the
+.B hald
+daemon.
+.TP
+.I "-s, --short"
+Short output.
+.TP
+.I "-t, --tree"
+Display the devices organized in a tree.
+.TP
+.I "-u, --show"
+Show only the given UDI (\fIUnique Device Identifier\fP).
+.TP
+.I "-h, --help"
+Print out usage.
+.TP
+.I "-V, --version"
+Print the version.
+
+.SH BUGS
+.PP
+Please send bug reports to either the distribution or the HAL
+mailing list, see
+.I "http://lists.freedesktop.org/mailman/listinfo/hal"
+on how to subscribe.
+
+.SH SEE ALSO
+.PP
+\&\fIhald\fR\|(1), \&\fIudev\fR\|(7), \&\fIdbus-daemon\fR\|(1)
+
+.SH AUTHOR
+Written by David Zeuthen <david at fubar.dk> with a lot of help from many
+others.
+
More information about the hal-commit
mailing list