colin/ModemManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs,man: renew the ModemManager man page and add several missing commands

Browse Source
This commit is contained in:
Aleksander Morgado
2014-09-05 11:19:05 +02:00
parent c4e7fdf025
commit 02961c388b
1 changed files with 47 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
docs/man/ModemManager.8
View File

@@ -2,50 +2,74 @@
.\" .\"
.\" Copyright (C) 2011 Aleksander Morgado .\" Copyright (C) 2011 Aleksander Morgado
.\" .\"
.TH MODEMMANAGER "8" "31 October 2011"
.TH MODEMMANAGER "8" "5 September 2014"
.SH NAME .SH NAME
ModemManager \- modem management daemon ModemManager \- mobile broadband modem management daemon
.SH SYNOPSIS .SH SYNOPSIS
.B ModemManager [\-\-version] | [\-\-help] \fBModemManager\fR [\fIOPTION\fR...]
.PP
.B ModemManager [\-\-debug] [\-\-log\-level=<level>] [\-\-log\-file=<filename>] [\-\-timestamps] [\-\-relative\-timestamps]
.SH DESCRIPTION .SH DESCRIPTION
The ModemManager daemon provides a unified high level API ModemManager provides a unified high level API for communicating with mobile
for communicating with (mobile broadband) modems. While the basic commands are broadband modems, regardless of the protocol used to communicate with the
standardized, the more advanced operations (like signal quality monitoring actual device (Generic AT, vendor-specific AT, QCDM, QMI, MBIM...).
while connected) varies a lot.
ModemManager is a DBus-based system daemon and is not meant to be used directly
from the command line.
.SH HELP OPTIONS
.TP .TP
ModemManager is a system daemon and is not meant to be used directly from the .B \-V, \-\-version
command line.
.SH OPTIONS
The following options are supported:
.TP
.I "\-\-version"
Print the ModemManager software version and exit. Print the ModemManager software version and exit.
.TP .TP
.I "\-\-help" .B \-h, \-\-help
Print ModemManager's available options and exit. Show application options.
.TP .TP
.I "\-\-debug" .B \-\-help\-all
Show application and test options.
.TP
.B \-\-help\-test
Show test options.
.SH APPLICATION OPTIONS
.B \-\-debug
Runs ModemManager with "DEBUG" log level and without daemonizing. This is useful Runs ModemManager with "DEBUG" log level and without daemonizing. This is useful
for debugging, as it directs log output to the controlling terminal in addition to for debugging, as it directs log output to the controlling terminal in addition to
syslog. syslog.
.TP .TP
.I "\-\-log\-level=<level>" .B \-\-log\-level=<level>
Sets how much information ModemManager sends to the log destination (usually Sets how much information ModemManager sends to the log destination (usually
syslog's "daemon" facility). By default, only informational, warning, and error 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". messages are logged. Given level must be one of "ERR", "WARN", "INFO" or "DEBUG".
.TP .TP
.I "\-\-log\-file=<filename>" .B \-\-log\-file=<filename>
Specify location of the file where ModemManager will dump its log messages, Specify location of the file where ModemManager will dump its log messages,
instead of syslog. instead of syslog.
.TP .TP
.I "\-\-timestamps" .B \-\-timestamps
Include absolute timestamps in the log output. Include absolute timestamps in the log output.
.TP .TP
.I "\-\-relative-timestamps" .B \-\-relative-timestamps
Include timestamps, relative to the start time of the daemon, in the log output. Include timestamps, relative to the start time of the daemon, in the log output.
.SH TEST OPTIONS
.TP .TP
.B \-\-test\-session
Run the ModemManager daemon in the Session bus instead of the System bus.
.TP
.B \-\-test\-no\-auto\-scan
Fully disable udev-based auto-scan looking for devices.
.TP
.B \-\-test\-enable
Enable the Test DBus interface in the daemon.
.TP
.B \-\-test\-plugin\-dir=[PATH]
Specify an alternate directory where the daemon should look for vendor plugins.
.SH AUTHOR
Aleksander Morgado <aleksander@aleksander.es>
.SH SEE ALSO .SH SEE ALSO
.BR NetworkManager (8). \fBmmcli\fR(8), \fBNetworkManager\fR(8)