innernet/doc/innernet.8

81 lines
1.7 KiB
Groff
Raw Normal View History

2021-04-09 13:47:33 +00:00
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.3.
2021-05-19 18:44:45 +00:00
.TH INNERNET "8" "May 2021" "innernet 1.3.0-beta.6" "System Administration Utilities"
2021-04-09 13:47:33 +00:00
.SH NAME
2021-05-19 18:44:45 +00:00
innernet \- manual page for innernet 1.3.0-beta.6
2021-04-09 13:47:33 +00:00
.SH DESCRIPTION
2021-05-19 18:44:45 +00:00
innernet 1.3.0\-beta.6
2021-04-09 13:47:33 +00:00
A client to manage innernet network interfaces.
.SS "USAGE:"
.IP
2021-05-19 07:59:27 +00:00
innernet [FLAGS] [OPTIONS] [SUBCOMMAND]
2021-04-09 13:47:33 +00:00
.SS "FLAGS:"
2021-04-20 16:13:44 +00:00
.HP
2021-04-09 13:47:33 +00:00
\fB\-h\fR, \fB\-\-help\fR
2021-04-20 16:13:44 +00:00
.IP
2021-04-09 13:47:33 +00:00
Prints help information
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-04-09 13:47:33 +00:00
\fB\-V\fR, \fB\-\-version\fR
2021-04-20 16:13:44 +00:00
.IP
2021-04-09 13:47:33 +00:00
Prints version information
2021-05-19 18:44:45 +00:00
.HP
\fB\-v\fR
2021-05-19 07:59:27 +00:00
.SS "OPTIONS:"
.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]
2021-04-09 13:47:33 +00:00
.SS "SUBCOMMANDS:"
.TP
add\-association
Add an association between CIDRs
.TP
add\-cidr
Add a new CIDR
.TP
add\-peer
Add a new peer
.TP
delete\-association
Delete an association between CIDRs
.TP
disable\-peer
Disable an enabled peer
.TP
down
2021-05-19 07:59:27 +00:00
Bring down the interface (equivalent to "wg\-quick down <interface>")
2021-04-09 13:47:33 +00:00
.TP
enable\-peer
Enable a disabled peer
.TP
fetch
Fetch and update your local interface with the latest peer list
.TP
help
Prints this message or the help of the given subcommand(s)
.TP
install
Install a new innernet config
.TP
list\-associations
List existing assocations between CIDRs
.TP
override\-endpoint
Override your external endpoint that the server sends to other peers
.TP
set\-listen\-port
Set the local listen port
.TP
show
Enumerate all innernet connections
.TP
uninstall
Uninstall an innernet network
.TP
up
Bring up your local interface, and update it with latest peer list