2021-09-14 08:26:46 +00:00
|
|
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.5.
|
2021-09-14 13:34:08 +00:00
|
|
|
.TH INNERNET "8" "September 2021" "innernet 1.5.0-beta.3" "System Administration Utilities"
|
2021-04-09 13:47:33 +00:00
|
|
|
.SH NAME
|
2021-09-14 13:34:08 +00:00
|
|
|
innernet \- manual page for innernet 1.5.0-beta.3
|
2021-04-09 13:47:33 +00:00
|
|
|
.SH DESCRIPTION
|
2021-09-14 13:34:08 +00:00
|
|
|
innernet 1.5.0\-beta.3
|
2021-04-09 13:47:33 +00:00
|
|
|
A client to manage innernet network interfaces.
|
|
|
|
|
.SS "USAGE:"
|
|
|
|
|
.IP
|
2021-05-31 15:23:14 +00:00
|
|
|
innernet [OPTIONS] [SUBCOMMAND]
|
|
|
|
|
.SS "OPTIONS:"
|
2021-04-20 16:13:44 +00:00
|
|
|
.HP
|
2021-05-31 15:23:14 +00:00
|
|
|
\fB\-v\fR, \fB\-\-verbose\fR
|
2021-04-20 16:13:44 +00:00
|
|
|
.IP
|
2021-05-31 15:23:14 +00:00
|
|
|
Verbose output, use \fB\-vv\fR for even higher verbositude
|
2021-04-20 16:13:44 +00:00
|
|
|
.HP
|
2021-05-19 07:59:27 +00:00
|
|
|
\fB\-\-no\-routing\fR
|
|
|
|
|
.IP
|
|
|
|
|
Whether the routing should be done by innernet or is done by an external tool like e.g. babeld
|
|
|
|
|
.HP
|
2021-05-31 15:23:14 +00:00
|
|
|
\fB\-\-backend\fR <backend>
|
2021-04-20 16:13:44 +00:00
|
|
|
.IP
|
2021-05-31 15:23:14 +00:00
|
|
|
Specify a WireGuard backend to use. If not set, innernet will auto\-select based on availability [default:
|
2021-09-14 08:59:48 +00:00
|
|
|
userspace] [possible values: userspace]
|
2021-05-19 18:44:45 +00:00
|
|
|
.HP
|
2021-06-14 14:53:02 +00:00
|
|
|
\fB\-\-mtu\fR <mtu>
|
|
|
|
|
.IP
|
|
|
|
|
Specify the desired MTU for your interface (default: 1420 for IPv4 and 1400 for IPv6)
|
|
|
|
|
.HP
|
2021-05-31 15:23:14 +00:00
|
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
|
|
|
.IP
|
|
|
|
|
Prints help information
|
2021-05-19 07:59:27 +00:00
|
|
|
.HP
|
2021-05-31 15:23:14 +00:00
|
|
|
\fB\-V\fR, \fB\-\-version\fR
|
2021-05-19 07:59:27 +00:00
|
|
|
.IP
|
2021-05-31 15:23:14 +00:00
|
|
|
Prints version information
|
2021-04-09 13:47:33 +00:00
|
|
|
.SS "SUBCOMMANDS:"
|
|
|
|
|
.TP
|
2021-05-31 15:23:14 +00:00
|
|
|
install
|
|
|
|
|
Install a new innernet config
|
2021-04-09 13:47:33 +00:00
|
|
|
.TP
|
2021-05-31 15:23:14 +00:00
|
|
|
show
|
|
|
|
|
Enumerate all innernet connections
|
|
|
|
|
.TP
|
|
|
|
|
up
|
|
|
|
|
Bring up your local interface, and update it with latest peer list
|
|
|
|
|
.TP
|
|
|
|
|
fetch
|
|
|
|
|
Fetch and update your local interface with the latest peer list
|
|
|
|
|
.TP
|
|
|
|
|
uninstall
|
|
|
|
|
Uninstall an innernet network
|
|
|
|
|
.TP
|
|
|
|
|
down
|
|
|
|
|
Bring down the interface (equivalent to "wg\-quick down <interface>")
|
2021-04-09 13:47:33 +00:00
|
|
|
.TP
|
|
|
|
|
add\-peer
|
|
|
|
|
Add a new peer
|
|
|
|
|
.TP
|
2021-05-31 15:23:14 +00:00
|
|
|
rename\-peer
|
|
|
|
|
Rename a peer
|
|
|
|
|
.TP
|
|
|
|
|
add\-cidr
|
|
|
|
|
Add a new CIDR
|
2021-04-09 13:47:33 +00:00
|
|
|
.TP
|
2021-05-21 05:46:30 +00:00
|
|
|
delete\-cidr
|
|
|
|
|
Delete a CIDR
|
|
|
|
|
.TP
|
2021-06-14 14:53:02 +00:00
|
|
|
list\-cidrs
|
|
|
|
|
List CIDRs
|
|
|
|
|
.TP
|
2021-04-09 13:47:33 +00:00
|
|
|
disable\-peer
|
|
|
|
|
Disable an enabled peer
|
|
|
|
|
.TP
|
|
|
|
|
enable\-peer
|
|
|
|
|
Enable a disabled peer
|
|
|
|
|
.TP
|
2021-05-31 15:23:14 +00:00
|
|
|
add\-association
|
|
|
|
|
Add an association between CIDRs
|
2021-04-09 13:47:33 +00:00
|
|
|
.TP
|
2021-05-31 15:23:14 +00:00
|
|
|
delete\-association
|
|
|
|
|
Delete an association between CIDRs
|
2021-04-09 13:47:33 +00:00
|
|
|
.TP
|
|
|
|
|
list\-associations
|
|
|
|
|
List existing assocations between CIDRs
|
|
|
|
|
.TP
|
|
|
|
|
set\-listen\-port
|
|
|
|
|
Set the local listen port
|
|
|
|
|
.TP
|
2021-05-31 15:23:14 +00:00
|
|
|
override\-endpoint
|
|
|
|
|
Override your external endpoint that the server sends to other peers
|
2021-04-09 13:47:33 +00:00
|
|
|
.TP
|
2021-05-31 15:23:14 +00:00
|
|
|
completions
|
|
|
|
|
Generate shell completion scripts
|
2021-04-09 13:47:33 +00:00
|
|
|
.TP
|
2021-05-31 15:23:14 +00:00
|
|
|
help
|
|
|
|
|
Prints this message or the help of the given subcommand(s)
|
