Skip to content

Commit 6f69f91

Browse files
hwdsl2hwdsl2
committed
Update docs
1 parent a73d684 commit 6f69f91

File tree

4 files changed

+60
-64
lines changed

4 files changed

+60
-64
lines changed

‎README-zh.md

+15-16
Original file line numberDiff line numberDiff line change
@@ -121,25 +121,24 @@ Usage: bash wireguard.sh [options]
121121
122122
Options:
123123
124-
--addclient [client name] add a new client
125-
--dns1 [DNS server IP] primary DNS server for new client (optional, default: Google Public DNS)
126-
--dns2 [DNS server IP] secondary DNS server for new client (optional)
127-
--listclients list the names of existing clients
128-
--removeclient [client name] remove an existing client
129-
--showclientqr [client name] show QR code for an existing client
130-
--uninstall remove WireGuard and delete all configuration
131-
-y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard
132-
-h, --help show this help message and exit
124+
--addclient [client name] add a new client
125+
--dns1 [DNS server IP] primary DNS server for new client (optional, default: Google Public DNS)
126+
--dns2 [DNS server IP] secondary DNS server for new client (optional)
127+
--listclients list the names of existing clients
128+
--removeclient [client name] remove an existing client
129+
--showclientqr [client name] show QR code for an existing client
130+
--uninstall remove WireGuard and delete all configuration
131+
-y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard
132+
-h, --help show this help message and exit
133133
134134
Install options (optional):
135135
136-
--auto auto install WireGuard using default or custom options
137-
--serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN).
138-
If not specified, the server's IPv4 address will be used.
139-
--port [number] port for WireGuard (1-65535, default: 51820)
140-
--clientname [client name] name for the first WireGuard client (default: client)
141-
--dns1 [DNS server IP] primary DNS server for first client (default: Google Public DNS)
142-
--dns2 [DNS server IP] secondary DNS server for first client
136+
--auto auto install WireGuard using default or custom options
137+
--serveraddr [DNS name or IP] server address, must be a fully qualified domain name (FQDN) or an IPv4 address.
138+
--port [number] port for WireGuard (1-65535, default: 51820)
139+
--clientname [client name] name for the first WireGuard client (default: client)
140+
--dns1 [DNS server IP] primary DNS server for first client (default: Google Public DNS)
141+
--dns2 [DNS server IP] secondary DNS server for first client
143142
144143
To customize options, you may also run this script without arguments.
145144
```

‎README.md

+15-16
Original file line numberDiff line numberDiff line change
@@ -121,25 +121,24 @@ Usage: bash wireguard.sh [options]
121121
122122
Options:
123123
124-
--addclient [client name] add a new client
125-
--dns1 [DNS server IP] primary DNS server for new client (optional, default: Google Public DNS)
126-
--dns2 [DNS server IP] secondary DNS server for new client (optional)
127-
--listclients list the names of existing clients
128-
--removeclient [client name] remove an existing client
129-
--showclientqr [client name] show QR code for an existing client
130-
--uninstall remove WireGuard and delete all configuration
131-
-y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard
132-
-h, --help show this help message and exit
124+
--addclient [client name] add a new client
125+
--dns1 [DNS server IP] primary DNS server for new client (optional, default: Google Public DNS)
126+
--dns2 [DNS server IP] secondary DNS server for new client (optional)
127+
--listclients list the names of existing clients
128+
--removeclient [client name] remove an existing client
129+
--showclientqr [client name] show QR code for an existing client
130+
--uninstall remove WireGuard and delete all configuration
131+
-y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard
132+
-h, --help show this help message and exit
133133
134134
Install options (optional):
135135
136-
--auto auto install WireGuard using default or custom options
137-
--serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN).
138-
If not specified, the server's IPv4 address will be used.
139-
--port [number] port for WireGuard (1-65535, default: 51820)
140-
--clientname [client name] name for the first WireGuard client (default: client)
141-
--dns1 [DNS server IP] primary DNS server for first client (default: Google Public DNS)
142-
--dns2 [DNS server IP] secondary DNS server for first client
136+
--auto auto install WireGuard using default or custom options
137+
--serveraddr [DNS name or IP] server address, must be a fully qualified domain name (FQDN) or an IPv4 address.
138+
--port [number] port for WireGuard (1-65535, default: 51820)
139+
--clientname [client name] name for the first WireGuard client (default: client)
140+
--dns1 [DNS server IP] primary DNS server for first client (default: Google Public DNS)
141+
--dns2 [DNS server IP] secondary DNS server for first client
143142
144143
To customize options, you may also run this script without arguments.
145144
```

‎docs/clients-zh.md

+15-16
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,24 @@ Usage: bash wireguard.sh [options]
2020
2121
Options:
2222
23-
--addclient [client name] add a new client
24-
--dns1 [DNS server IP] primary DNS server for new client (optional, default: Google Public DNS)
25-
--dns2 [DNS server IP] secondary DNS server for new client (optional)
26-
--listclients list the names of existing clients
27-
--removeclient [client name] remove an existing client
28-
--showclientqr [client name] show QR code for an existing client
29-
--uninstall remove WireGuard and delete all configuration
30-
-y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard
31-
-h, --help show this help message and exit
23+
--addclient [client name] add a new client
24+
--dns1 [DNS server IP] primary DNS server for new client (optional, default: Google Public DNS)
25+
--dns2 [DNS server IP] secondary DNS server for new client (optional)
26+
--listclients list the names of existing clients
27+
--removeclient [client name] remove an existing client
28+
--showclientqr [client name] show QR code for an existing client
29+
--uninstall remove WireGuard and delete all configuration
30+
-y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard
31+
-h, --help show this help message and exit
3232
3333
Install options (optional):
3434
35-
--auto auto install WireGuard using default or custom options
36-
--serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN).
37-
If not specified, the server's IPv4 address will be used.
38-
--port [number] port for WireGuard (1-65535, default: 51820)
39-
--clientname [client name] name for the first WireGuard client (default: client)
40-
--dns1 [DNS server IP] primary DNS server for first client (default: Google Public DNS)
41-
--dns2 [DNS server IP] secondary DNS server for first client
35+
--auto auto install WireGuard using default or custom options
36+
--serveraddr [DNS name or IP] server address, must be a fully qualified domain name (FQDN) or an IPv4 address.
37+
--port [number] port for WireGuard (1-65535, default: 51820)
38+
--clientname [client name] name for the first WireGuard client (default: client)
39+
--dns1 [DNS server IP] primary DNS server for first client (default: Google Public DNS)
40+
--dns2 [DNS server IP] secondary DNS server for first client
4241
4342
To customize options, you may also run this script without arguments.
4443
```

‎docs/clients.md

+15-16
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,24 @@ Usage: bash wireguard.sh [options]
2020
2121
Options:
2222
23-
--addclient [client name] add a new client
24-
--dns1 [DNS server IP] primary DNS server for new client (optional, default: Google Public DNS)
25-
--dns2 [DNS server IP] secondary DNS server for new client (optional)
26-
--listclients list the names of existing clients
27-
--removeclient [client name] remove an existing client
28-
--showclientqr [client name] show QR code for an existing client
29-
--uninstall remove WireGuard and delete all configuration
30-
-y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard
31-
-h, --help show this help message and exit
23+
--addclient [client name] add a new client
24+
--dns1 [DNS server IP] primary DNS server for new client (optional, default: Google Public DNS)
25+
--dns2 [DNS server IP] secondary DNS server for new client (optional)
26+
--listclients list the names of existing clients
27+
--removeclient [client name] remove an existing client
28+
--showclientqr [client name] show QR code for an existing client
29+
--uninstall remove WireGuard and delete all configuration
30+
-y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard
31+
-h, --help show this help message and exit
3232
3333
Install options (optional):
3434
35-
--auto auto install WireGuard using default or custom options
36-
--serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN).
37-
If not specified, the server's IPv4 address will be used.
38-
--port [number] port for WireGuard (1-65535, default: 51820)
39-
--clientname [client name] name for the first WireGuard client (default: client)
40-
--dns1 [DNS server IP] primary DNS server for first client (default: Google Public DNS)
41-
--dns2 [DNS server IP] secondary DNS server for first client
35+
--auto auto install WireGuard using default or custom options
36+
--serveraddr [DNS name or IP] server address, must be a fully qualified domain name (FQDN) or an IPv4 address.
37+
--port [number] port for WireGuard (1-65535, default: 51820)
38+
--clientname [client name] name for the first WireGuard client (default: client)
39+
--dns1 [DNS server IP] primary DNS server for first client (default: Google Public DNS)
40+
--dns2 [DNS server IP] secondary DNS server for first client
4241
4342
To customize options, you may also run this script without arguments.
4443
```

0 commit comments

Comments
 (0)