Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@owenthereal
owenthereal committed May 11, 2020
1 parent 5201eef commit 505f9bc
Show file tree
Hide file tree
Showing 18 changed files with 38 additions and 24 deletions.
2 changes: 1 addition & 1 deletion docs/upterm.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ Upterm is an open-source solution for sharing terminal sessions instantly with t
* [upterm session](upterm_session.md) - Display session
* [upterm version](upterm_version.md) - Show version

###### Auto generated by spf13/cobra on 22-Mar-2020
###### Auto generated by spf13/cobra on 10-May-2020
6 changes: 5 additions & 1 deletion docs/upterm_host.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ upterm host [flags]
# client's input/output attaching to the host's
upterm host
# Host a terminal session that only allows specified public key(s) to connect
$ upterm host --authorized-key PATH_TO_PUBLIC_KEY
# Host a session with a custom command.
upterm host -- docker run --rm -ti ubuntu bash
Expand All @@ -36,11 +39,12 @@ upterm host [flags]
-f, --force-command string force execution of a command and attach its input/output to client's.
-h, --help help for host
-i, --private-key strings private key for public key authentication against the upterm server (required).
-r, --read-only host a read-only session. Clients won't be able to interact.
--server string upterm server address (required), supported protocols are shh, ws, or wss. (default "ssh://uptermd.upterm.dev:22")
```

### SEE ALSO

* [upterm](upterm.md) - Secure Terminal Sharing

###### Auto generated by spf13/cobra on 22-Mar-2020
###### Auto generated by spf13/cobra on 10-May-2020
2 changes: 1 addition & 1 deletion docs/upterm_proxy.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ upterm proxy [flags]

* [upterm](upterm.md) - Secure Terminal Sharing

###### Auto generated by spf13/cobra on 22-Mar-2020
###### Auto generated by spf13/cobra on 10-May-2020
2 changes: 1 addition & 1 deletion docs/upterm_session.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Display session
* [upterm session info](upterm_session_info.md) - Display session by name
* [upterm session list](upterm_session_list.md) - List shared sessions

###### Auto generated by spf13/cobra on 22-Mar-2020
###### Auto generated by spf13/cobra on 10-May-2020
2 changes: 1 addition & 1 deletion docs/upterm_session_current.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ upterm session current [flags]

* [upterm session](upterm_session.md) - Display session

###### Auto generated by spf13/cobra on 22-Mar-2020
###### Auto generated by spf13/cobra on 10-May-2020
2 changes: 1 addition & 1 deletion docs/upterm_session_info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ upterm session info [flags]

* [upterm session](upterm_session.md) - Display session

###### Auto generated by spf13/cobra on 22-Mar-2020
###### Auto generated by spf13/cobra on 10-May-2020
2 changes: 1 addition & 1 deletion docs/upterm_session_list.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ upterm session list [flags]

* [upterm session](upterm_session.md) - Display session

###### Auto generated by spf13/cobra on 22-Mar-2020
###### Auto generated by spf13/cobra on 10-May-2020
2 changes: 1 addition & 1 deletion docs/upterm_version.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ upterm version [flags]

* [upterm](upterm.md) - Secure Terminal Sharing

###### Auto generated by spf13/cobra on 22-Mar-2020
###### Auto generated by spf13/cobra on 10-May-2020
2 changes: 2 additions & 0 deletions etc/completion/upterm.bash_completion.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,8 @@ _upterm_host()
flags+=("--private-key=")
two_word_flags+=("--private-key")
two_word_flags+=("-i")
flags+=("--read-only")
flags+=("-r")
flags+=("--server=")
two_word_flags+=("--server")

Expand Down
1 change: 1 addition & 0 deletions etc/completion/upterm.zsh_completion
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ function _upterm_host {
'(-f --force-command)'{-f,--force-command}'[force execution of a command and attach its input/output to client'\''s.]:' \
'(-h --help)'{-h,--help}'[help for host]' \
'(*-i *--private-key)'{\*-i,\*--private-key}'[private key for public key authentication against the upterm server (required).]:' \
'(-r --read-only)'{-r,--read-only}'[host a read-only session. Clients won'\''t be able to interact.]' \
'--server[upterm server address (required), supported protocols are shh, ws, or wss.]:'
}

Expand Down
11 changes: 9 additions & 2 deletions etc/man/man1/upterm-host.1
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "UPTERM" "1" "Mar 2020" "Upterm 0.1.3" "Upterm Manual"
.TH "UPTERM" "1" "May 2020" "Upterm 0.1.3" "Upterm Manual"
.nh
.ad l

Expand Down Expand Up @@ -35,6 +35,10 @@ Host a terminal session via a reverse SSH tunnel to the upterm server. By defaul
\fB\-i\fP, \fB\-\-private\-key\fP=[]
private key for public key authentication against the upterm server (required).

.PP
\fB\-r\fP, \fB\-\-read\-only\fP[=false]
host a read\-only session. Clients won't be able to interact.

.PP
\fB\-\-server\fP="ssh://uptermd.upterm.dev:22"
upterm server address (required), supported protocols are shh, ws, or wss.
Expand All @@ -49,6 +53,9 @@ Host a terminal session via a reverse SSH tunnel to the upterm server. By defaul
# client's input/output attaching to the host's
upterm host

# Host a terminal session that only allows specified public key(s) to connect
$ upterm host \-\-authorized\-key PATH\_TO\_PUBLIC\_KEY

# Host a session with a custom command.
upterm host \-\- docker run \-\-rm \-ti ubuntu bash

Expand All @@ -71,4 +78,4 @@ Host a terminal session via a reverse SSH tunnel to the upterm server. By defaul

.SH HISTORY
.PP
22\-Mar\-2020 Auto generated by spf13/cobra
10\-May\-2020 Auto generated by spf13/cobra
4 changes: 2 additions & 2 deletions etc/man/man1/upterm-proxy.1
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "UPTERM" "1" "Mar 2020" "Upterm 0.1.3" "Upterm Manual"
.TH "UPTERM" "1" "May 2020" "Upterm 0.1.3" "Upterm Manual"
.nh
.ad l

Expand Down Expand Up @@ -46,4 +46,4 @@ Proxy a terminal session over WebSocket. This must be used in conjunction with S

.SH HISTORY
.PP
22\-Mar\-2020 Auto generated by spf13/cobra
10\-May\-2020 Auto generated by spf13/cobra
4 changes: 2 additions & 2 deletions etc/man/man1/upterm-session-current.1
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "UPTERM" "1" "Mar 2020" "Upterm 0.1.3" "Upterm Manual"
.TH "UPTERM" "1" "May 2020" "Upterm 0.1.3" "Upterm Manual"
.nh
.ad l

Expand Down Expand Up @@ -49,4 +49,4 @@ Display the current session. By default, the command fetches the current session

.SH HISTORY
.PP
22\-Mar\-2020 Auto generated by spf13/cobra
10\-May\-2020 Auto generated by spf13/cobra
4 changes: 2 additions & 2 deletions etc/man/man1/upterm-session-info.1
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "UPTERM" "1" "Mar 2020" "Upterm 0.1.3" "Upterm Manual"
.TH "UPTERM" "1" "May 2020" "Upterm 0.1.3" "Upterm Manual"
.nh
.ad l

Expand Down Expand Up @@ -43,4 +43,4 @@ Display session by name.

.SH HISTORY
.PP
22\-Mar\-2020 Auto generated by spf13/cobra
10\-May\-2020 Auto generated by spf13/cobra
4 changes: 2 additions & 2 deletions etc/man/man1/upterm-session-list.1
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "UPTERM" "1" "Mar 2020" "Upterm 0.1.3" "Upterm Manual"
.TH "UPTERM" "1" "May 2020" "Upterm 0.1.3" "Upterm Manual"
.nh
.ad l

Expand Down Expand Up @@ -43,4 +43,4 @@ List shared sessions. Session admin sockets are located in \~/.upterm.

.SH HISTORY
.PP
22\-Mar\-2020 Auto generated by spf13/cobra
10\-May\-2020 Auto generated by spf13/cobra
4 changes: 2 additions & 2 deletions etc/man/man1/upterm-session.1
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "UPTERM" "1" "Mar 2020" "Upterm 0.1.3" "Upterm Manual"
.TH "UPTERM" "1" "May 2020" "Upterm 0.1.3" "Upterm Manual"
.nh
.ad l

Expand Down Expand Up @@ -31,4 +31,4 @@ Display session

.SH HISTORY
.PP
22\-Mar\-2020 Auto generated by spf13/cobra
10\-May\-2020 Auto generated by spf13/cobra
4 changes: 2 additions & 2 deletions etc/man/man1/upterm-version.1
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "UPTERM" "1" "Mar 2020" "Upterm 0.1.3" "Upterm Manual"
.TH "UPTERM" "1" "May 2020" "Upterm 0.1.3" "Upterm Manual"
.nh
.ad l

Expand Down Expand Up @@ -31,4 +31,4 @@ Show version

.SH HISTORY
.PP
22\-Mar\-2020 Auto generated by spf13/cobra
10\-May\-2020 Auto generated by spf13/cobra
4 changes: 2 additions & 2 deletions etc/man/man1/upterm.1
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "UPTERM" "1" "Mar 2020" "Upterm 0.1.3" "Upterm Manual"
.TH "UPTERM" "1" "May 2020" "Upterm 0.1.3" "Upterm Manual"
.nh
.ad l

Expand Down Expand Up @@ -56,4 +56,4 @@ Upterm is an open\-source solution for sharing terminal sessions instantly with

.SH HISTORY
.PP
22\-Mar\-2020 Auto generated by spf13/cobra
10\-May\-2020 Auto generated by spf13/cobra

0 comments on commit 505f9bc

Please sign in to comment.