File: pyaarlo.1

package info (click to toggle)
python-pyaarlo 0.8.0.15-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 556 kB
  • sloc: python: 6,064; makefile: 6; sh: 1
file content (105 lines) | stat: -rw-r--r-- 2,606 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
.TH PYAARLO 1
.SH NAME
pyaarlo \- List devices, perform simple actions and anonymize/encrypt logs for debugging
.SH SYNOPSIS
\fBpyaarlo [OPTIONS] COMMAND [ARGS]...\fR
.SH DESCRIPTION
pyaarlo is a Python module to manage Aarlo cameras. The \fBpyaarlo\fR executable performs simple actions.

This manual page is for the \fBpyaarlo\fR executable. The Python module documentation is available in \fI/usr/share/doc/python3-pyaarlo/README.md.gz\fR.

.SS COMMANDS

Help specific to each command is available by executing \fBpyaarlo COMMAND --help\fR.

.TP
\fBanonymize\fR
Anonymize and encrypt logs for debugging purposes. For example:
.IP
cat output-file | pyaarlo -u username -p password anonymize

.TP
\fBcamera\fR
Start or stop the camera, or take thumbnails. Requires an argument from {start-stream|stop-stream|last-thumbnail}. For example:
.IP
pyaarlo -u username -p password camera last-thumbnail

.TP
\fBdecrypt\fR
Decrypt from stdin. For example:
.IP
cat encrypted | pyaarlo decrypt

.TP
\fBdump\fR
Print out everything that was returned from Arlo about the devices in the system. For example:
.IP
pyaarlo dump all

.TP
\fBencrypt\fR
Encrypt from stdin. For example:
.IP
cat output-file | pyaarlo encrypt

.TP
\fBlist\fR
Requires an argument from {all|cameras|bases|lights|doorbells}. For example:
.IP
pyaarlo -u username -p password list all

.SS OPTIONS
.TP
\fB-u, --username TEXT\fR
Aarlo username.

.TP
\fB-p, --password TEXT\fR
Aarlo password.

.TP
\fB-a, --anonymize / --no-anonymize\fR
Anonymize ids.

.TP
\fB-c, --compact / --no-compact\fR
Minimize lists.

.TP
\fB-e, --encrypt / --no-encrypt\fR
Where possible, encrypt output.

.TP
\fB-k, --public-key TEXT\fR
Public key for encryption.

.TP
\fB-K, --private-key TEXT\fR
Private key for decryption.

.TP
\fB-P, --pass-phrase TEXT\fR
Pass phrase for private key.

.TP
\fB-s, --storage-dir TEXT\fR.
Where to store Aarlo state and packet dump [default: (current dir)]

.TP
\fB-w, --wait / --no-wait\fR.
Wait for all information to arrive on start-up.

.TP
\fB-v, --verbose\fR.
More vebose with multiple -v.

.TP
\fB--help\fR.
Show help message and exit.

.SH AUTHOR
This manual page was written by Carles Pina i Estany <carles@pina.cat> for the \fBDebian\fR system (but may be used by others). Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 any later version published by the Free Software Foundation.

.SH SEE ALSO
Full Pyaarlo full documentation <https://pyaarlo.readthedocs.io/en/latest/> or available locally in </usr/share/doc/python3-pyaarlo/README.md.gz>.