aboutsummaryrefslogtreecommitdiffhomepage
path: root/man
diff options
context:
space:
mode:
authorGravatar Keith Winstein <keithw@mit.edu>2012-03-10 03:48:46 -0500
committerGravatar Keith Winstein <keithw@mit.edu>2012-03-10 03:48:46 -0500
commit0fe911ce20ebe4ade0fc82611f46a8d7889fa8c3 (patch)
tree9013f2cf270b8f2e6ab20a1e69b066e7b9d7d119 /man
parentdf3eec13973ab22301bdd0bedaadce46343b5109 (diff)
Update man pages to reflect port selection (closes #21 github issue)
Diffstat (limited to 'man')
-rw-r--r--man/mosh-server.17
-rw-r--r--man/mosh.121
2 files changed, 25 insertions, 3 deletions
diff --git a/man/mosh-server.1 b/man/mosh-server.1
index a15dcf0..eba24bf 100644
--- a/man/mosh-server.1
+++ b/man/mosh-server.1
@@ -20,6 +20,7 @@ mosh-server \- server-side helper for mosh
.SH SYNOPSIS
.B mosh-server
[IP address to bind]
+[port number to bind]
.br
.SH DESCRIPTION
\fBmosh-server\fP is a helper program for the
@@ -29,7 +30,11 @@ remote terminal application.
\fBmosh-server\fP binds to a high UDP port and chooses an encryption
key to protect the session. It prints both on standard output,
detaches from the terminal, and waits for the \fBmosh-client\fP to
-establish a connection via UDP.
+establish a connection.
+
+By default, \fBmosh-server\fP binds to a port between 60000 and
+61000. If a port number is supplied on the command line,
+\fBmosh-server\fP will bind to it instead.
\fBmosh-server\fP maintains an entry in the
.BR utmp(5)
diff --git a/man/mosh.1 b/man/mosh.1
index 2a988a7..8c54503 100644
--- a/man/mosh.1
+++ b/man/mosh.1
@@ -57,8 +57,10 @@ round-trip and do not cause lasting effect.
\fBmosh\fP does not support X forwarding or the non-interactive uses
of SSH, including port forwarding or sshfs. \fBmosh\fP works through
-typical client-side network address translators but requires high-port
-UDP to pass between client and server.
+typical client-side network address translators but requires UDP to
+pass between client and server. By default, \fBmosh\fP uses the ports
+between 60000 and 61000, but allows the user to request a particular
+UDP port instead.
.SH OPTIONS
.TP
@@ -86,6 +88,21 @@ confident. This generally means a previous prediction on the same row
of the terminal has been confirmed by the server, without any
intervening control character keystrokes.
+.TP
+.B \-a
+Synonym for \-\-predict=always
+
+.TP
+.B \-n
+Synonym for \-\-predict=never
+
+.TP
+.B \-p \fINUM\fP, \-\-port=\fINUM\fP
+Use a particular server-side UDP port, for example, if this is the
+only port that is forwarded through a firewall to the
+server. Otherwise, \fBmosh\fP will choose a port between 60000 and
+61000.
+
.SH SEE ALSO
.BR mosh-client (1),
.BR mosh-server (1).