innernet/doc/innernet.8

98 lines
2.0 KiB
Groff

.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.5.
.TH INNERNET "8" "November 2021" "innernet 1.5.1" "System Administration Utilities"
.SH NAME
innernet \- manual page for innernet 1.5.1
.SH DESCRIPTION
innernet 1.5.1
A client to manage innernet network interfaces.
.SS "USAGE:"
.IP
innernet [OPTIONS] [SUBCOMMAND]
.SS "OPTIONS:"
.HP
\fB\-v\fR, \fB\-\-verbose\fR
.IP
Verbose output, use \fB\-vv\fR for even higher verbositude
.HP
\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
\fB\-\-backend\fR <backend>
.IP
Specify a WireGuard backend to use. If not set, innernet will auto\-select based on availability [default:
kernel] [possible values: kernel, userspace]
.HP
\fB\-\-mtu\fR <mtu>
.IP
Specify the desired MTU for your interface (default: 1420 for IPv4 and 1400 for IPv6)
.HP
\fB\-h\fR, \fB\-\-help\fR
.IP
Prints help information
.HP
\fB\-V\fR, \fB\-\-version\fR
.IP
Prints version information
.SS "SUBCOMMANDS:"
.TP
install
Install a new innernet config
.TP
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>')
.TP
add\-peer
Add a new peer
.TP
rename\-peer
Rename a peer
.TP
add\-cidr
Add a new CIDR
.TP
delete\-cidr
Delete a CIDR
.TP
list\-cidrs
List CIDRs
.TP
disable\-peer
Disable an enabled peer
.TP
enable\-peer
Enable a disabled peer
.TP
add\-association
Add an association between CIDRs
.TP
delete\-association
Delete an association between CIDRs
.TP
list\-associations
List existing assocations between CIDRs
.TP
set\-listen\-port
Set the local listen port
.TP
override\-endpoint
Override your external endpoint that the server sends to other peers
.TP
completions
Generate shell completion scripts
.TP
help
Prints this message or the help of the given subcommand(s)