From 6f69f911491d2ffe920bb24e14cdfee8bb516730 Mon Sep 17 00:00:00 2001 From: hwdsl2 Date: Sun, 4 Aug 2024 21:38:29 -0500 Subject: [PATCH] Update docs --- README-zh.md | 31 +++++++++++++++---------------- README.md | 31 +++++++++++++++---------------- docs/clients-zh.md | 31 +++++++++++++++---------------- docs/clients.md | 31 +++++++++++++++---------------- 4 files changed, 60 insertions(+), 64 deletions(-) diff --git a/README-zh.md b/README-zh.md index 8630f4e..9f68aa7 100644 --- a/README-zh.md +++ b/README-zh.md @@ -121,25 +121,24 @@ Usage: bash wireguard.sh [options] Options: - --addclient [client name] add a new client - --dns1 [DNS server IP] primary DNS server for new client (optional, default: Google Public DNS) - --dns2 [DNS server IP] secondary DNS server for new client (optional) - --listclients list the names of existing clients - --removeclient [client name] remove an existing client - --showclientqr [client name] show QR code for an existing client - --uninstall remove WireGuard and delete all configuration - -y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard - -h, --help show this help message and exit + --addclient [client name] add a new client + --dns1 [DNS server IP] primary DNS server for new client (optional, default: Google Public DNS) + --dns2 [DNS server IP] secondary DNS server for new client (optional) + --listclients list the names of existing clients + --removeclient [client name] remove an existing client + --showclientqr [client name] show QR code for an existing client + --uninstall remove WireGuard and delete all configuration + -y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard + -h, --help show this help message and exit Install options (optional): - --auto auto install WireGuard using default or custom options - --serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN). - If not specified, the server's IPv4 address will be used. - --port [number] port for WireGuard (1-65535, default: 51820) - --clientname [client name] name for the first WireGuard client (default: client) - --dns1 [DNS server IP] primary DNS server for first client (default: Google Public DNS) - --dns2 [DNS server IP] secondary DNS server for first client + --auto auto install WireGuard using default or custom options + --serveraddr [DNS name or IP] server address, must be a fully qualified domain name (FQDN) or an IPv4 address. + --port [number] port for WireGuard (1-65535, default: 51820) + --clientname [client name] name for the first WireGuard client (default: client) + --dns1 [DNS server IP] primary DNS server for first client (default: Google Public DNS) + --dns2 [DNS server IP] secondary DNS server for first client To customize options, you may also run this script without arguments. ``` diff --git a/README.md b/README.md index 9bd17ce..104b319 100644 --- a/README.md +++ b/README.md @@ -121,25 +121,24 @@ Usage: bash wireguard.sh [options] Options: - --addclient [client name] add a new client - --dns1 [DNS server IP] primary DNS server for new client (optional, default: Google Public DNS) - --dns2 [DNS server IP] secondary DNS server for new client (optional) - --listclients list the names of existing clients - --removeclient [client name] remove an existing client - --showclientqr [client name] show QR code for an existing client - --uninstall remove WireGuard and delete all configuration - -y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard - -h, --help show this help message and exit + --addclient [client name] add a new client + --dns1 [DNS server IP] primary DNS server for new client (optional, default: Google Public DNS) + --dns2 [DNS server IP] secondary DNS server for new client (optional) + --listclients list the names of existing clients + --removeclient [client name] remove an existing client + --showclientqr [client name] show QR code for an existing client + --uninstall remove WireGuard and delete all configuration + -y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard + -h, --help show this help message and exit Install options (optional): - --auto auto install WireGuard using default or custom options - --serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN). - If not specified, the server's IPv4 address will be used. - --port [number] port for WireGuard (1-65535, default: 51820) - --clientname [client name] name for the first WireGuard client (default: client) - --dns1 [DNS server IP] primary DNS server for first client (default: Google Public DNS) - --dns2 [DNS server IP] secondary DNS server for first client + --auto auto install WireGuard using default or custom options + --serveraddr [DNS name or IP] server address, must be a fully qualified domain name (FQDN) or an IPv4 address. + --port [number] port for WireGuard (1-65535, default: 51820) + --clientname [client name] name for the first WireGuard client (default: client) + --dns1 [DNS server IP] primary DNS server for first client (default: Google Public DNS) + --dns2 [DNS server IP] secondary DNS server for first client To customize options, you may also run this script without arguments. ``` diff --git a/docs/clients-zh.md b/docs/clients-zh.md index bb0b762..12a1722 100644 --- a/docs/clients-zh.md +++ b/docs/clients-zh.md @@ -20,25 +20,24 @@ Usage: bash wireguard.sh [options] Options: - --addclient [client name] add a new client - --dns1 [DNS server IP] primary DNS server for new client (optional, default: Google Public DNS) - --dns2 [DNS server IP] secondary DNS server for new client (optional) - --listclients list the names of existing clients - --removeclient [client name] remove an existing client - --showclientqr [client name] show QR code for an existing client - --uninstall remove WireGuard and delete all configuration - -y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard - -h, --help show this help message and exit + --addclient [client name] add a new client + --dns1 [DNS server IP] primary DNS server for new client (optional, default: Google Public DNS) + --dns2 [DNS server IP] secondary DNS server for new client (optional) + --listclients list the names of existing clients + --removeclient [client name] remove an existing client + --showclientqr [client name] show QR code for an existing client + --uninstall remove WireGuard and delete all configuration + -y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard + -h, --help show this help message and exit Install options (optional): - --auto auto install WireGuard using default or custom options - --serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN). - If not specified, the server's IPv4 address will be used. - --port [number] port for WireGuard (1-65535, default: 51820) - --clientname [client name] name for the first WireGuard client (default: client) - --dns1 [DNS server IP] primary DNS server for first client (default: Google Public DNS) - --dns2 [DNS server IP] secondary DNS server for first client + --auto auto install WireGuard using default or custom options + --serveraddr [DNS name or IP] server address, must be a fully qualified domain name (FQDN) or an IPv4 address. + --port [number] port for WireGuard (1-65535, default: 51820) + --clientname [client name] name for the first WireGuard client (default: client) + --dns1 [DNS server IP] primary DNS server for first client (default: Google Public DNS) + --dns2 [DNS server IP] secondary DNS server for first client To customize options, you may also run this script without arguments. ``` diff --git a/docs/clients.md b/docs/clients.md index 2f4d026..56f1c9c 100644 --- a/docs/clients.md +++ b/docs/clients.md @@ -20,25 +20,24 @@ Usage: bash wireguard.sh [options] Options: - --addclient [client name] add a new client - --dns1 [DNS server IP] primary DNS server for new client (optional, default: Google Public DNS) - --dns2 [DNS server IP] secondary DNS server for new client (optional) - --listclients list the names of existing clients - --removeclient [client name] remove an existing client - --showclientqr [client name] show QR code for an existing client - --uninstall remove WireGuard and delete all configuration - -y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard - -h, --help show this help message and exit + --addclient [client name] add a new client + --dns1 [DNS server IP] primary DNS server for new client (optional, default: Google Public DNS) + --dns2 [DNS server IP] secondary DNS server for new client (optional) + --listclients list the names of existing clients + --removeclient [client name] remove an existing client + --showclientqr [client name] show QR code for an existing client + --uninstall remove WireGuard and delete all configuration + -y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard + -h, --help show this help message and exit Install options (optional): - --auto auto install WireGuard using default or custom options - --serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN). - If not specified, the server's IPv4 address will be used. - --port [number] port for WireGuard (1-65535, default: 51820) - --clientname [client name] name for the first WireGuard client (default: client) - --dns1 [DNS server IP] primary DNS server for first client (default: Google Public DNS) - --dns2 [DNS server IP] secondary DNS server for first client + --auto auto install WireGuard using default or custom options + --serveraddr [DNS name or IP] server address, must be a fully qualified domain name (FQDN) or an IPv4 address. + --port [number] port for WireGuard (1-65535, default: 51820) + --clientname [client name] name for the first WireGuard client (default: client) + --dns1 [DNS server IP] primary DNS server for first client (default: Google Public DNS) + --dns2 [DNS server IP] secondary DNS server for first client To customize options, you may also run this script without arguments. ```