Update man pages to reflect port selection (closes #21 github issue)

This commit is contained in:
Keith Winstein
2012-03-10 03:48:46 -05:00
parent df3eec1397
commit 0fe911ce20
3 changed files with 33 additions and 9 deletions
+6 -1
View File
@@ -20,6 +20,7 @@ mosh-server \- server-side helper for mosh
.SH SYNOPSIS .SH SYNOPSIS
.B mosh-server .B mosh-server
[IP address to bind] [IP address to bind]
[port number to bind]
.br .br
.SH DESCRIPTION .SH DESCRIPTION
\fBmosh-server\fP is a helper program for the \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 \fBmosh-server\fP binds to a high UDP port and chooses an encryption
key to protect the session. It prints both on standard output, key to protect the session. It prints both on standard output,
detaches from the terminal, and waits for the \fBmosh-client\fP to 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 \fBmosh-server\fP maintains an entry in the
.BR utmp(5) .BR utmp(5)
+19 -2
View File
@@ -57,8 +57,10 @@ round-trip and do not cause lasting effect.
\fBmosh\fP does not support X forwarding or the non-interactive uses \fBmosh\fP does not support X forwarding or the non-interactive uses
of SSH, including port forwarding or sshfs. \fBmosh\fP works through of SSH, including port forwarding or sshfs. \fBmosh\fP works through
typical client-side network address translators but requires high-port typical client-side network address translators but requires UDP to
UDP to pass between client and server. 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 .SH OPTIONS
.TP .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 of the terminal has been confirmed by the server, without any
intervening control character keystrokes. 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 .SH SEE ALSO
.BR mosh-client (1), .BR mosh-client (1),
.BR mosh-server (1). .BR mosh-server (1).
+8 -6
View File
@@ -33,14 +33,16 @@ my $port_request = undef;
my $usage = my $usage =
qq{Usage: $0 [options] [user@]host qq{Usage: $0 [options] [user@]host
--client=PATH mosh client on local machine (default: "mosh-client") --client=PATH mosh client on local machine
--server=PATH mosh server on remote machine (default: "mosh-server") (default: "mosh-client")
--server=PATH mosh server on remote machine
(default: "mosh-server")
--predict=adaptive local echo for slower links [default] --predict=adaptive local echo for slower links [default]
-a --predict=always use local echo even on fast links -a --predict=always use local echo even on fast links
-n --predict=never never use local echo -n --predict=never never use local echo
-p --port=NUM server-side UDP port -p NUM --port=NUM server-side UDP port
Please report bugs to mosh-devel\@mit.edu. Please report bugs to mosh-devel\@mit.edu.
Mosh home page: http://mosh.mit.edu\n}; Mosh home page: http://mosh.mit.edu\n};