]> www.average.org Git - loctrkd.git/blob - docs/loctrkd.1
Update changelog for 1.98 release
[loctrkd.git] / docs / loctrkd.1
1 .TH LOCTRKD 1 2022-05-27 "LOCTRKD GPS Tracker Service" "User Commands"
2
3 .SH NAME
4
5 loctrkd \- utility to send control messages to the GPS tracker terminal
6
7 .SH SYNOPSIS
8
9 loctrkd [-c /path/to/config/file] [-d]
10
11 .SH DESCRIPTION
12
13 Command line tool to send "unsolicited reply" messages to the tracker.
14 There are messages to configure settings in the terminal, or to request
15 actions, such as to start a monitoring call, or to power off.
16
17 .SH OPTIONS
18
19 .TP 0.5i
20 .B -d
21 Set "debug" level of logging
22
23 .TP 0.5i
24 .B -c /path/to/config
25 Location of the configuration file (default /etc/loctrkd.conf)
26
27 .SH COMMANDS
28
29 After the options, IMEI (16 decimal characters) and the command verb
30 must be specified, optionally followed by a list of
31 .B key=value
32 pairs. The command verb is a case insensitive abbreviation that
33 uniquely identifies a class from the file loctrkd/loctrkdproto.py.
34 These classes correspond to message types recognized by the terminal.
35 Only a few of them are useful to construct "unsolicited replies".
36 .B key=value
37 pairs must specify kwargs for the constructor of the "Out" subclass
38 of the class.
39
40 .SH KNOWN BUGS
41
42 The command sends the message to the "collector" daemon for sending
43 to the terminal. There is no guarantee that the terminal is online
44 at the moment of execution, and there is no feedback. The only way
45 to verify that the command was successfully sent is to check the log
46 of the collector.
47
48 .SH COPYRIGHT
49
50 The program is copyrighted by Eugene G. Crosser <crosser@average.org>
51 and freely distributable under the terms of MIT license.
52
53 .SH CREDITS
54
55 The program is inspired by the project petGPS by Thomas Obadia
56
57 .SH SEE ALSO
58
59 .BR loctrkd.conf (5)