diff -urNp hal-0.5.8.1.old/configure.in hal-0.5.8.1/configure.in --- hal-0.5.8.1.old/configure.in 2006-09-19 21:24:05.000000000 +0100 +++ hal-0.5.8.1/configure.in 2009-05-12 13:09:01.000000000 +0100 @@ -81,7 +81,7 @@ 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) GTK_DOC_CHECK([1.3]) @@ -404,7 +404,8 @@ fi AM_CONDITIONAL(DOCBOOK_DOCS_ENABLED, test x$enable_docbook_docs = xyes) AC_MSG_RESULT(yes) - +AM_CONDITIONAL(MAN_PAGES_ENABLED, [test x$enable_man_pages = xyes]) +AC_SUBST(MAN_PAGES_ENABLED) AS_AC_EXPAND(LOCALSTATEDIR, $localstatedir) AS_AC_EXPAND(SYSCONFDIR, $sysconfdir) @@ -525,6 +526,7 @@ fdi/policy/10osvendor/Makefile fdi/policy/20thirdparty/Makefile fdi/policy/30user/Makefile doc/Makefile +doc/man/Makefile doc/api/Makefile doc/conf/Makefile doc/spec/Makefile @@ -573,6 +575,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 -urNp hal-0.5.8.1.old/doc/Makefile.am hal-0.5.8.1/doc/Makefile.am --- hal-0.5.8.1.old/doc/Makefile.am 2006-09-19 21:23:25.000000000 +0100 +++ hal-0.5.8.1/doc/Makefile.am 2009-05-12 13:00:19.000000000 +0100 @@ -1,7 +1,7 @@ EXTRA_DIST = TODO -SUBDIRS = api spec conf +SUBDIRS = api spec conf man clean-local: rm -f *~ diff -urNp hal-0.5.8.1.old/doc/man/hald.8.in hal-0.5.8.1/doc/man/hald.8.in --- hal-0.5.8.1.old/doc/man/hald.8.in 1970-01-01 01:00:00.000000000 +0100 +++ hal-0.5.8.1/doc/man/hald.8.in 2009-05-12 13:10:12.000000000 +0100 @@ -0,0 +1,108 @@ +.\" +.\" hald manual page. +.\" Copyright (C) 2007 David Zeuthen <david@fubar.dk> +.\" +.TH HALD 8 +.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 "@docdir@/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 "--use-syslog" +Enable logging of debug output to the syslog instead of stderr. Use +this option only together with --verbose. +.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 "@sysconfdir@/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 "@sbindir@/hald --daemon=no --verbose=yes" + +If the daemon crashes, you can start it under a debugger via + +.I "gdb @sbindir@/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@fubar.dk> with a lot of help from many +others. + diff -urNp hal-0.5.8.1.old/doc/man/hal-find-by-capability.1.in hal-0.5.8.1/doc/man/hal-find-by-capability.1.in --- hal-0.5.8.1.old/doc/man/hal-find-by-capability.1.in 1970-01-01 01:00:00.000000000 +0100 +++ hal-0.5.8.1/doc/man/hal-find-by-capability.1.in 2009-05-12 12:58:12.000000000 +0100 @@ -0,0 +1,66 @@ +.\" +.\" hal-find-by-capability manual page. +.\" Copyright (C) 2007 David Zeuthen <david@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 "@docdir@/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\|(8), +\&\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@fubar.dk> with a lot of help from many +others. + diff -urNp hal-0.5.8.1.old/doc/man/hal-find-by-property.1.in hal-0.5.8.1/doc/man/hal-find-by-property.1.in --- hal-0.5.8.1.old/doc/man/hal-find-by-property.1.in 1970-01-01 01:00:00.000000000 +0100 +++ hal-0.5.8.1/doc/man/hal-find-by-property.1.in 2009-05-12 12:58:12.000000000 +0100 @@ -0,0 +1,69 @@ +.\" +.\" hal-find-by-property manual page. +.\" Copyright (C) 2007 David Zeuthen <david@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 "@docdir@/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\|(8), +\&\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@fubar.dk> with a lot of help from many +others. + diff -urNp hal-0.5.8.1.old/doc/man/hal-get-property.1.in hal-0.5.8.1/doc/man/hal-get-property.1.in --- hal-0.5.8.1.old/doc/man/hal-get-property.1.in 1970-01-01 01:00:00.000000000 +0100 +++ hal-0.5.8.1/doc/man/hal-get-property.1.in 2009-05-12 12:58:12.000000000 +0100 @@ -0,0 +1,72 @@ +.\" +.\" hal-get-property manual page. +.\" Copyright (C) 2007 David Zeuthen <david@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 "@docdir@/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\|(8), +\&\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@fubar.dk> with a lot of help from many +others. + diff -urNp hal-0.5.8.1.old/doc/man/hal-set-property.1.in hal-0.5.8.1/doc/man/hal-set-property.1.in --- hal-0.5.8.1.old/doc/man/hal-set-property.1.in 1970-01-01 01:00:00.000000000 +0100 +++ hal-0.5.8.1/doc/man/hal-set-property.1.in 2009-05-12 12:58:12.000000000 +0100 @@ -0,0 +1,106 @@ +.\" +.\" hal-set-property manual page. +.\" Copyright (C) 2007 David Zeuthen <david@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 "@docdir@/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\|(8), +\&\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@fubar.dk> with a lot of help from many +others. + diff -urNp hal-0.5.8.1.old/doc/man/lshal.1.in hal-0.5.8.1/doc/man/lshal.1.in --- hal-0.5.8.1.old/doc/man/lshal.1.in 1970-01-01 01:00:00.000000000 +0100 +++ hal-0.5.8.1/doc/man/lshal.1.in 2009-05-12 12:58:12.000000000 +0100 @@ -0,0 +1,65 @@ +.\" +.\" lshal manual page. +.\" Copyright (C) 2007 David Zeuthen <david@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 "@docdir@/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\|(8), +\&\fIhal-get-property\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@fubar.dk> with a lot of help from many +others. + diff -urNp hal-0.5.8.1.old/doc/man/Makefile.am hal-0.5.8.1/doc/man/Makefile.am --- hal-0.5.8.1.old/doc/man/Makefile.am 1970-01-01 01:00:00.000000000 +0100 +++ hal-0.5.8.1/doc/man/Makefile.am 2009-05-12 13:05:47.000000000 +0100 @@ -0,0 +1,22 @@ + +MAN_IN_FILES = hald.8.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 + +if MAN_PAGES_ENABLED + +man_MANS = $(MAN_IN_FILES:.in=) + +endif # MAN_PAGES_ENABLED + +EXTRA_DIST = $(MAN_IN_FILES) + +clean-local: + rm -f *~ *.1 *.8 + +%: %.in Makefile + $(edit) $< >$@ + +edit = sed \ + -e 's|@docdir[@]|$(docdir)|g' \ + -e 's|@sbindir[@]|$(sbindir)|g' \ + -e 's|@sysconfdir[@]|$(sysconfdir)|g' +