gpsd

package: gpsd

title: gpsd(8)

summary: interface daemon for GPS receivers

text:
# gpsd(8)

## NAME
gpsd - interface daemon for GPS receivers

## SYNOPSSIS
gpsd [OPTIONS]

gpsd -h

gpsd -V

## QUICK START
If you have a GPS attached on the lowest-numbered USB port of a Linux system, and want to read reports from it on TCP/IP port 2947, it will normally suffice to do this, as root:

```
# gpsd /dev/ttyUSB0
```

For the lowest-numbered serial port:

```
# gpsd /dev/ttyS0
```

gpsd may be started as a normal user, or by using sudo, but some functionality will be lost.

Change the device number as appropriate if you need to use a different port. Command-line flags enable verbose logging, a control port, and other optional extras but should not be needed for basic operation; the one exception, on very badly designed hardware, might be -b (which see).

On Linux systems supporting udev, gpsd is normally started automatically when a USB plugin event fires (if it is not already running) and is handed the name of the newly active device. In that case no invocation is required at all.

For your initial tests set your GPS hardware to speak NMEA, as gpsd is guaranteed to be able to process that. If your GPS has a native or binary mode with better performance that gpsd knows how to speak, gpsd may autoconfigure that mode.

You can verify correct operation by first starting gpsd. Then xgps, the X windows test client or cgps the curses based terminal client.

If you have problems, the GPSD project maintains a FAQ to assist troubleshooting.

## DESCRIPTION
gpsd is a monitor daemon that collects information from GPSes, differential-GPS radios, or AIS receivers attached to the host machine. Each GPS, DGPS radio, or AIS receiver is expected to be directly connected to the host via a USB or RS232C serial device. The serial device may be specified to gpsd at startup, or it may be set via a command shipped down a local control socket (e.g. by a USB hotplug script). Given a GPS device by either means, gpsd discovers the correct port speed and protocol for it.

gpsd should be able to query any GPS that speaks either the standard textual NMEA 0183 protocol, or the (differing) extended NMEA dialects used by MKT-3301, iTrax, Motorola OnCore, Sony CXD2951, Ashtech/Thales and some other devices. It can also interpret the binary protocols used by EverMore, Garmin, Javad, Navcom, Rockwell/Zodiac, SiRF, Trimble, and u-blox devices. Under Linux it can read NMEA2000 packets through the kernel CAN socket. It can read heading and attitude information from the Oceanserver 5000 or TNT Revolution digital compasses.

The GPS reporting formats supported by your binary of gpsd may differ depending on how it was compiled; general-purpose versions support many, but it can be built with protocol subsets down to a singleton for use in constrained environments. For a list of the GPS protocols supported by your binary, see the output of gpsd -l

gpsd effectively hides the differences among the GPS types it supports. It also knows about and uses commands that tune these GPSes for lower latency. By using gpsd as an intermediary, applications avoid contention for serial devices.

gpsd can use differential-GPS corrections from a DGPS radio or over the net, from a ground station running a DGPSIP server or a Ntrip broadcaster that reports RTCM-104 data; this may shrink position errors. When gpsd opens a serial device emitting RTCM-104, it automatically recognizes this and uses the device as a correction source for all connected GPSes that accept RTCM corrections (this is dependent on the type of the GPS; not all GPSes have the firmware capability to accept RTCM correction packets).

Client applications typically communicate with gpsd via a TCP/IP port, port 2947 by default. Both IPv4 and IPv6 connections are supported and a client may connect via either.

## OPTIONS
The program accepts the following options:

-?, -h, ---help

Display help message and terminate.

-b, --readonly

Broken-device-safety mode, otherwise known as read-only mode. A few bluetooth and USB receivers lock up or become totally inaccessible when probed or reconfigured; see the hardware compatibility list on the GPSD project website for details. This switch prevents gpsd from writing to a receiver. This means that gpsd cannot configure the receiver for optimal performance, but it also means that gpsd cannot break the receiver. A better solution would be for Bluetooth to not be so fragile. A platform independent method to identify serial-over-Bluetooth devices would also be nice.

-D LVL, --debug LVL

Set debug level. Default is 0. At debug levels 2 and above, gpsd reports incoming sentence and actions to standard error if gpsd is in the foreground (-N) or to syslog if in the background. See LOGGING below.

-F FILE, --sockfile FILE

Create a control socket for device addition and removal commands. Default is None. You must specify a valid pathname on your local filesystem; this will be created as a Unix-domain socket to which you can write commands that edit the daemon’s internal device list.

-f FRAME, --framing FRAME

Fix the framing to the GNSS device. The framing parameter is of the form: [78][ENO][012]. Most GNSS are 8N1. Some Trimble default to 8O1. The default is to search for the correct framing.

-G, --listenany

This flag causes gpsd to listen on all addresses (INADDR_ANY) rather than just the loop back (INADDR_LOOPBACK) address. For the sake of privacy and security, gpsd information is private by default to the local machine until the user makes an effort to expose this to the world.

-l, --drivers

List all drivers compiled into this gpsd instance. The letters to the left of each driver name are the gpsd control commands supported by that driver. Then exit.

-n, --nowait

Don’t wait for a client to connect before polling whatever GPS is associated with it. Some RS232 GPSes wait in a standby mode (drawing less power) when the host machine is not asserting DTR, and some cellphone and handheld embedded GPSes have similar behaviors. Accordingly, waiting for a watch request to open the device may save battery power. (This capability is rare in consumer-grade devices). You should use this option if you plan to use gpsd to provide reference clock information to ntpd or chronyd. This option will also enable clients to see data from the receiver sooner on connection.

-N, --foreground

Don’t daemonize; run in foreground. This switch is mainly useful for debugging.

-p, --passive

Passive mode. Do not autoconfigure the receiver, but allow manual configuration changes.

-P FILE, --pidfile FILE

Specify the name and path to record the daemon’s process ID.

-r, --badtime

Use GPS time even with no current fix. Some GPSs have battery powered Real Time Clocks (RTC’s) built in, making them a valid time source even before a fix is acquired. This can be useful on a Raspberry Pi, or other device that has no battery powered RTC, and thus has no valid time at startup. Use with caution.

--port PORT, -S PORT

Set TCP/IP port on which to listen for GPSD clients (default is 2947).

-s SPEED, --speed SPEED

Fix the serial port speed to the GNSS device. Allowed speeds are: 4800, 9600, 19200, 38400, 57600, 115200, 230400, 460800 and 921600. The default is to autobaud. Note that some devices with integrated USB ignore port speed.

-V, --version

Dump version and exit.

Arguments are interpreted as the names of data sources. Normally, a data source is the device pathname of a local device from which the daemon may expect GPS data. But there are three other special source types recognized, for a total of four:

Local serial or USB device

A normal Unix device name of a serial or USB device to which a sensor is attached. Example: /dev/ttyUSB0.

Local PPS device

A normal Unix device name of a PPS device to which a PPS source is attached. The device name must start with "/dev/pps" and a local serial or USB GPS device must also be available. Example: /dev/pps0.

TCP feed

A URI with the prefix "tcp://", followed by a hostname, a colon, and a port number. The daemon will open a socket to the indicated address and port and read data packets from it, which will be interpreted as though they had been issued by a serial device. Example: tcp://data.aishub.net:4006.

UDP feed

A URI with the prefix "udp://", followed by a hostname, a colon, and a port number. The daemon will open a socket listening for UDP datagrams arriving in the indicated address and port, which will be interpreted as though they had been issued by a serial device. Example: udp://127.0.0.1:5000.

Ntrip caster

A URI with the prefix "ntrip://" followed by the name of an Ntrip caster (Ntrip is a protocol for broadcasting differential-GPS fixes over the net). For Ntrip services that require authentication, a prefix of the form "username:password@" can be added before the name of the Ntrip broadcaster. For Ntrip service, you must specify which stream to use; the stream is given in the form "/streamname". An example DGPSIP URI could be "dgpsip://dgpsip.example.com" and a Ntrip URI could be "ntrip://foo:bar@ntrip.example.com:80/example-stream". Corrections from the caster will be sent to each attached GPS with the capability to accept them.

DGPSIP server

A URI with the prefix "dgpsip://" followed by a hostname, a colon, and an optional colon-separated port number (defaulting to 2101). The daemon will handshake with the DGPSIP server and read RTCM2 correction data from it. Corrections from the server will be set to each attached GPS with the capability to accept them. Example: dgpsip://dgps.wsrcc.com:2101.

Remote gpsd feed

A URI with the prefix "gpsd://", followed by a hostname and optionally a colon and a port number (if the port is absent the default gpsd port will be used). Then followed optionally by a second colon and the remote device name The daemon will open a socket to the indicated address and port and emulate a gpsd client, collecting JSON reports from the remote gpsd instance that will be passed to local clients. Example: gpsd://gpsd.io:2947:/dev/ttyAMA0.

NMEA2000 CAN data

A URI with the prefix "nmea2000://", followed by a CAN devicename. Only Linux socket CAN interfaces are supported. The interface must be configured to receive CAN messages before gpsd can be started. If there is more than one unit on the CAN bus that provides GPS data, gpsd chooses the unit from which a GPS message is first seen. Example: nmea2000://can0.

(The "ais:://" source type supported in some older versions of the daemon has been retired in favor of the more general "tcp://".)

Additionally, two serial device name have a side effect, if your binary was compiled with the MAGIC_HAT option:

/dev/ttyAMA0

The UART device on a Raspberry Pi. Has the side effect of opening /dev/pps0 for RFC2783 1PPS data.

/dev/gpsd0

Generic GPS device 0. Has the side effect of opening /dev/pps0 for RFC2783 1PPS data.

Note, however, that if /dev/pps0 is the fake "ktimer" PPS, then /dev/pps1 will be used instead.

Internally, the daemon maintains a device pool holding the pathnames of devices and remote servers known to the daemon. Initially, this list is the list of device-name arguments specified on the command line. That list may be empty, in which case the daemon will have no devices on its search list until they are added by a control-socket command. Daemon startup will abort with an error if no devices and no control socket is specified.

When a device is activated (i.e. a client requests data from it), gpsd attempts to execute a hook from /etc/gpsd/device-hook with first command line argument set to the pathname of the device and the second to ACTIVATE. On deactivation, it does the same passing DEACTIVATE for the second argument.

gpsd can export data to client applications in three ways: via a sockets interface, via a shared-memory segment, and via D-Bus. The next three major sections describe these interfaces.

## LOGGING
When gpsd is running as a daemon (not in the foreground) is sends all of its logging to syslog(3). Logging is sent with ident "gpsd" using facility "LOG_USER".

If you are using syslog-ng, then you can send all gpsd logs to a file /var/log/gpsd. Put this at the end of your /etc/syslog-ng/syslog-ng.conf file:

```
destination gpsdf { file("/var/log/gpsd"); };
filter f_gpsd { program("gpsd"); };
log { source(src); filter(f_gpsd); destination(gpsdf); };
```

## THE SOCKET INTERFACE
Clients may communicate with the daemon via textual request and responses over a socket. It is a bad idea for applications to speak the protocol directly: rather, they should use the libgps client library and take appropriate care to conditionalize their code on the major and minor protocol version symbols.

The request-response protocol for the socket interface is fully documented in gpsd_json(5).

## SHARED-MEMORY AND DBUS INTERFACES
gpsd has two other (read-only) interfaces.

Whenever the daemon recognizes a packet from any attached device, it writes the accumulated state from that device to a shared memory segment. The C and C++ client libraries shipped with GPSD can read this segment. Client methods, and various restrictions associated with the read-only nature of this interface, are documented at libgps(3). The shared-memory interface is intended primarily for embedded deployments in which gpsd monitors a single device, and its principal advantage is that a daemon instance configured with shared memory but without the sockets interface loses a significant amount of runtime weight.

The daemon may be configured to emit a D-Bus signal each time an attached device delivers a fix. The signal path is "path /org/gpsd", the signal interface is "org.gpsd", and the signal name is "fix". The signal payload layout is as follows:

Table 1. Satellite object

Type

Description

DBUS_TYPE_DOUBLE

Time (seconds since Unix epoch)

DBUS_TYPE_INT32

mode

DBUS_TYPE_DOUBLE

Time uncertainty (seconds).

DBUS_TYPE_DOUBLE

Latitude in degrees.

DBUS_TYPE_DOUBLE

Longitude in degrees.

DBUS_TYPE_DOUBLE

Horizontal uncertainty in meter.

DBUS_TYPE_DOUBLE

Altitude MSL in meters.

DBUS_TYPE_DOUBLE

Altitude uncertainty in meters.

DBUS_TYPE_DOUBLE

Course in degrees from true north.

DBUS_TYPE_DOUBLE

Course uncertainty in meters

DBUS_TYPE_DOUBLE

Speed, meters per second.

DBUS_TYPE_DOUBLE

Speed uncertainty in meters per second.

DBUS_TYPE_DOUBLE

Climb, meters per second.

DBUS_TYPE_DOUBLE

Climb uncertainty in meters per second.

DBUS_TYPE_STRING

Device name

Uncertainty values are provided by the GNSS receiver. Check your

receiver documentation to see if is specifies what its "uncertainty" means.

## GPS DEVICE MANAGEMENT
gpsd maintains an internal list of GPS devices (the "device pool"). If you specify devices on the command line, the list is initialized with those pathnames, otherwise the list starts empty. Commands to add and remove GPS device paths from the daemon’s device list must be written to a local Unix-domain socket which will be accessible only to programs running as root. This control socket will be located wherever the -F option specifies it.

A device may will also be dropped from the pool if GPSD gets a zero length read from it. This end-of-file condition indicates that the device has been disconnected.

When gpsd is installed along with working hotplug notifier scripts feeding it device-add commands over the control socket, gpsd should require no configuration or user action to find hotplug devices.

Sending SIGHUP to a running gpsd forces it to close all GPSes and all client connections. It will then attempt to reconnect to any GPSes on its device list and resume listening for client connections. This may be useful if your GPS enters a wedged or confused state but can be soft-reset by pulling down DTR.

When gpsd is called with no initial devices (thus, expecting devices to be passed to it by notifications to the control socket), and reaches a state where there are no devices connected and no subscribers after some devices have been seen, it shuts down gracefully. It is expected that future device hotplug events will reactivate it.

To point gpsd at a device that may be a GPS, write to the control socket a plus sign ('+') followed by the device name followed by LF or CR-LF. Thus, to point the daemon at /dev/foo. send "+/dev/foo\n". To tell the daemon that a device has been disconnected and is no longer available, send a minus sign ('-') followed by the device name followed by LF or CR-LF. Thus, to remove /dev/foo from the search list, send "-/dev/foo\n".

To send a control string to a specified device, write to the control socket a '!', followed by the device name, followed by '=', followed by the control string.

To send a binary control string to a specified device, write to the control socket a '&', followed by the device name, followed by '=', followed by the control string in paired hex digits.

Your client may await a response, which will be a line beginning with either "OK" or "ERROR". An ERROR response to an 'add' command means the device did not emit data recognizable as GPS packets, an ERROR response to a remove command means the specified device was not in gpsd’s device pool. An ERROR response to a '!' command means the daemon did not recognize the devicename specified.

The control socket is intended for use by hotplug scripts and other device-discovery services. This control channel is separate from the public gpsd service port, and only locally accessible, in order to prevent remote denial-of-service and spoofing attacks.

## ACCURACY
The base User Estimated Range Error (UERE) of GPSes is 8 meters or less at 66% confidence, 15 meters or less at 95% confidence. Actual horizontal error will be UERE times a dilution factor dependent on current satellite position. Altitude determination is more sensitive to variability in ionospheric signal lag than latitude/longitude is, and is also subject to errors in the estimation of local mean sea level, base error is 12 meters at 66% confidence, 23 meters at 95% confidence. Again, this will be multiplied by a vertical dilution of precision (VDOP) dependent on satellite geometry, and VDOP is typically larger than HDOP. Users should not rely on GPS altitude for life-critical tasks such as landing an airplane.

These errors are intrinsic to the design and physics of the GPS system. gpsd does its internal computations at sufficient accuracy that it will add no measurable position error of its own.

DGPS correction may reduce UERE, provided you are within about 100 miles (160 km) of a DGPS ground station from which you are receiving corrections.

On a 4800bps connection, the time latency of fixes provided by gpsd will be one second or less 95% of the time. Most of this lag is due to the fact that GPSes normally emit fixes once per second, thus expected latency is 0.5sec. On the personal-computer hardware available in 2005 and later, computation lag induced by gpsd will be negligible, on the order of a millisecond. Nevertheless, latency can introduce significant errors for vehicles in motion, at 50 km/h (31 mi/h) of speed over ground, 1 second of lag corresponds to 13.8 meters change in position between updates.

The time reporting of the GPS system itself has an intrinsic accuracy limit of 14 nanoseconds, but this can only be approximated by specialized receivers using that send the high-accuracy PPS (Pulse-Per-Second) over RS232 to cue a clock crystal. Most GPS receivers only report time to a precision of 0.01s or 0.001s, and with no accuracy guarantees below 1sec.

If your GPS uses a SiRF chipset at firmware level 231, reported UTC time may be off by the difference between whatever default leap-second offset has been compiled in and whatever leap-second correction is currently applicable, from startup until complete subframe information is received. Firmware levels 232 and up don’t have this problem. You may run gpsd at debug level 4 to see the chipset type and firmware revision level.

There are exactly two circumstances under which gpsd relies on the host-system clock:

In the GPS broadcast signal, GPS time is represented using a week number that rolls over after 2^10 or 2^13 weeks (about 19.6 years, or 157 years), depending on the spacecraft. Receivers are required to disambiguate this to the correct date, but may have difficulty due to not knowing time to within half this interval, or may have bugs. Users have reported incorrect dates which appear to be due to this issue. gpsd uses the startup time of the daemon detect and compensate for rollovers while it is running, but otherwise reports the date as it is reported by the receiver without attempting to correct it.

If you are using an NMEA-only GPS (that is, not using SiRF or Garmin or Zodiac binary mode), gpsd relies on the system clock to tell it the current century. If the system clock returns an invalid value near zero, and the GPS does not emit GPZDA at the start of its update cycle (which most consumer-grade NMEA GPSes do not) then the century part of the dates gpsd delivers may be wrong. Additionally, near the century turnover, a range of dates as wide in seconds as the accuracy of your system clock may be referred to the wrong century.

## USE WITH NTP
gpsd can provide reference clock information to ntpd or chronyd, to keep the system clock synchronized to the time provided by the GPS receiver.

On Linux, gpsd includes support for interpreting the PPS pulses emitted at the start of every clock second on the carrier-detect lines of some serial GPSes, this pulse can be used to update NTP at much higher accuracy than message time provides. You can determine whether your GPS emits this pulse by running at -D 5 and watching for carrier-detect state change messages in the logfile. In addition, if your kernel provides the RFC 2783 kernel PPS API then gpsd will use that for extra accuracy.

Detailed instructions for using GPSD to set up a high-quality time service can be found among the documentation on the GPSD website.

## USE WITH D-BUS
On operating systems that support D-BUS, gpsd can be built to broadcast GPS fixes to D-BUS-aware applications. As D-BUS is still at a pre-1.0 stage, we will not attempt to document this interface here. Read the gpsd source code to learn more.

## SECURITY AND PERMISSIONS ISSUES
gpsd, if given the -G flag, will listen for connections from any reachable host, and then disclose the current position. Before using the -G flag, consider whether you consider your computer’s location to be sensitive data to be kept private or something that you wish to publish.

gpsd must start up as root in order to open the NTPD shared-memory segment, open its logfile, and create its local control socket. Note that starting gpsd with sudo is not the same as starting as root. Before doing any processing of GPS data, it tries to drop root privileges by setting its UID to "nobody" (or another configured userid) and its group ID to the group of the initial GPS passed on the command line — or, if that device doesn’t exist, to the group of /dev/ttyS0.

Privilege-dropping is a hedge against the possibility that carefully crafted data, either presented from a client socket or from a subverted serial device posing as a GPS, could be used to induce misbehavior in the internals of gpsd. It ensures that any such compromises cannot be used for privilege elevation to root.

The assumption behind gpsd’s particular behavior is that all the tty devices to which a GPS might be connected are owned by the same non-root group and allow group read/write, though the group may vary because of distribution-specific or local administrative practice. If this assumption is false, gpsd may not be able to open GPS devices in order to read them (such failures will be logged).

In order to fend off inadvertent denial-of-service attacks by port scanners (not to mention deliberate ones), gpsd will time out inactive client connections. Before the client has issued a command that requests a channel assignment, a short timeout (60 seconds) applies. There is no timeout for clients in watcher or raw modes; rather, gpsd drops these clients if they fail to read data long enough for the outbound socket write buffer to fill. Clients with an assigned device in polling mode are subject to a longer timeout (15 minutes).

## LIMITATIONS
If multiple NMEA talkers are feeding RMC, GLL, and GGA sentences to the same serial device (possible with an RS422 adapter hooked up to some marine-navigation systems), a 'TPV' response may mix an altitude from one device’s GGA with latitude/longitude from another’s RMC/GLL after the second sentence has arrived.

gpsd may change control settings on your GPS (such as the emission frequency of various sentences or packets) and not restore the original settings on exit. This is a result of inadequacies in NMEA and the vendor binary GPS protocols, which often do not give clients any way to query the values of control settings in order to be able to restore them later.

Some receivers do not report VDOP/TDOP/GDOP figures and associated error estimates. In that case they may be computed by gpsd instead. This computation does not exactly match what chips do internally, which includes some satellite weighting using parameters gpsd cannot see.

Autobauding on the Trimble GPSes can take as long as 20 seconds, or more, if the device speed is not matched to the GPS speed. Use the -s option to avoid autobaud delays.

Generation of position error estimates (eph, epv, epd, eps, epc) from the incomplete data handed back by GPS reporting protocols involves both a lot of mathematical black art and fragile device-dependent assumptions. This code has been bug-prone in the past and problems may still lurk there.

AIDVM decoding of types 16-17, 22-23, and 25-26 is unverified.

GPSD presently fully recognizes only the 2.1 level of RTCM2 (message types 1, 3, 4, 5, 6, 7, 9, 16). The 2.3 message types 13, 14, and 31 are recognized and reported. Message types 8, 10-12, 15-27, 28-30 (undefined), 31-37, 38-58 (undefined), and 60-63 are not yet supported.

The ISGPS used for RTCM2 and subframes decoder logic is sufficiently convoluted to confuse some compiler optimizers, notably in GCC 3.x at -O2, into generating bad code.

Devices meant to use PPS for high-precision timekeeping may fail if they are specified after startup by a control-socket command, as opposed to on the daemon’s original command line. Root privileges are dropped early, and some Unix variants require them in order to set the PPS line discipline. Under Linux the POSIX capability to set the line discipline is retained, but other platforms cannot use this code.

USB GPS devices often do not identify themselves through the USB subsystem; they typically present as the class 00h (undefined) or class FFh (vendor-specific) of USB-to-serial adapters. Because of this, the Linux hotplug scripts must tell gpsd to sniff data from every USB-to-serial adapter that goes active and is known to be of a type used in GPSes. No such device is sent configuration strings until after it has been identified as a GPS, and gpsd never opens a device that is opened by another process. But there is a tiny window for non-GPS devices not opened; if the application that wants them loses a race with GPSD its device open will fail and have to be retried after GPSD sniffs the device (normally less than a second later).

## FILES
/dev/ttyS0

Prototype TTY device. After startup, gpsd sets its group ID to the owning group of this device if no GPS device was specified on the command line does not exist.

/etc/gpsd/device-hook

Optional file containing the device activation/deactivation script. Note that while /etc/gpsd is the default system configuration directory, it is possible to build the GPSD source code with different assumptions. See above for further details on the device-hook mechanism.

## ENVIRONMENT VARIABLES
By setting the environment variable GPSD_SHM_KEY, you can control the key value used to create the shared-memory segment used for communication with the client library. This will be useful mainly when isolating test instances of gpsd from production ones.

## RETURN VALUES
0

on success.

1

on failure

## APPLICABLE STANDARDS
The official NMEA protocol standards for NMEA0183 and NMEA2000 are available from the National Marine Electronics Association, but are proprietary and expensive; the maintainers of gpsd have made a point of not looking at them. The GPSD project website links to several documents that collect publicly disclosed information about the protocol.

gpsd parses the following NMEA sentences: RMC, GGA, GLL, GSA, GSV, VTG, ZDA, GBS, HDT, DBT, GST. It recognizes these with either the normal GP talker-ID prefix, or with the GN prefix used by GLONASS, or with the II prefix emitted by Seahawk Autohelm marine navigation systems, or with the IN prefix emitted by some Garmin units, or with the EC prefix emitted by ECDIS units, or with the SD prefix emitted by depth sounders, or with the HC and TI prefix emitted by some Airmar equipment. It recognizes some vendor extensions: the PGRME emitted by some Garmin GPS models, the OHPR emitted by Oceanserver digital compasses, the PTNTHTM emitted by True North digital compasses, the PMTK omitted by some San Jose Navigation GPSes, and the PASHR sentences emitted by some Ashtech GPSes.

Note that gpsd JSON returns pure decimal degrees, not the hybrid degree/minute format described in the NMEA standard.

Differential-GPS corrections are conveyed by the RTCM protocols. The applicable standard for RTCM-104 V2 is RTCM Recommended Standards for Differential GNSS (Global Navigation Satellite) Service RTCM Paper 136-2001/SC 104-STD. The applicable standard for RTCM-104 V3 is RTCM Standard 10403.1 for Differential GNSS Services - Version 3 RTCM Paper 177-2006-SC104-STD. Ordering instructions for the RTCM standards are accessible from the website of the Radio Technical Commission for Maritime Services under "Publications".

AIS is defined by ITU Recommendation M.1371, Technical Characteristics for a Universal Shipborne Automatic Identification System Using Time Division Multiple Access. The AIVDM/AIVDO format understood by this program is defined by IEC-PAS 61162-100, Maritime navigation and radiocommunication equipment and systems. A more accessible description of both can be found at AIVDM/AIVDO Protocol Decoding, on the references page of the GPSD project website.

Subframe data is defined by IS-GPS-200, GLOBAL POSITIONING SYSTEM WING (GPSW) SYSTEMS ENGINEERING & INTEGRATION, INTERFACE SPECIFICATION IS-GPS-200. The format understood by this program is defined in Section 20 (Appendix II),

JSON is specified by RFC 7159, The JavaScript Object Notation (JSON) Data Interchange Format.

The API for PPS time service is specified by RFC 2783, Pulse-Per-Second API for UNIX-like Operating Systems, Version 1.0

## AUTHORS
Authors: Eric S. Raymond, Chris Kuethe, Gary Miller. Former authors whose bits have been plowed under by code turnover: Remco Treffcorn, Derrick Brashear, Russ Nelson.

This manual page by Eric S. Raymond < <esr@thyrsus.com>>.

## SEE ALSO
gpsd(8), gpsctl(1), gps(1), libgps(3), libgpsmm(3), gpsprof(1), gpsfake(1). gpsdctl(8), gpsd_json(5), *gpscat(1)

## RESOURCES
Project web site: <https://gpsd.io/>

## COPYING
This file is Copyright 2013 by the GPSD project

SPDX-License-Identifier: BSD-2-clause


gpsdctl

title: gpsdctl(8)

text:
# gpsdctl(8)

## NAME
gpsdctl - tool for sending commands to gpsd over its control socket

## SYNOPSIS
gpsdctl action device

## OPTIONS
action

may be add or remove. If no daemon instance is running when an add is requested, this program will launch one.

device

argument should be the pathname of a device. The device will be opened by gpsd to read sensor data.

## DESCRIPTION
This is a tool for sending an instance of gpsd commands over its control socket to add or remove devices from the daemon’s device list. It is not intended to be called by users, but rather by the Linux hotplug system and similar facilities.

## ENVIRONMENT
Two environment variables are interpreted.

GPSD_SOCKET

sets the location of the control socket. If the effective user ID of this program is root then it usually defaults to /run/gpsd.sock, although some systems may use the deprecated /var/run/gpsd.sock instead. Non-root users will use /tmp/gpsd.sock.

GPSD_OPTIONS

may be a list of options to be passed to gpsd when this tool launches it. It defaults to an empty string.

## RETURN VALUES
0

on success.

1

if the action was unknown or the write to the control socket failed,

## SEE ALSO
gpsd(8), gpsctl(1), gps(1), libgps(3), libgpsmm(3), gpsprof(1), gpsfake(1).

## RESOURCES
Project web site: <https://gpsd.io/>

## COPYING
This file is Copyright 2013 by the GPSD project

SPDX-License-Identifier: BSD-2-clause

## AUTHOR
Eric S. Raymond


gpsinit

title: gpsinit(8)

summary: initialize CAN kernel modules for GPSD

text:
# gpsinit(8)

## NAME
gpsinit - initialize CAN kernel modules for GPSD

## SYNOPSIS
gpsinit [-n control] [-s speed] module_name [interface_name]

gpsinit -h

gpsinit -V

## DESCRIPTION
gpsinit initializes whatever kernel-level modules are needed to enable special non-serial hardware to communicate with a gpsd instance. Note: it will need root permissions to load modules and perform other special operations, such as changing kernel-interface baudrates.

At present, all modes of this tool are concerned with setting up kernel-level interfaces to hardware on a CAN (Control Area Network) speaking NMEA2000.

The program accepts the following options:

-h

Display a brief help text.

-n

Set the CAN network number. The default is 0.

-s

Set the baudrate to be used to communicate over the serial line to the CAN hardware. The default is 38400 baud.

-V

Display the version of gpsinit.

The parameter module_name is mandatory. The socket CAN driver module module_name.ko will be loaded. gpsinit recognize the following module names:

plx_pci, esd_usb2, vcan, slcan

The parameter interface_name and -s speed can used here.

beaglebone

The dcan module needed for the beaglebone is part of the Linux kernel, so no module is loaded in this case.

The parameter interface_name is needed for slcan hardware only. It gives the name of the serial device to which the SL CAN hardware is connected. The default is /dev/ttyUSB0.

## EXAMPLES
All the following examples probably need to be run as root.

gpsinit plx_pci

Attempt to load the module plx_pci and initialize net 0 for the connection to a NMEA2000 network. It will set the baudrate to 250kBits.

gpsinit -n 1 plx_pci

As above, but use net 1.

gpsinit -s 38400 slcan /dev/ttyUSB0

Attempt to load the module slcan and talk to the hardware at 38400 baud connected to port /dev/ttyUSB0.

gpsinit -h

Display a brief help message.

gpsinit -v

Display the version of gpsinit.

## RETURN VALUES
0

on success.

1

on failure

## SEE ALSO
gpsd(8), gps(1)

## RESOURCES
Project web site: <https://gpsd.io/>

## COPYING
This file is Copyright 2013 by the GPSD project

SPDX-License-Identifier: BSD-2-clause

## AUTHOR
Reinhard Arlt


ppscheck

title: ppscheck(8)

summary: tool to check a serial port for PPS

text:
# ppscheck(8)

## NAME
ppscheck - tool to check a serial port for PPS

## SYNOPSIS
ppscheck [-?] [--help] [--version] [-h] [-V] device

## DESCRIPTION
ppscheck watches a specified serial port for transitions that might be PPS. It looks for changes in handshake lines CD, RI, and CTS by running ioctl(...., TIOCMIWAIT, ...) in a loop. When it sees a state change it emits a timestamped line of output dumping the state of the handshake signals. It’s useful for checking whether a device is emitting PPS.

ppscheck can run as a normal user, but that user must have permissions to read the target device. Running as root will always work.

To check the first serial port do this:

```
ppscheck /dev/ttyS0
```

ppscheck is not intended for routine use, but rather for diagnostic purposes. Once you have verified a particular device can output PPS signals you will never need to use it again on that device.

## OPTIONS
The program accepts the following options:

-?+, `+-h+, `+--help

Display help message and terminate.

-V+, `+--version

Dump version and exit.

## ARGUMENTS
The device argument should be the pathname of a device. Such as /dev/ttyS0 or /dev/pps0. It will be the device monitored.

Each output line is the second and nanosecond parts of a timestamp followed by the names of the handshake signals then asserted. Off transitions may generate lines with no signals asserted.

If you don’t see output within a second, use cgps or some other equivalent tool to check that your device has a satellite lock and is getting 3D fixes before giving up on the possibility of PPS.

Check your cable. Cheap DB9 to DB9 cables such as those issued with UPSes often carry TXD/RXD/GND only, omitting handshake lines such as DCD. Suspect this especially if the cable jacket looks too skinny to hold more than three leads!

Most GPS that have built in USB do not support PPS. When in doubt, contact the vendor for confirmation that your device does supply PPS.

## RETURN VALUES
0

OK

1

if the device counld not be opened

## SEE ALSO
gpsd(8)

## RESOURCES
Project web site: <https://gpsd.io/>

## COPYING
This file is Copyright 2013 by the GPSD project

SPDX-License-Identifier: BSD-2-clause

## AUTHOR
Eric S. Raymond


grub-bios-setup

package: grub-common

title: grub-bios-setup(8)

summary: set up a device to boot using GRUB

text:
# grub-bios-setup(8)

## NAME
grub-bios-setup - set up a device to boot using GRUB

## SYNOPSIS
grub-bios-setup [OPTION...] DEVICE

## DESCRIPTION
Set up images to boot from DEVICE.

You should not normally run this program directly. Use grub-install instead.

-a, --allow-floppy

make the drive also bootable as floppy (default for fdX devices). May break on some BIOSes.

-b, --boot-image=FILE

use FILE as the boot image [default=boot.img]

-c, --core-image=FILE

use FILE as the core image [default=core.img]

-d, --directory=DIR

use GRUB files in the directory DIR [default=/boot/grub]

-f, --force

install even if problems are detected

-m, --device-map=FILE

use FILE as the device map [default=/boot/grub/device.map]

--no-rs-codes

Do not apply any reed-solomon codes when embedding core.img. This option is only available on x86 BIOS targets.

-s, --skip-fs-probe

do not probe for filesystems in DEVICE

-v, --verbose

print verbose messages.

-?, --help

give this help list

--usage

give a short usage message

-V, --version

print program version

Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.

DEVICE must be an OS device (e.g. /dev/sda).

## REPORTING BUGS
Report bugs to <bug-grub@gnu.org>.

## SEE ALSO
grub-install(8), grub-mkimage(1), grub-mkrescue(1)

The full documentation for grub-bios-setup is maintained as a Texinfo manual. If the info and grub-bios-setup programs are properly installed at your site, the command

info grub-bios-setup

should give you access to the complete manual.


grub-entries

title: grub-entries(8)

text:
# grub-entries(8)

## NAME
grub-entries - simple script for show grub menu and check menu items

## SYNOPSIS
grub-entries [options]

## DESCRIPTION
grub-entries parse specified or default grub config file, list all grub menu items in the one of the three forms. Also can search specified item in menu and returns 0, if this item exists, otherwise returns non-zero value. By default, /boot/grub/grub.cfg config file used.

## OPTIONS
-f, --config filename

Specify path to the grub config.

-n, --numbers

Show only menu item sequence numbers.

-t, --titles

Show only menu item names.

-c, --check menuitem

Specify menu item to validate.

-V, --version

Show script version and exit.

-h, --help

Show help message and exit.

## FILES
/boot/grub/grub.cfg

## AUTHORS
Leonid Krivoshein <klark@altlinux.org>

## SEE ALSO
grub-reboot(8), grub-set-default(8)


grub-install

title: grub-install(8)

summary: install GRUB to a device

text:
# grub-install(8)

## NAME
grub-install - install GRUB to a device

## SYNOPSIS
grub-install [OPTION...] [OPTION] [INSTALL_DEVICE]

## DESCRIPTION
Install GRUB on your drive.

--compress=no|xz|gz|lzo

compress GRUB files [optional]

--disable-shim-lock

disable shim_lock verifier

--dtb=FILE

embed a specific DTB

-d, --directory=DIR

use images and modules under DIR [default=/usr/lib64/grub/<platform>]

--fonts=FONTS

install FONTS [default=unicode]

--install-modules=MODULES

install only MODULES and their dependencies [default=all]

-k, --pubkey=FILE

embed FILE as public key for signature checking

--locale-directory=DIR use translations under DIR

[default=/usr/share/locale]

--locales=LOCALES

install only LOCALES [default=all]

--modules=MODULES

pre-load specified modules MODULES

--sbat=FILE

SBAT metadata

--themes=THEMES

install THEMES [default=starfield]

-v, --verbose

print verbose messages.

--allow-floppy

make the drive also bootable as floppy (default for fdX devices). May break on some BIOSes.

--boot-directory=DIR

install GRUB images under the directory DIR/grub instead of the boot/grub directory

--bootloader-id=ID

the ID of bootloader. This option is only available on EFI and Macs.

--core-compress=xz|none|auto

choose the compression to use for core image

--disk-module=MODULE

disk module to use (biosdisk or native). This option is only available on BIOS target.

--efi-directory=DIR

use DIR as the EFI System Partition root.

--force

install even if problems are detected

--force-extra-removable

force installation to the removable media path also. This option is only available on EFI.

--force-file-id

use identifier file even if UUID is available

--label-bgcolor=COLOR

use COLOR for label background

--label-color=COLOR

use COLOR for label

--label-font=FILE

use FILE as font for label

--macppc-directory=DIR use DIR for PPC MAC install.

--no-bootsector

do not install bootsector

--no-nvram

don't update the `boot-device'/`Boot*' NVRAM variables. This option is only available on EFI and IEEE1275 targets.

--no-rs-codes

Do not apply any reed-solomon codes when embedding core.img. This option is only available on x86 BIOS targets.

--no-uefi-secure-boot

do not install an image usable with UEFI Secure Boot, even if the system was currently started using it. This option is only available on EFI.

--product-version=STRING

use STRING as product version

--recheck

delete device map if it already exists

--removable

the installation device is removable. This option is only available on EFI.

-s, --skip-fs-probe

do not probe for filesystems in DEVICE

--target=TARGET

install GRUB for TARGET platform [default=i386-pc]; available targets: arm-coreboot, arm-efi, arm-uboot, arm64-efi, i386-coreboot, i386-efi, i386-ieee1275, i386-multiboot, i386-pc, i386-qemu, i386-xen, i386-xen_pvh, ia64-efi, loongarch64-efi, mips-arc, mips-qemu_mips, mipsel-arc, mipsel-loongson, mipsel-qemu_mips, powerpc-ieee1275, riscv32-efi, riscv64-efi, sparc64-ieee1275, x86_64-efi, x86_64-xen

--uefi-secure-boot

install an image usable with UEFI Secure Boot. This option is only available on EFI.

-?, --help

give this help list

--usage

give a short usage message

-V, --version

print program version

Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.

INSTALL_DEVICE must be system device filename. grub-install copies GRUB images into boot/grub. On some platforms, it may also install GRUB into the boot sector.

## REPORTING BUGS
Report bugs to <bug-grub@gnu.org>.

## SEE ALSO
grub-mkconfig(8), grub-mkimage(1), grub-mkrescue(1)

The full documentation for grub-install is maintained as a Texinfo manual. If the info and grub-install programs are properly installed at your site, the command

info grub-install

should give you access to the complete manual.


grub-macbless

title: grub-macbless(8)

summary: bless a mac file/directory

text:
# grub-macbless(8)

## NAME
grub-macbless - bless a mac file/directory

## SYNOPSIS
grub-macbless [OPTION...] --ppc PATH|--x86 FILE

## DESCRIPTION
Mac-style bless on HFS or HFS+

-p, --ppc

bless for ppc-based macs

-v, --verbose

print verbose messages.

-x, --x86

bless for x86-based macs

-?, --help

give this help list

--usage

give a short usage message

-V, --version

print program version

## REPORTING BUGS
Report bugs to <bug-grub@gnu.org>.

## SEE ALSO
grub-install(1)

The full documentation for grub-macbless is maintained as a Texinfo manual. If the info and grub-macbless programs are properly installed at your site, the command

info grub-macbless

should give you access to the complete manual.


grub-mkconfig

title: grub-mkconfig(8)

summary: generate a GRUB configuration file

text:
# grub-mkconfig(8)

## NAME
grub-mkconfig - generate a GRUB configuration file

## SYNOPSIS
grub-mkconfig [OPTION]

## DESCRIPTION
Generate a grub config file

-o, --output=FILE

output generated config to FILE [default=stdout]

-h, --help

print this message and exit

-V, --version

print the version information and exit

## REPORTING BUGS
Report bugs to <bug-grub@gnu.org>.

## SEE ALSO
grub-install(8)

The full documentation for grub-mkconfig is maintained as a Texinfo manual. If the info and grub-mkconfig programs are properly installed at your site, the command

info grub-mkconfig

should give you access to the complete manual.


grub-ofpathname

title: grub-ofpathname(8)

summary: find OpenBOOT path for a device

text:
# grub-ofpathname(8)

## NAME
grub-ofpathname - find OpenBOOT path for a device

## SYNOPSIS
grub-ofpathname DEVICE

## SEE ALSO
grub-probe(8)

The full documentation for grub-ofpathname is maintained as a Texinfo manual. If the info and grub-ofpathname programs are properly installed at your site, the command

info grub-ofpathname

should give you access to the complete manual.


grub-probe

title: grub-probe(8)

summary: probe device information for GRUB

text:
# grub-probe(8)

## NAME
grub-probe - probe device information for GRUB

## SYNOPSIS
grub-probe [OPTION...] [OPTION]... [PATH|DEVICE]

## DESCRIPTION
Probe device information for a given path (or device, if the -d option is given).

-0

separate items in output using ASCII NUL characters

-d, --device

given argument is a system device, not a path

-m, --device-map=FILE

use FILE as the device map [default=/boot/grub/device.map]

-t, --target=TARGET

print TARGET available targets: abstraction, arc_hints, baremetal_hints, bios_hints, compatibility_hint, cryptodisk_uuid, device, disk, drive, efi_hints, fs, fs_label, fs_uuid, gpt_parttype, hints_string, ieee1275_hints, msdos_parttype, partmap, partuuid, zero_check [default=fs]

-v, --verbose

print verbose messages (pass twice to enable debug printing).

-?, --help

give this help list

--usage

give a short usage message

-V, --version

print program version

Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.

## REPORTING BUGS
Report bugs to <bug-grub@gnu.org>.

## SEE ALSO
grub-fstest(1)

The full documentation for grub-probe is maintained as a Texinfo manual. If the info and grub-probe programs are properly installed at your site, the command

info grub-probe

should give you access to the complete manual.


grub-reboot

title: grub-reboot(8)

text:
# grub-reboot(8)

## NAME
grub-reboot - set the default boot entry for GRUB, for the next boot only

## SYNOPSIS
grub-reboot [OPTION] MENU_ENTRY

## DESCRIPTION
Set the default boot menu entry for GRUB, for the next boot only.

-h, --help

print this message and exit

-V, --version

print the version information and exit

--boot-directory=DIR

expect GRUB images under the directory DIR/grub instead of the /boot/grub directory

MENU_ENTRY is a number, a menu item title or a menu item identifier. Please note that menu items in submenus or sub-submenus require specifying the submenu components and then the menu item component. The titles should be separated using the greater-than character (>) with no extra spaces. Depending on your shell some characters including > may need escaping. More information about this is available in the GRUB Manual in the section about the 'default' command.

NOTE: In cases where GRUB cannot write to the environment block, such as when it is stored on an MDRAID or LVM device, the chosen boot menu entry will remain the default even after reboot.

## REPORTING BUGS
Report bugs to <bug-grub@gnu.org>.

## SEE ALSO
grub-set-default(8), grub-editenv(1)

The full documentation for grub-reboot is maintained as a Texinfo manual. If the info and grub-reboot programs are properly installed at your site, the command

info grub-reboot

should give you access to the complete manual.


grub-set-default

title: grub-set-default(8)

text:
# grub-set-default(8)

## NAME
grub-set-default - set the saved default boot entry for GRUB

## SYNOPSIS
grub-set-default [OPTION] MENU_ENTRY

## DESCRIPTION
Set the default boot menu entry for GRUB. This requires setting GRUB_DEFAULT=saved in /etc/default/grub.

-h, --help

print this message and exit

-V, --version

print the version information and exit

--boot-directory=DIR

expect GRUB images under the directory DIR/grub instead of the /boot/grub directory

MENU_ENTRY is a number, a menu item title or a menu item identifier.

## REPORTING BUGS
Report bugs to <bug-grub@gnu.org>.

## SEE ALSO
grub-reboot(8), grub-editenv(1)

The full documentation for grub-set-default is maintained as a Texinfo manual. If the info and grub-set-default programs are properly installed at your site, the command

info grub-set-default

should give you access to the complete manual.


title: grub-sparc64-setup(8)

summary: set up a device to boot using GRUB

text:
# grub-sparc64-setup(8)

## NAME
grub-sparc64-setup - set up a device to boot using GRUB

## SYNOPSIS
grub-sparc64-setup [OPTION...] DEVICE

## DESCRIPTION
Set up images to boot from DEVICE.

You should not normally run this program directly. Use grub-install instead.

-a, --allow-floppy

make the drive also bootable as floppy (default for fdX devices). May break on some BIOSes.

-b, --boot-image=FILE

use FILE as the boot image [default=boot.img]

-c, --core-image=FILE

use FILE as the core image [default=core.img]

-d, --directory=DIR

use GRUB files in the directory DIR [default=/boot/grub]

-f, --force

install even if problems are detected

-m, --device-map=FILE

use FILE as the device map [default=/boot/grub/device.map]

--no-rs-codes

Do not apply any reed-solomon codes when embedding core.img. This option is only available on x86 BIOS targets.

-s, --skip-fs-probe

do not probe for filesystems in DEVICE

-v, --verbose

print verbose messages.

-?, --help

give this help list

--usage

give a short usage message

-V, --version

print program version

Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.

DEVICE must be an OS device (e.g. /dev/sda).

## REPORTING BUGS
Report bugs to <bug-grub@gnu.org>.

## SEE ALSO
grub-install(8), grub-mkimage(1), grub-mkrescue(1)

The full documentation for grub-sparc64-setup is maintained as a Texinfo manual. If the info and grub-sparc64-setup programs are properly installed at your site, the command

info grub-sparc64-setup

should give you access to the complete manual.


update-grub

title: update-grub(8)

summary: stub for grub-mkconfig

text:
# update-grub(8)

## NAME
update-grub, update-grub2 - stub for grub-mkconfig

## SYNOPSIS
update-grub

## DESCRIPTION
update-grub is a stub for running grub-mkconfig -o /boot/grub/grub.cfg to generate a grub2 config file.

## SEE ALSO
grub-mkconfig(8)


gsmsmsd

package: gsmlib-utils

title: gsmsmsd(8)

summary: SMS message reception daemon

text:
# gsmsmsd(8)

## NAME
gsmsmsd - SMS message reception daemon

## SYNOPSIS
gsmsmsd [ -a action ] [ --action action ] [ -b baudrate ] [ --baudrate baudrate ] [ -c concatenatedID ] [ --concatenate concatenatedID ] [ -C service centre address ] [ --sca service centre address ] [ -d device ] [ --device device ] [ -D ] [ --direct ] [ -f ] [ --flush ] [ -F failed SMS directory ] [ --failed failed SMS directory ] [ -h ] [ --help ] [ -I init string ] [ --init init string ] [ -L ] [ --syslog ] [ -P priority levels ] [ --priorities priority levels ] [ -r ] [ --requeststat ] [ -s spool directory ] [ --spool spool directory ] [ -S sent SMS directory ] [ --sent sent SMS directory ] [ -t SMS store name ] [ --store SMS store name ] [ -v ] [ --version ] [ -X ] [ --xonxoff ] { sms_type }

## DESCRIPTION
gsmsmsd reads new incoming SMS from the mobile phone and dispatches them to a user-defined action. Additionally it can send SMS message that it reads from a spooldir.

gsmsmsd attaches itself to the device given on the command line (usually an GSM modem) using the specified baudrate and waits for incoming SMS messages. If no device is given, the device /dev/mobilephone is used. If no baudrate is given, a default baud rate of 38400 is used.

If no action is given, the SMS message is printed to the standard output. If an action is specified the action is excecuted using the shell and the SMS message is written to the standard input of the action.

gsmsmsd needs one empty storage slot for SMS messages in the mobile phone, otherwise SMS reception will not work. The SMS store to use for temporary storage of incoming SMS can be selected using the --store option, otherwise the ME default store is used.

To terminate gsmsmsd cleanly (without losing SMS messages) one should send either SIGINT (CTRL-C on the command line) or SIGTERM to the process.

Error messages are printed to the standard error output or are sent to the syslog daemon, if syslog is enabled and available. If the program terminates on error the error code 1 is returned.

sms_type may be any combination of:

sms, no_sms

Controls reception of normal SMS messages.

cb, no_cb

Controls reception of cell broadcast messages.

stat, no_stat

Controls reception of status reports.

The default is sms, cb, and stat.

## OPTIONS
-a action, --action action

The action to execute for each incoming SMS message. If no action is given the SMS is written to the standard output.

-b baudrate, --baudrate baudrate

The baud rate to use.

-c concatenatedID, --concatenate concatenatedID

If an ID is given, large SMSs are split into several, concatenated SMSs. All SMSs have the same ID and are numbered consecutively so that the receiving phone can assemble them in the correct order. IDs must be in the range 0..255. This number is increased by one for every outgoing concatenated SMS and wraps around after 255. Not all receiving phones will support concatenated SMSs (and display them as separate SMSs), since all the numbering and ID information is carried in the user data header element at the beginning of the SMS user data. This information may show up as garbage in such phones.

-C service centre address, --sca service centre address

Sets the service centre address to use for all SUBMIT SMSs (may not work with some phones).

-d device, --device device

The device to which the GSM modem is connected. The default is /dev/mobilephone.

-D, --direct

Enables direct routing of incoming SMS messages to the TE. This is not supported by many mobile phone/GSM modem combinations. Therefore, the default is to store incoming SMS temporarily before processing them in the indicated store.

-F failed SMS directory, --failed failed SMS directory

Moves failed SMS messages to the given directory. If this option is not given, failed SMS will be removed.

-f, --flush

This option causes gsmsmsd to flush (ie. read and erase) existing SMS messages from the SMS store selected by the --store option. The action given by the --action option is executed on each of the flushed SMS. This option should be used to ensure that enough space is available in the SMS store for temporary storage of incoming SMS, otherwise incoming SMS might be ignored silently by the ME.

-h, --help

Prints an option summary.

-I init string, --init init string

Initialization string to send to the TA (default: "E0"). Note that the sequence "ATZ" is sent first.

-L, --syslog

Send errors and information to the syslog daemon if available.

-P priority levels, --priorities priority levels

Activates the priority system and sets the number or levels to use, see the PRIORITY SYSTEM section.

-r, --requeststat

Request status reports for sent SMS. Note: This option only makes sense if the phone supports routing of status reports to the TE. Otherwise the status reports might show on the phone's display or get lost.

-s spool directory, --spool spool directory

This option sets the spool directory where gsmsmsd expects SMS messages to send. The format of SMS files is very simple: The first line contains the phone number of the recipient. Everything else after the first line is interpreted as the SMS text. Please refer to gsmsendsms(1) for details on the SMS text character set and maximum length. gsmsmsd polls the spool directory every 5 seconds. Sent SMS message files are removed by default.

-S sent SMS directory, --sent sent SMS directory

Moves sent SMS messages to the given directory. If this option is not given, sent SMS will be removed.

-t SMS store name, --store SMS store name

The name of the SMS store to read from (for the --flush option) or write to (for temporary SMS storage). This option must be must be used in conjunction with the --flush option. If this option is omitted the ME uses it's default SMS store for temporary storage of incoming SMS. A commonly available message store is "SM" (SIM card).

-v, --version

Prints the program version.

-X, --xonxoff

Uses software handshaking (XON/XOFF) for accessing the device.

## PRIORITY SYSTEM
If the --priorities option is given, the priority system is activated and the number of priority levels is set. There must be directories named <given spool directory name>+<priority level> for every level. This includes the directories given in the --failed and --sent options if they are used. See the EXAMPLES section.

## EXAMPLES
The following invocation of gsmsmsd sends each incoming SMS message as a mail to the user "smsadmin":

```
gsmsmsd -d /dev/ttyS2 -b 19200 -a "mail smsadmin"
```

This is the format of SMS deliver messages as output from gsmsmsd:

```
----------------------------------------------------------------
Message type: SMS-DELIVER
SC address: '491710762100'
More messages to send: 1
Reply path: 0
User data header indicator: 0
Status report indication: 0
Originating address: '01805000102'
Protocol identifier: 0x39
Data coding scheme: default alphabet
SC timestamp: 17.12.98 14:10:55(+0100)
User data length: 159
User data header: 0x
User data: 'Nicht vergessen! Die XtraWeihnachtsverlosung lauft
noch bis zum 24.12. Nutzen Sie jetzt Ihre Gewinnchance und faxen
Sie Ihren Teiln.-Gutschein an 0180/5000 056'
----------------------------------------------------------------
```

This is the format of SMS status report messages as output from gsmsmsd:

```
----------------------------------------------------------------
Message type: SMS-STATUS-REPORT
SC address: ''
More messages to send: 0
Status report qualifier: 0
Message reference: 0
Recipient address: ''
SC timestamp: 00.00.00 00:00:00(+0000)
Discharge time: 00.00.00 00:00:00(+0000)
Status: 0x0 'Short message received by the SME'
----------------------------------------------------------------
```

The following invocation of gsmsmsd flushes all existing messages from the "SM" SMS store and looks in the "/tmp/spooldir" directory for SMS to send:

```
gsmsmsd -d /dev/ttyS2 --spool /tmp/spooldir -f --store sm \
--action 'mail smsadmin'
```

The following invocation of gsmsmsd uses the priority system with two levels and preserves sent and failed SMS. It requires the following directories in /var/spool/sms/: queue1/ queue2/ send1/ send2/ failed1/ failed2/

Before sending one SMS from queue2, all pending SMS from queue1 will be sent. Sent messages from queue1 will be moved to send1, sent messages from queue2 to send2. Failed messages will be moved to failed1 and failed2.

```
gsmsmsd -d /dev/ttyS2 -P 2 -s /var/spool/sms/queue \
-S /var/spool/sms/send -F /var/spool/sms/failed
```

## FILES
/dev/mobilephone

Default mobile phone device.

## AUTHORS
Peter Hofmann <software@pxh.de> (main work)

Matthias Goebl <matthias.goebl@goebl.net> (priority system, error restart, syslog)

## BUGS
Cell broadcast SMS message reception has not been tested, but it has been enabled in the gsmsmsd daemon.

The mobile phone device is blocked when the gsmsmsd daemon is running, ie. it cannot be used for data transfer or from the other programs of this suite (gsmpb, gsmsms).

Report bugs to software@pxh.de. Include a complete, self-contained example that will allow the bug to be reproduced, and say which version of gsmsmsd you are using.

## COPYRIGHT
Copyright © 1999 Peter Hofmann

gsmsmsd is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version.

gsmsmsd 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 Library General Public License for more details.

You should have received a copy of the GNU Library General Public License along with gsmsmsd; see the file COPYING. If not, write to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

## SEE ALSO
gsminfo(7), gsmpb(1), gsmctl(1), gsmsendsms(1), gsmsmsstore(1).


gssntlmssp

package: gssntlmssp

title: gssntlmssp(8)

text:
# gssntlmssp(8)

## NAME
gssntlmssp - GSSAPI NTLM Security Service Provider mechanism

## SYNOPSIS
gssntlmssp_v1 2.16.840.1.113730.3.8.15.X /usr/lib64/gssntlmssp/gssntlmssp.so [options]

## DESCRIPTION
A GSSAPI NTLM mechanism that allows to perform NTLM authentication in GSSAPI programs.

## SEE ALSO
gssapi(8).

## AUTHORS
GSS-NTLMSSP - http://ssimo.org/gss-ntlmssp


gssproxy

package: gssproxy

title: gssproxy(8)

summary: GssProxy Daemon

text:
# gssproxy(8)

## NAME
gssproxy - GssProxy Daemon

## SYNOPSIS
gssproxy [options]

## DESCRIPTION
gssproxy provides a daemon to manage access to GSSAPI credentials.

gssproxy consists of the gssproxy daemon (configured by the gssproxy.conf(5) file) and a GSSAPI interposer plugin (gssproxy-mech(8)).

## OPTIONS
-D,--daemon

Become a daemon after starting up.

-c,--config

Specify a config file to use as the main config file (read before the rest of the config directory). The default is to use the file /etc/gssproxy/gssproxy.conf. For reference on the config file syntax and options, consult the gssproxy.conf(5) manual page.

-C,--configdir

Specify a non-default config dir. Files named of the form "##-foo.conf" (that is, beginning with two digits and a dash, and ending in ".conf") will be read in numeric order from this directory, in addition to the config file itself. The default is /etc/gssproxy. For reference on the config file syntax and options, consult the gssproxy.conf(5) manual page.

-d,--debug

Turn on debugging. This option is identical to --debug-level=1.

--debug-level=

Turn on debugging at the specified level. 0 corresponds to no logging, while 1 turns on basic debug logging. Level 2 increases verbosity, including more detailed credential verification. At level 3 and above, KRB5_TRACE output is logged. If KRB5_TRACE was already set in the execution environment, trace output is sent to its value instead.

-i,--interactive

Run in the foreground, don't become a daemon.

-s,--socket

Specify a custom default socket name. This socket will be used by all sections that do not define an explicit socket.

--syslog-status

Enable additional logging to syslog.

--version

Print version number and exit.

## SIGNALS
SIGTERM/SIGINT

Informs the GssProxy to gracefully terminate all of its child processes and then shut down.

SIGHUP

Request a reload of all configuration for gssproxy. If there is an error in the configuration files, the existing configuration will not be replaced; if there is a problem applying the new configuration, gssproxy will exit.

## SEE ALSO
gssproxy.conf(5) and gssproxy-mech(8).

## AUTHORS
GSS-Proxy - http://fedorahosted.org/gss-proxy


gssproxy-mech

title: gssproxy-mech(8)

summary: GssProxy GSSAPI mechanism plugin

text:
# gssproxy-mech(8)

## NAME
gssproxy-mech - GssProxy GSSAPI mechanism plugin

## SYNOPSIS
proxymech_v1 2.16.840.1.113730.3.8.15.1 /usr/lib64/gssproxy/proxymech.so [options]

## DESCRIPTION
The gssproxy proxymech module is a interposer plugin that is loaded by GSSAPI. It is enabled by /etc/gss/mech configuration file.

The interposer plugin allows to intercept the entire GSSAPI communication and detour to the gssproxy daemon. When the interposer plugin is installed two other conditions need to be met in order to activate it:

a) interposer configuration file

The plugin needs to be manually enabled in the /etc/gss/mech file.

b) gssproxy environment variable

The interposer plugin will not forward to the gssproxy daemon unless the environment variable named GSS_USE_PROXY=yes is set.

Furthermore, the interposer plugin can be configured to behave in different ways when called from the GSSAPI. This behavior is controlled via the GSSPROXY_BEHAVIOR environment variable. It accepts four different values:

LOCAL_ONLY

All commands received with this setting will cause to immediately reenter the GSSAPI w/o any interaction with the gssproxy daemon. When the request cannot be processed it will just fail.

LOCAL_FIRST

All commands received with this setting will cause to immediately reenter the GSSAPI. When the local GSSAPI cannot process the request, it will resend the request to the gssproxy daemon.

REMOTE_FIRST

All commands received with this setting will be forwarded to the gssproxy daemon first. If the request cannot be handled there, the request will reenter the local GSSAPI.

REMOTE_ONLY

This setting is currently not fully implemented and therefor not supported.

The default setting for GSSPROXY_BEHAVIOR is REMOTE_FIRST.

Finally the interposer may need to use a special per-service socket in order to communicate with gssproxy. The path to this socket is set via the GSSPROXY_SOCKET environment variable.

## SEE ALSO
gssproxy.conf(5) and gssproxy(8).

## AUTHORS
GSS-Proxy - http://fedorahosted.org/gss-proxy


guacd

package: guacd

title: guacd(8)

summary: Guacamole proxy daemon

text:
# guacd(8)

## NAME
guacd - Guacamole proxy daemon

## SYNOPSIS
guacd [-b HOST] [-l PORT] [-p PID FILE] [-L LOG LEVEL] [-C CERTIFICATE FILE] [-K KEY FILE] [-f] [-v]

## DESCRIPTION
guacd is the Guacamole proxy daemon used by the Guacamole web application and framework. As JavaScript cannot handle binary protocols (like VNC and remote desktop) efficiently, a new text-based protocol was developed which would contain a common superset of the operations needed for efficient remote desktop access, but would be easy for JavaScript programs to process. guacd is the proxy which translates between arbitrary protocols and the Guacamole protocol.

## OPTIONS
-b HOST

Changes the host or address that guacd listens on.

-l PORT

Changes the port that guacd listens on (the default is port 4822).

-p FILE

Causes guacd to write the PID of the daemon process to the specified file. This is useful for init scripts and is used by the provided init script.

-L LEVEL

Sets the maximum level at which guacd will log messages to syslog and, if running in the foreground, the console. Legal values are trace, debug, info, warning, and error. The default value is info.

-f

Causes guacd to run in the foreground, rather than automatically forking into the background.

-v

Causes guacd to simply print its version information and exit.

## SSL/TLS OPTIONS
If libssl was present at the time guacd was compiled, it will contain SSL/TLS support, and connections between the web application and guacd can be encrypted if a certificate file is given.

When using a chain of certificates, you must append the additional certificates to your server certificate. This can be done easily with the standard cat command. Beware that the certificate for guacd must be the first certificate in the file.

-C CERTIFICATE FILE

Enables SSL/TLS using the given certificate file. Future connections to this instance of guacd will require SSL/TLS enabled in the client (the web application). If this option is not given, communication with guacd must be unencrypted.

-K KEY FILE

Enables SSL/TLS using the given private key file. Future connections to this instance of guacd will require SSL/TLS enabled in the client (the web application). If this option is not given, communication with guacd must be unencrypted.

## SEE ALSO
guacd.conf(5)


guestfsd

package: guestfsd

title: guestfsd(8)

summary: guestfs daemon

text:
# guestfsd(8)

## NAME
guestfsd - guestfs daemon

## SYNOPSIS

```
 guestfsd [-r] [-v|--verbose]
```

## DESCRIPTION
"guestfsd" is the libguestfs daemon. Normal users never need to run this program explicitly. This man page discusses what "guestfsd" does in both the libguestfs appliance and when using libguestfs live.

### LIBGUESTFS APPLIANCE
For the architecture of the libguestfs appliance, see "ARCHITECTURE" in guestfs(3).

After the appliance boots, the /init script in the appliance starts "guestfsd" with no arguments. "guestfsd" opens the virtio-serial port on a known path (see "FILES"). It initiates the protocol (see "COMMUNICATION PROTOCOL" in guestfs(3)) and processes requests one at a time from the library until the appliance is destroyed.

Filesystems are mounted under /sysroot and all filesystem operations happen relative to this directory.

### LIBGUESTFS LIVE
In the libguestfs live case, "guestfsd -r" is started from the rc-scripts, systemd, etc.

The "-r" option causes the daemon to operate on the root filesystem instead of /sysroot.

Currently (because of limitations in virtio-serial) only one client can connect at a time, and "guestfsd" must be restarted after each client disconnects. If libguestfs live were changed to use a different transport such as TCP/IP then this limitation could be removed.

## OPTIONS
-?

--help

Display brief help.

-c CHANNEL

--channel CHANNEL

--channel fd:N

Pass the name of the virtio-serial channel, serial port, etc. over which guestfsd will communicate with the library. If this parameter is not given, then an internal default port is used. The "fd:N" form causes guestfsd to use the file descriptor "N" directly.

-l

--listen

Instead of opening the "guestfs_channel" and thus expecting that it already exists, create the channel as a Unix domain socket, listen on it, and accept a single connection. This is mainly used for testing the daemon.

-n

--network

Enable network features in the daemon.

-r

Set the root filesystem to be / (instead of the default which is /sysroot). Also do not unmount filesystems when the daemon exits. This option is used to enable libguestfs live.

-v

--verbose

Enable verbose messages for debugging. The verbose flag is also set if the Linux command line contains the substring "guestfs_verbose=1".

## EXIT STATUS
This program returns 0 if successful, or non-zero if there was an error.

## FILES
/dev/virtio-ports/org.libguestfs.channel.0

The virtio serial port which "guestfsd" connects to.

/proc/cmdline

The Linux command line is parsed to discover "guestfs_*" flags. The following flags are understood:

guestfs_verbose=1

Enable verbose messages. This flag is passed by the libguestfs library to the appliance to make the daemon more verbose (it acts like the -v flag on the command line). Unrelated to the daemon, it also causes the appliance init script to print out a lot more debugging information.

guestfs_channel=PATH

Set the path to the virtio-serial channel to something other than the default (which is /dev/virtio-ports/org.libguestfs.channel.0). This is used by the User-Mode Linux backend to use a regular emulated serial port instead of virtio-serial.

guestfs_network=1

This is set if the appliance network is enabled (see "guestfs_set_network").

## SEE ALSO
guestfs(3), http://libguestfs.org/.

## AUTHOR
Richard W.M. Jones http://people.redhat.com/~rjones/

## COPYRIGHT
Copyright (C) 2009-2020 Red Hat Inc.

## LICENSE
This program is free software; 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.

This program 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 program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

## BUGS
To get a list of bugs against libguestfs, use this link: https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools

To report a new bug against libguestfs, use this link: https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools

When reporting a bug, please supply:

- The version of libguestfs.

- Where you got libguestfs (eg. which Linux distro, compiled from source, etc)

- Describe the bug accurately and give a way to reproduce it.

- Run libguestfs-test-tool(1) and paste the complete, unedited output into the bug report.


cups-calibrate

package: gutenprint-cups

title: cups-calibrate(8)

summary: ESP CUPS Printer Calibration Tool

text:
# cups-calibrate(8)

## NAME
cups-calibrate - ESP CUPS Printer Calibration Tool

## SYNOPSIS
cups-calibrate

## DESCRIPTION
This program allows you to calibrate the color output of printers using the Gutenprint CUPS driver. Please note that this program only works with the Gutenprint CUPS driver.

These drivers are identified by the text CUPS+Gutenprint in the model description displayed by the CUPS web interface.

To make a calibration profile for all users, run this program as the root user. The program displays a series of prompts which should simply be followed.

## SEE ALSO
CUPS Software Administrators Manual, http://localhost:631/documentation.html

## COPYRIGHT
Copyright © 2001 Michael Sweet (mike@easysw.com)

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2, as published by the Free Software Foundation.

This manual page was written by Roger Leigh (rleigh@debian.org).


cups-genppd

title: cups-genppd(8)

text:
# cups-genppd(8)

## NAME
cups-genppd - generate Gutenprint PPD files for use with CUPS

## SYNOPSIS
cups-genppd [-c localedir] [-l locale] [-p prefix] [-q] [-v] model1 [model2, ...modeln]

cups-genppd -L [-c localedir]

cups-genppd -M [-v]

cups-genppd -h

cups-genppd -V

## DESCRIPTION
cups-genppd generates Gutenprint PPD files for use with CUPS. The default behavior is to output PPD files for all models of printer that the Gutenprint printer driver library supports. You may restrict the models by listing either the driver names or the full names of the printers you wish to generate PPD files for after any options. Additionally, the PPD files may be localised, that is, translated, to use your native language rather than US English. There are commands to find out what printer models and languages are supported.

## EXAMPLES
cups-genppd -v bjc-6200 'Epson Stylus Photo 1280' 'HP DeskJet 850C'

verbosely generate three PPD files, listing the driver name in the first case, and the full name in the second.

LANG=de_DE genppd -p ppd -c /usr/share/locale

generate PPDs for all available models, in directory ppd using the locale data found under /usr/share/locale. The language to use is taken from the environment (de_DE).

cups-genppd -L -c /usr/local/share/locale

list available languages using the locale data found under /usr/local/share/locale.

cups-genppd -M -v

list available drivers, with long model descriptions

## COMMANDS
-h

show a help message

-L

list available translations (message catalogs). If a locale is used for which there is not a corresponding translation, then then US English will be used.

-M

list available printer models. By default, only driver names are listed; if verbose mode is used, the full model name will also be printed

-V

show version information and defaults

The default behavior is to output PPDs if no command is given.

## OPTIONS
-c localedir

use localedir as the base directory for locale data

-l locale

output PPDs translated with messages for locale. Note that locale must be a locale as shown by locale -a. For example, the de translation is used by the de_DE locale; de alone will not work.

-p prefix

output PPDs in directory prefix. Directories are not recursively created.

-q

Quiet mode.

-v

Verbose mode.

models

a list of printer models, either the driver or quoted full name.

## SEE ALSO
CUPS Software Administrators Manual, http://localhost:631/documentation.html

## COPYRIGHT
Copyright © 1992-2002 Michael Sweet (mike@easysw.com)

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2, as published by the Free Software Foundation.

This manual page was written by Roger Leigh (rleigh@debian.org).


cups-genppdupdate

title: cups-genppdupdate(8)

summary: update CUPS+Gutenprint PPD files

text:
# cups-genppdupdate(8)

## NAME
cups-genppdupdate - update CUPS+Gutenprint PPD files

## SYNOPSIS
cups-genppdupdate [-h] [-n] [-N] [-q | -v] [-s ppd-directory] [-s output-directory] [PPD-FILES or QUEUES...]

## DESCRIPTION
cups-genppdupdate regenerates the Gutenprint PPD files in use by CUPS, using the PPD files under /usr/share/cups/model/gutenprint as templates. The new PPD file replaces the old PPD file under /etc/cups/ppd, but all the options set in the old PPD will be merged into the new PPD, provided that they are still valid in the new file.

If no files or queue names are specified, cups-genppdupdate updates all Gutenprint PPD files in /etc/cups/ppd. Otherwise, cups-genppdupdate updates all files or queues listed on the command line.

cups-genppdupdate does not update PPD files from Gimp-Print 4.2 or earlier.

cups-genppdupdate does not restart cupsd. cupsd will need manually reloading (or send SIGHUP) once cups-genppdupdate has completed.

## OPTIONS
-h

Show a help message.

-n

No action. The program will run, but the old PPD files will not be replaced.

-q

Quiet mode. No messages will be issued, apart from errors.

-v

Verbose mode. More informative messages will be issued. Note that extremely verbose output may be turned on by setting $debug=1 in the source, but this output will not be of use to the average user.

-s ppd-directory

Use ppd-directory as the base directory to read PPD files from. By default, the base directory is /usr/share/cups/model/gutenprint. Under this directory, the PPD files are located in subdirectories according to language code and territory.

-o output-directory

Place updated PPD files in output-directory. By default, this is the same as the input directory.

-N

Reset all options to their defaults (do not merge options from the current PPD file)

## SEE ALSO
cups-genppd(8), cups-genppdconfig(8), CUPS Software Administrators Manual, http://localhost:631/documentation.html

## COPYRIGHT
Copyright © 2002-2006 Roger Leigh (rleigh@debian.org) and Robert Krawitz (rlk@alum.mit.edu)

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2, as published by the Free Software Foundation.

This manual page was written by Roger Leigh (rleigh@debian.org).


gvpe

package: gvpe

title: gvpe(8)

summary: GNU Virtual Private Ethernet Daemon

text:
# gvpe(8)

## NAME
"gvpe" - GNU Virtual Private Ethernet Daemon

## SYNOPSIS
gvpe [-cDlL] [--config=DIR] [--no-detach] [-l=LEVEL]] [--kill[=SIGNAL]] [--mlock] [--help] [--version] NODENAME [option...]

## DESCRIPTION
See the gvpe(5) man page for an introduction to the gvpe suite.

This is the manual page for gvpe, the virtual private ethernet daemon. When started, gvpe will read it's configuration file to determine the network topology, and other configuration information, assuming the role of node NODENAME

It will then create/connect to the tun/tap device and set up a socket for incoming connections. Then a if-up script will be executed to further configure the virtual network device. If that succeeds, it will detach from the controlling terminal and continue in the background, accepting and setting up connections to other gvpe daemons that are part of the same virtual private ethernet.

The optional arguments after the node name have to be of the form:

```
   [I<nodename>.]var=value
```

If the argument has a prefix of nodename. (i.e. laptop.enable-dns=yes) then it will be parsed after all the config directives for that node, if not, it is parsed before the first node directive in the config file, and can be used to set global options or default variables.

For example, to start gvpe in the foreground, with log-level info on the node laptop, with TCP enabled and HTTP-Proxy host and Port set, use this:

```
  gvpe -D -l info laptop \
       http-proxy-host=10.0.0.18 http-proxy-port=3128 \
       laptop.enable-tcp=yes
```

## OPTIONS
-c, --config=DIR

Read configuration options from DIR

-d, --l=LEVEL

Set logging level to LEVEL (one of: noise, trace, debug, info, notice, warn, error, critical).

--help

Display short list of options.

-D, --no-detach

Don't fork and detach but stay in foreground and log messages to stderr in addition to syslog.

-L, --mlock

Lock gvpe into main memory. This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.

--version

Output version information and exit.

## SIGNALS
HUP

Closes/resets all connections, resets the retry time and will start connecting again (it will NOT re-read the config file). This is useful e.g. in a /etc/ppp/if-up script.

TERM

Closes/resets all connections and exits.

USR1

Dump current network status into the syslog (at loglevel notice, so make sure your loglevel allows this).

## FILES
/etc/gvpe/gvpe.conf

The configuration file for gvpe.

/etc/gvpe/if-up

Script which is executed as soon as the virtual network device has been allocated. Purpose is to further configure that device.

/etc/gvpe/node-up

Script which is executed whenever a node connects to this node. This can be used for example to run nsupdate.

/etc/gvpe/node-down

Script which is executed whenever a connection to another node is lost. for example to run nsupdate.

/etc/gvpe/pubkey/*

The directory containing the public keys for every node, one file per node with the name of the node.

/etc/gvpe/hostkey

The file containing the private key of the node GVPE runs on. Unlike all the other files in the /etc/gvpe directory, this file usually differes for each node that GVPE runs on.

/var/run/gvpe.pid

The PID of the currently running gvpe is stored in this file.

## BUGS
The cryptography in gvpe has not been thoroughly checked by many people yet. Use it at your own risk!

If you find any bugs, report them to gvpe@schmorp.de.

## SEE ALSO
gvpe(5) for an introduction, gvpe.conf(5), gvpectrl(8).

The GVPE mailing list, at <http://lists.schmorp.de/> or gvpe@lists.schmorp.de.

GVPE comes with ABSOLUTELY NO WARRANTY. This is free software, and you are welcome to redistribute it under certain conditions; see the file COPYING for details.

## AUTHOR
Marc Lehmann <gvpe@schmorp.de>.

And thanks to many others for their contributions to gvpe, especially the tincd authors, who inspired me to write this program (after scavenging their source code ;).


gvpectrl

title: gvpectrl(8)

text:
# gvpectrl(8)

## NAME
"gvpectrl" - GNU Virtual Private Ethernet Control Program

## SYNOPSIS
gvpectrl [-ckgs] [--config=DIR] [--generate-keys] [--help] [--kill[=SIGNAL]] [--show-config] [--version]

## DESCRIPTION
This is the control program for the gvpe, the virtual private ethernet daemon.

## OPTIONS
-c, --config=DIR

Read configuration options from DIR.

-g, --generate-key=path

Generates a single RSA key-pair. The public key will be stored in path while the private key will be stored in path .privkey. Neither file must be non-empty for this to succeed. The public key file path is normally copied to pubkey/nodename in the config directory on all nodes, while the private key path.privkey should be copied to the file hostkey on the node the key is for.

It's recommended to generate the keypair on the node where it will be used, so that the private key file does not have to travel over the network.

-G, --generate-keys

Generate public/private RSA key-pairs for all nodes not having a key and exit. Note that in normal configurations this will fail, as there cna only be one private key per host. To make this configuration work you need to specify separate keyfiles for hostkeys in your config file, e.g.:

```
   private-key = hostkeys/%s

```

Such a configuration makes it easier to distribute a configuration centrally but requires private keys to be transported securely over the network.

-q, --quiet

Suppresses messages the author finds nonessential for scripting purposes.

--help

Display short list of options.

--kill[=SIGNAL]

Attempt to kill a running gvpectrl (optionally with the specified SIGNAL instead of SIGTERM) and exit.

--show-config

Show a summary of the configuration, and how gvpe interprets it. Can also be very useful when designing firewall scripts.

--version

Output version information and exit.

## BUGS
If you find any bugs, report them to gvpe@schmorp.de.

## SEE ALSO
gvpe(5), gvpe.conf(5), gvpe(8).

GVPE comes with ABSOLUTELY NO WARRANTY. This is free software, and you are welcome to redistribute it under certain conditions; see the file COPYING for details.

## AUTHOR
Marc Lehmann <gvpe@schmorp.de>.


hashalot

package: hashalot

title: hashalot(8)

summary: read a passphrase and print a hash

text:
# hashalot(8)

## NAME
hashalot - read a passphrase and print a hash

## SYNOPSIS
hashalot [ -s SALT ] [ -x ] [ -n #BYTES ] HASHTYPE

HASHTYPE [ -s SALT ] [ -x ] [ -n #BYTES ]

## DESCRIPTION
hashalot is a small tool that reads a passphrase from standard input, hashes it using the given hash type, and prints the result to standard output.

Supported values for HASHTYPE:

ripemd160 rmd160 rmd160compat sha256 sha384 sha512

## OPTIONS
The option -s SALT specifies an initialization vector to the hashing algorithm. You need this if you want to prevent identical passwords to map to identical hashes, which is a security risk.

If the -x option is given then the hash will be printed as a string of hexadecimal digits.

The -n option can be used to limit (or increase) the number of bytes output. The default is as appropriate for the specified hash algorithm: 20 bytes for RIPEMD160, 32 bytes for SHA256, etc. The default for the "rmd160compat" hash is 16 bytes, for compatibility with the old kerneli.org utilities.

## AUTHOR
Ben Slusky <sluskyb@paranoiacs.org>

This manual page was written by Matthias Urlichs <smurf@debian.org>.


hasher-priv

package: hasher-priv

title: hasher-priv(8)

text:
# hasher-priv(8)

## NAME
hasher-priv - privileged helper for the hasher project

## SYNOPSIS
hasher-priv [options] <args>

## DESCRIPTION
Privileged helper for the hasher project.

### Valid options are:
-<number>:

subconfig identifier;

--version:

print program version and exit.

-h or --help:

print this help text and exit.

Valid args are any of:

### getconf:

print config file name;

### killuid:

kill all processes of user1 and user2;

### getugid1:

print uid:gid pair for user1;

### chrootuid1 <chroot path> <program> [program args]:

execute program in given chroot with credentials of user1;

### getugid2:

print uid:gid pair for user2;

### chrootuid2 <chroot path> <program> [program args]:

execute program in given chroot with credentials of user2;

## SECURITY
Following operation modes are not security sensitive:

getugid1, getugid2

Query pseudouser identifiers.

Following operation modes have minimal security implications:

killuid

Kill all processes running by pseudousers.

Following operation modes have high security implications:

chrootuid1, chrootuid2

Execute program in build chroot with credentials of pseudouser. This operation also unshares mount namespace and mounts all mount points that are specified by requested_mountpoints environment variable and allowed by allowed_devices or allowed_mountpoints configuration options. Note that some of file systems are more security sensitive than others. For example, proc and sysfs virtual file systems provide access to various system resources which could be abused by pseudousers, devpts virtual file system provides access to all pty device files (unless mounted with newinstance mount option) which also could be abused by pseudousers if these files have inappropriate permissions.

This operation also creates essential device files available for all users: null, zero, full, and urandom. Pseudousers may abuse urandom to cause host system randomness starvation.

If /dev/pts is mounted, this operation also creates terminal device files: tty (current tty device) and ptmx (PTY master multiplex).

All risky operation modes are not enabled by default. They could be explicitly enabled in hasher-priv configuration.

## ENVIRONMENT
The following environment variables are processed by hasher-priv:

requested_mountpoints

Defines a comma-separated list of mount points which shall be mounted in chrootuid1 and chrootuid2 operation modes, if allowed by allowed_devices or allowed_mountpoints configuration options.

wlimit_time_elapsed

Define total execution time limit, in seconds. If wlimit_time_elapsed config parameter is also set, then minimal value will be used.

wlimit_time_idle

Define idle time limit, in seconds. Idle time is a period when child process produces no output. If wlimit_time_idle config parameter is also set, then minimal value will be used.

wlimit_bytes_written

Define limit of output generated by child process, in bytes. If wlimit_bytes_written config parameter is also set, then minimal value will be used.

use_pty

This boolean specifies whether stdin, stdout and stderr of child process will be redirected to controlling pseudoterminal created by hasher-priv. By default, stdin remains unchanged unless it references to terminal device, and stdout with stderr are redirected to pipe created by hasher-priv.

share_ipc

This boolean specifies whether IPC namespace inside chroot should be shared with host IPC namespace. By default, IPC namespace inside chroot is isolated from host IPC namespace if unshare(CLONE_NEWIPC) syscall is supported by kernel.

share_network

This boolean specifies whether network inside chroot should be shared with host network. By default, network inside chroot is isolated from host network if unshare(CLONE_NEWNET) syscall is supported by kernel.

share_uts

This boolean specifies whether UTS namespace inside chroot should be shared with host UTS namespace. By default, UTS namespace inside chroot is isolated from host UTS namespace if unshare(CLONE_NEWUTS) syscall is supported by kernel.

TERM

This variable will be passed to child process if use_pty is set to true.

## FILES
/etc/hasher-priv/system

systemwide config file

/etc/hasher-priv/user.d/USER

per-user config files

/etc/hasher-priv/user.d/USER:NUMBER

per-user per-number subconfig files

## AUTHOR
Written by Dmitry V. Levin <ldv@altlinux.org> et al.

## COPYRIGHT
Copyright © 2003-2013 Dmitry V. Levin <ldv@altlinux.org>

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

## SEE ALSO
unshare(2), hasher-priv.conf(5), hasher(7), hasher-useradd(8).


hasher-useradd

title: hasher-useradd(8)

summary: create hasher satellite users

text:
# hasher-useradd(8)

## NAME
hasher-useradd - create hasher satellite users

## SYNOPSIS
hasher-useradd [options] <user>

## DESCRIPTION
hasher-useradd - adds hasher satellite users for already existing user, and creates hasher-priv config file.

### Valid options are:
--names=USER1:USER2

names for satellite users;

--number=NUMBER

subconfig identifier;

-r, --system

pass this option to useradd(8);

-V, --version

print program version and exit;

-h, --help

show this text and exit.

By default, satellite user names will be choosen based on <user>.

## AUTHOR
Written by Dmitry V. Levin <ldv@altlinux.org>

## COPYRIGHT
Copyright © 2003-2019 Dmitry V. Levin <ldv@altlinux.org>

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

## SEE ALSO
hsh(1), hasher-priv.conf(5), hasher(7), useradd(8).