Skip to content

Linux + iPhone Continuity / iMessage / SMS

docs(man): document the subcommand form

Anthony Ettingerceb4253b2e84
diff --git a/docs/man/man1/tether.1.in b/docs/man/man1/tether.1.in
index 05ecc2e..33d4ee9 100644
--- a/docs/man/man1/tether.1.in
+++ b/docs/man/man1/tether.1.in
@@ -4,11 +4,17 @@ tether \- Wayland companion CLI for iPhone integration
.SH SYNOPSIS
.B tether
[\fIOPTIONS\fR]
+.br
+.B tether
+\fICOMMAND\fR [\fIARGUMENTS\fR]
.SH DESCRIPTION
.B tether
is a command-line interface for communicating with the Tether daemon (\fBtetherd\fR).
It allows for clipboard synchronization, file transfers, and device management between
a Linux Wayland desktop and an iOS device.
+.PP
+Most options also have a subcommand form, so \fBtether devices\fR and
+\fBtether \-\-list-devices\fR are the same thing. See \fBCOMMANDS\fR.
.SH OPTIONS
.TP
\fB\-h, \-\-help\fR
@@ -65,6 +71,26 @@ distro packages install the manifests system\-wide.
Write \[email protected]\fR to \fB/etc/systemd/system\fR. Needs root, and
never enables it. Needed only for a portable build such as the AppImage; the distro
packages install the unit themselves. See \fB\-\-bt-setup\fR.
+.SH COMMANDS
+Each of these is the option named beside it, so nothing behaves differently for
+having been typed as a word. A first argument that is not one of these, or that
+starts with a dash, is left for the option parser.
+.TP
+\fBdevices\fR
+\fB\-\-list-devices\fR
+.TP
+\fBaccept\fR \fIFINGERPRINT\fR, \fBforget\fR \fIFINGERPRINT\fR, \fBpair\fR
+\fB\-\-accept\fR, \fB\-\-forget\fR, \fB\-\-pair\fR
+.TP
+\fBdiscover\fR, \fBsend\fR \fIFILE\fR, \fBcopy\fR [\fISTRING\fR], \fBpaste\fR
+\fB\-\-discover\fR, \fB\-\-send-file\fR, \fB\-\-set-clipboard\fR, \fB\-\-get-clipboard\fR
+.TP
+\fBversion\fR, \fBhelp\fR
+\fB\-\-version\fR, \fB\-\-help\fR
+.TP
+\fBbt\fR \fINAME\fR [\fIARGUMENTS\fR]
+The \fB\-\-bt-\fR\fINAME\fR option, so \fBtether bt pair AA:BB:CC:DD:EE:FF\fR is
+\fBtether \-\-bt-pair AA:BB:CC:DD:EE:FF\fR.
.SH BLUETOOTH OPTIONS
Bluetooth carries iPhone messages (MAP), contacts (PBAP), and notification
mirroring (ANCS). It is independent of the Wi-Fi pairing above.
@@ -201,6 +227,12 @@ tether \-f document.pdf
See what Bluetooth still needs before pairing an iPhone:
.IP
tether \-\-bt-setup
+.PP
+The same things, as subcommands:
+.IP
+tether send document.pdf
+.IP
+tether bt setup
.SH FILES
.TP
\fB/usr/lib/systemd/system/tether\[email protected]\fR