This repository has been archived by the owner on Aug 17, 2022. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Include manpages courtesy coderobe #53
- Loading branch information
1 parent
a635ad3
commit 225381b
Showing
12 changed files
with
610 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| .TH "oxy-client" 1 "Tue Jun 26 11:24:24 UTC 2018" "version 2.0.2" | ||
| .SH NAME | ||
| oxy-client | ||
| .SH SYNOPSIS | ||
| oxy client [-DYXChimpVv] <destination> <command> | ||
| .SH DESCRIPTION | ||
| Connect to an Oxy server. | ||
| .PP | ||
| .B -L <local port forward>... | ||
| .RS | ||
| Create a local portforward | ||
| .RE | ||
|
|
||
| .B -R <remote port forward>... | ||
| .RS | ||
| Create a remote portforward | ||
| .RE | ||
|
|
||
| .B -D, --socks <socks>... | ||
| .RS | ||
| Bind a local port as a SOCKS5 proxy | ||
| .RE | ||
|
|
||
| .B -Y, --trusted-x-forwarding | ||
| .RS | ||
| Enable trusted X forwarding | ||
| .RE | ||
|
|
||
| .B -X, --x-forwarding | ||
| .RS | ||
| Enable X forwarding | ||
| .RE | ||
|
|
||
| .B --client-config <client config> | ||
| .RS | ||
| Path to client.conf [default: ~/.config/oxy/client.conf] | ||
| .RE | ||
|
|
||
| .B -C, --compress | ||
| .RS | ||
| Enable ZLIB format compression of all transmitted data | ||
| .RE | ||
|
|
||
| .B -h, --help | ||
| .RS | ||
| Prints help information | ||
| .RE | ||
|
|
||
| .B -i, --identity <identity> | ||
| .RS | ||
| Use [identity] as authentication information for connecting to the remote | ||
| .RE | ||
| .RS | ||
| server. [env: OXY_IDENTITY=] | ||
| .RE | ||
|
|
||
| .B -m, --metacommand <metacommand>... | ||
| .RS | ||
| A command to run after the connection is established. The same commands from | ||
| .RE | ||
| .RS | ||
| the F10 prompt. | ||
| .RE | ||
|
|
||
| .B -p, --port <port> | ||
| .RS | ||
| The port used for TCP [default: 2600] | ||
| .RE | ||
|
|
||
| .B --server-config <server config> | ||
| .RS | ||
| Path to server.conf [default: ~/.config/oxy/server.conf] | ||
| .RE | ||
|
|
||
| .B --user <user> | ||
| .RS | ||
| The remote username to log in with. Only applicable for servers using --su | ||
| .RE | ||
|
|
||
| .B -mode | ||
| .B -V, --version | ||
| .RS | ||
| Prints version information | ||
| .RE | ||
|
|
||
| .B -v, --verbose | ||
| .RS | ||
| Increase debugging output | ||
| .RE | ||
|
|
||
| .B --via <via>... | ||
| .RS | ||
| Connect to a different oxy server first, then proxy traffic through the | ||
| .RE | ||
| .RS | ||
| intermediary server. | ||
| .RE | ||
|
|
||
|
|
||
| .SH AUTHOR | ||
| Jenna Magius <pyrosim@gmail.com> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| .TH "oxy-copy" 1 "Tue Jun 26 11:24:24 UTC 2018" "version 2.0.2" | ||
| .SH NAME | ||
| oxy-copy | ||
| .SH SYNOPSIS | ||
| oxy copy [-ChiVv] <location>... | ||
| .SH DESCRIPTION | ||
| Copy files from any number of sources to one destination. | ||
| .PP | ||
| .B --client-config <client config> | ||
| .RS | ||
| Path to client.conf [default: ~/.config/oxy/client.conf] | ||
| .RE | ||
|
|
||
| .B -C, --compress | ||
| .RS | ||
| Enable ZLIB format compression of all transmitted data | ||
| .RE | ||
|
|
||
| .B -h, --help | ||
| .RS | ||
| Prints help information | ||
| .RE | ||
|
|
||
| .B -i, --identity <identity> | ||
| .RS | ||
| Use [identity] as authentication information for connecting to the remote | ||
| .RE | ||
| .RS | ||
| server. [env: OXY_IDENTITY=] | ||
| .RE | ||
|
|
||
| .B --server-config <server config> | ||
| .RS | ||
| Path to server.conf [default: ~/.config/oxy/server.conf] | ||
| .RE | ||
|
|
||
| .B -V, --version | ||
| .RS | ||
| Prints version information | ||
| .RE | ||
|
|
||
| .B -v, --verbose | ||
| .RS | ||
| Increase debugging output | ||
| .RE | ||
|
|
||
|
|
||
| .SH AUTHOR | ||
| Jenna Magius <pyrosim@gmail.com> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| .TH "oxy-guide" 1 "Tue Jun 26 11:24:25 UTC 2018" "version 2.0.2" | ||
| .SH NAME | ||
| oxy-guide | ||
| .SH SYNOPSIS | ||
| oxy guide [-hV] | ||
| .SH DESCRIPTION | ||
| Print information to help a new user get the most out of Oxy. | ||
| .PP | ||
| .B -h, --help | ||
| .RS | ||
| Prints help information | ||
| .RE | ||
|
|
||
| .B -V, --version | ||
| .RS | ||
| Prints version information | ||
| .RE | ||
|
|
||
|
|
||
| .SH AUTHOR | ||
| Jenna Magius <pyrosim@gmail.com> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| .TH "oxy-help" 1 "Tue Jun 26 11:24:25 UTC 2018" "version 2.0.2" | ||
| .SH NAME | ||
| oxy-help | ||
| .SH SYNOPSIS | ||
| oxy help <subcommand>... | ||
| .SH DESCRIPTION | ||
| Prints this message or the help of the given subcommand(s) | ||
| .PP | ||
|
|
||
| .SH AUTHOR | ||
| Jenna Magius <pyrosim@gmail.com> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| .TH "oxy-keygen" 1 "Tue Jun 26 11:24:25 UTC 2018" "version 2.0.2" | ||
| .SH NAME | ||
| oxy-keygen | ||
| .SH SYNOPSIS | ||
| oxy keygen [-hV] | ||
| .SH DESCRIPTION | ||
| Generate keys | ||
| .PP | ||
| .B -h, --help | ||
| .RS | ||
| Prints help information | ||
| .RE | ||
|
|
||
| .B -V, --version | ||
| .RS | ||
| Prints version information | ||
| .RE | ||
|
|
||
|
|
||
| .SH AUTHOR | ||
| Jenna Magius <pyrosim@gmail.com> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| .TH "oxy-reverse-client" 1 "Tue Jun 26 11:24:25 UTC 2018" "version 2.0.2" | ||
| .SH NAME | ||
| oxy-reverse-client | ||
| .SH SYNOPSIS | ||
| oxy reverse-client [-DYXChimpVv] <bind-address> <command> | ||
| .SH DESCRIPTION | ||
| Bind a port and wait for a server to connect. Then, be a client. | ||
| .PP | ||
| .B -L <local port forward>... | ||
| .RS | ||
| Create a local portforward | ||
| .RE | ||
|
|
||
| .B -R <remote port forward>... | ||
| .RS | ||
| Create a remote portforward | ||
| .RE | ||
|
|
||
| .B -D, --socks <socks>... | ||
| .RS | ||
| Bind a local port as a SOCKS5 proxy | ||
| .RE | ||
|
|
||
| .B -Y, --trusted-x-forwarding | ||
| .RS | ||
| Enable trusted X forwarding | ||
| .RE | ||
|
|
||
| .B -X, --x-forwarding | ||
| .RS | ||
| Enable X forwarding | ||
| .RE | ||
|
|
||
| .B --client-config <client config> | ||
| .RS | ||
| Path to client.conf [default: ~/.config/oxy/client.conf] | ||
| .RE | ||
|
|
||
| .B -C, --compress | ||
| .RS | ||
| Enable ZLIB format compression of all transmitted data | ||
| .RE | ||
|
|
||
| .B -h, --help | ||
| .RS | ||
| Prints help information | ||
| .RE | ||
|
|
||
| .B -i, --identity <identity> | ||
| .RS | ||
| Use [identity] as authentication information for connecting to the remote | ||
| .RE | ||
| .RS | ||
| server. [env: OXY_IDENTITY=] | ||
| .RE | ||
|
|
||
| .B -m, --metacommand <metacommand>... | ||
| .RS | ||
| A command to run after the connection is established. The same commands from | ||
| .RE | ||
| .RS | ||
| the F10 prompt. | ||
| .RE | ||
|
|
||
| .B -p, --port <port> | ||
| .RS | ||
| The port used for TCP [default: 2600] | ||
| .RE | ||
|
|
||
| .B --server-config <server config> | ||
| .RS | ||
| Path to server.conf [default: ~/.config/oxy/server.conf] | ||
| .RE | ||
|
|
||
| .B --user <user> | ||
| .RS | ||
| The remote username to log in with. Only applicable for servers using --su | ||
| .RE | ||
|
|
||
| .B -mode | ||
| .B -V, --version | ||
| .RS | ||
| Prints version information | ||
| .RE | ||
|
|
||
| .B -v, --verbose | ||
| .RS | ||
| Increase debugging output | ||
| .RE | ||
|
|
||
| .B --via <via>... | ||
| .RS | ||
| Connect to a different oxy server first, then proxy traffic through the | ||
| .RE | ||
| .RS | ||
| intermediary server. | ||
| .RE | ||
|
|
||
|
|
||
| .SH AUTHOR | ||
| Jenna Magius <pyrosim@gmail.com> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| .TH "oxy-reverse-server" 1 "Tue Jun 26 11:24:25 UTC 2018" "version 2.0.2" | ||
| .SH NAME | ||
| oxy-reverse-server | ||
| .SH SYNOPSIS | ||
| oxy reverse-server [-hipVv] <destination> | ||
| .SH DESCRIPTION | ||
| Connect out to a listening client. Then, be a server. | ||
| .PP | ||
| .B --client-config <client config> | ||
| .RS | ||
| Path to client.conf [default: ~/.config/oxy/client.conf] | ||
| .RE | ||
|
|
||
| .B --forced-command <forced command> | ||
| .RS | ||
| Restrict command execution to the specified command | ||
| .RE | ||
|
|
||
| .B -h, --help | ||
| .RS | ||
| Prints help information | ||
| .RE | ||
|
|
||
| .B -i, --identity <identity> | ||
| .RS | ||
| Use [identity] as authentication information for connecting to the remote | ||
| .RE | ||
| .RS | ||
| server. [env: OXY_IDENTITY=] | ||
| .RE | ||
|
|
||
| .B -p, --port <port> | ||
| .RS | ||
| The port used for TCP [default: 2600] | ||
| .RE | ||
|
|
||
| .B --server-config <server config> | ||
| .RS | ||
| Path to server.conf [default: ~/.config/oxy/server.conf] | ||
| .RE | ||
|
|
||
| .B -V, --version | ||
| .RS | ||
| Prints version information | ||
| .RE | ||
|
|
||
| .B -v, --verbose | ||
| .RS | ||
| Increase debugging output | ||
| .RE | ||
|
|
||
|
|
||
| .SH AUTHOR | ||
| Jenna Magius <pyrosim@gmail.com> |
Oops, something went wrong.