diff options
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | configure.ac | 2 | ||||
| -rw-r--r-- | docs/Makefile.am | 2 | ||||
| -rw-r--r-- | docs/man/Makefile.am | 7 | ||||
| -rw-r--r-- | docs/man/modem-manager.8.in | 52 |
5 files changed, 64 insertions, 1 deletions
@@ -74,6 +74,8 @@ docs/reference/api/html docs/reference/api/tmpl docs/reference/api/xml +docs/man/modem-manager.8 + m4/gtk-doc.m4 m4/intltool.m4 m4/libtool.m4 diff --git a/configure.ac b/configure.ac index efd24244..194363ce 100644 --- a/configure.ac +++ b/configure.ac @@ -190,6 +190,8 @@ introspection/Makefile po/Makefile.in policy/Makefile docs/Makefile +docs/man/Makefile +docs/man/modem-manager.8 docs/reference/Makefile docs/reference/api/Makefile docs/reference/api/version.xml diff --git a/docs/Makefile.am b/docs/Makefile.am index cac25f2d..36868ac5 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,2 +1,2 @@ -SUBDIRS = reference +SUBDIRS = reference man diff --git a/docs/man/Makefile.am b/docs/man/Makefile.am new file mode 100644 index 00000000..5fa6460a --- /dev/null +++ b/docs/man/Makefile.am @@ -0,0 +1,7 @@ +man_MANS = modem-manager.8 + +EXTRA_DIST = \ + $(man_MANS) \ + modem-manager.8.in + +CLEANFILES = $(man_MANS) diff --git a/docs/man/modem-manager.8.in b/docs/man/modem-manager.8.in new file mode 100644 index 00000000..f7bc04cd --- /dev/null +++ b/docs/man/modem-manager.8.in @@ -0,0 +1,52 @@ +.\" modem-manager(8) manual page +.\" +.\" Copyright (C) 2011 Aleksander Morgado +.\" +.TH MODEMMANAGER "8" "31 October 2011" +.SH NAME +modem-manager \- modem management daemon +.SH SYNOPSIS +.B modem-manager [\-\-version] | [\-\-help] +.PP +.B modem-manager [\-\-debug] [\-\-log\-level=<level>] [\-\-log\-file=<filename>] [\-\-timestamps] [\-\-relative\-timestamps] +.SH DESCRIPTION +The modem-manager (a.k.a. ModemManager) daemon provides a unified high level API +for communicating with (mobile broadband) modems. While the basic commands are +standardized, the more advanced operations (like signal quality monitoring +while connected) varies a lot. +.TP +ModemManager is a system daemon and is not meant to be used directly from the +command line. +.SH OPTIONS +The following options are supported: +.TP +.I "\-\-version" +Print the modem-manager software version and exit. +.TP +.I "\-\-help" +Print modem-manager's available options and exit. +.TP +.I "\-\-debug" +Runs modem-manager with "DEBUG" log level and without daemonizing. This is useful +for debugging, as it directs log output to the controlling terminal in addition to +syslog. +.TP +.I "\-\-log\-level=<level>" +Sets how much information modem-manager sends to the log destination (usually +syslog's "daemon" facility). By default, only informational, warning, and error +messages are logged. Given level must be one of "ERR", "WARN", "INFO" or "DEBUG". +.TP +.I "\-\-log\-file=<filename>" +Specify location of the file where modem-manager will dump its log messages, +instead of syslog. +.TP +.I "\-\-timestamps" +Include absolute timestamps in the log output. +.TP +.I "\-\-relative-timestamps" +Include timestamps, relative to the start time of the daemon, in the log output. +.TP + +.SH SEE ALSO +.BR NetworkManager (8). + |