From patchwork Sun Aug 16 09:06:39 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Selva Nair X-Patchwork-Id: 1394 Return-Path: Delivered-To: patchwork@openvpn.net Delivered-To: patchwork@openvpn.net Received: from director8.mail.ord1d.rsapps.net ([172.28.255.1]) by backend30.mail.ord1d.rsapps.net with LMTP id UKngDAWEOV8JXQAAIUCqbw for ; Sun, 16 Aug 2020 15:07:49 -0400 Received: from proxy3.mail.ord1c.rsapps.net ([172.28.255.1]) by director8.mail.ord1d.rsapps.net with LMTP id 0PW0DAWEOV8vaAAAfY0hYg (envelope-from ) for ; Sun, 16 Aug 2020 15:07:49 -0400 Received: from smtp19.gate.ord1c ([172.28.255.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) by proxy3.mail.ord1c.rsapps.net with LMTP id AB4wDAWEOV/sBgAANIxBXg ; Sun, 16 Aug 2020 15:07:49 -0400 X-Spam-Threshold: 95 X-Spam-Score: 0 X-Spam-Flag: NO X-Virus-Scanned: OK X-Orig-To: openvpnslackdevel@openvpn.net X-Originating-Ip: [216.105.38.7] Authentication-Results: smtp19.gate.ord1c.rsapps.net; iprev=pass policy.iprev="216.105.38.7"; spf=pass smtp.mailfrom="openvpn-devel-bounces@lists.sourceforge.net" smtp.helo="lists.sourceforge.net"; dkim=fail (signature verification failed) header.d=sourceforge.net; dkim=fail (signature verification failed) header.d=sf.net; dkim=fail (signature verification failed) header.d=gmail.com; dmarc=fail (p=none; dis=none) header.from=gmail.com X-Suspicious-Flag: YES X-Classification-ID: c61549b6-dff3-11ea-a65b-bc305bf036e4-1-1 Received: from [216.105.38.7] ([216.105.38.7:57820] helo=lists.sourceforge.net) by smtp19.gate.ord1c.rsapps.net (envelope-from ) (ecelerity 4.2.38.62370 r(:)) with ESMTPS (cipher=DHE-RSA-AES256-GCM-SHA384) id EC/7D-02135-404893F5; Sun, 16 Aug 2020 15:07:48 -0400 Received: from [127.0.0.1] (helo=sfs-ml-4.v29.lw.sourceforge.com) by sfs-ml-4.v29.lw.sourceforge.com with esmtp (Exim 4.90_1) (envelope-from ) id 1k7Nze-0006y9-6u; Sun, 16 Aug 2020 19:06:58 +0000 Received: from [172.30.20.202] (helo=mx.sourceforge.net) by sfs-ml-4.v29.lw.sourceforge.com with esmtps (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.90_1) (envelope-from ) id 1k7Nzd-0006y2-6S for openvpn-devel@lists.sourceforge.net; Sun, 16 Aug 2020 19:06:57 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sourceforge.net; s=x; h=References:In-Reply-To:Message-Id:Date:Subject:Cc: To:From:Sender:Reply-To:MIME-Version:Content-Type:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=FFTSorwtfGCYngjeZ7JaPkKXqJrbHiMfzlIyoOO+Ia8=; b=POva3t6xHcl3eyhaK+ibJLLVxX HLeF7gIIJCxA1ZhRViN80dLsTtlNePEXgtbo1jEUZduIQJ+9Kn+vuEcJRwxESVQczGRcmkLBEY0ao 8xSIMLjRixVR3RvfN7v08NXaJSs9K3ZsaTVG3W9awF8tMHVw5Z173U8b3fgp/c1zu5RE=; DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sf.net; s=x ; h=References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To :MIME-Version:Content-Type:Content-Transfer-Encoding:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=FFTSorwtfGCYngjeZ7JaPkKXqJrbHiMfzlIyoOO+Ia8=; b=AddwzbgVHma4IKEPYNjGVnIh+v mdrKstTLMc3Gf+TyhXOJ5MN4geMRB+zBVNn0g8lFKz2Y+yZ180hZUy0OxmsmbE0nMMQdrlMRoyrl7 WcrLnZLilujrYYOFERkTzXnox2YIb09HYjEdguQ3ZUFMWiQaY0ytDJTqz4Ay5H89GKdA=; Received: from mail-qk1-f176.google.com ([209.85.222.176]) by sfi-mx-1.v28.lw.sourceforge.com with esmtps (TLSv1.2:ECDHE-RSA-AES128-GCM-SHA256:128) (Exim 4.92.2) id 1k7Nzb-009UCY-TQ for openvpn-devel@lists.sourceforge.net; Sun, 16 Aug 2020 19:06:57 +0000 Received: by mail-qk1-f176.google.com with SMTP id x69so13197091qkb.1 for ; Sun, 16 Aug 2020 12:06:55 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=FFTSorwtfGCYngjeZ7JaPkKXqJrbHiMfzlIyoOO+Ia8=; b=hWqzo5dI4vE3vmx3mg13bKq/hXsibdx/86GAlQ/otXywhiQtdNHdc2FjDBoFr/Enfv DDoqLGHNrC+DngYCGBL7yMJdwL+MgY+3KKPrapMPPppdmKzSaPiqYDCUPNerqXyNwCI+ Nu93dzHs+BmKt8PEegN7dvk7EJcDuWwE/fF82PPhWV6HpsOIsn3meJGX8GOvDMwfuX0Z cLIUlZV/qlmK+2tPZCY8FAcVnV8mU80FiZRu2qDzpvOV8o08t0rsIQIOe4CaBqxgVoLZ cyNme+TEqhN3O4OvmByAJ/OKHaux24wjtegU6ehYY26gyJ72F41luP4p1o502WMwm77Y Iy3Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=FFTSorwtfGCYngjeZ7JaPkKXqJrbHiMfzlIyoOO+Ia8=; b=L2LddFwI5quEcy18uJ2OMnYl4kAoGwIc4om7wb6WCCDoEVdJnv34CcxnGwOD5ewMPv hat20DkfJB3hL+3Je4g/8x23WVlciz2zDVhEtaR+SkZNeHMG90PVNE96xqIVrbyaJw5m rP1YgIJpH0ikfvOXSTyJ8IlfSEpu2yHV48OzA960TDwz7Hx+Rg1ekNQkiCvmeF37CpWc i71RK2QLw/voaWXlhyekUSWC9/bi2ac+640ZI7l/6rBcgRcaAEJ/gKw02d+OerBlZ/7u jwbmPKfKT8OfEc8/tiJHhjFP5fyMdPa4iP50Z9kdzvhkU9cmbGvj7ZX7mIuy4Lplldkx pekA== X-Gm-Message-State: AOAM533mH4IeOyRp0ttTDawLkaWN1KpgGZJvOkKLS64O3+GeBwNYUZ8Q qp4nlIChKlVhjrl6gfh8YtmHo+g9ZXI= X-Google-Smtp-Source: ABdhPJyaTbJu2g/F4icXo0k3+NMQwMOdAcD2QHqVEsj466Mhti38NA9ZOdpvs+KDSWpr637dptcr8w== X-Received: by 2002:a05:620a:20ca:: with SMTP id f10mr10087475qka.0.1597604809878; Sun, 16 Aug 2020 12:06:49 -0700 (PDT) Received: from saturn.home.sansel.ca (CPE40167ea0e1c2-CM788df74daaa0.cpe.net.cable.rogers.com. [99.228.34.11]) by smtp.gmail.com with ESMTPSA id t8sm15265584qke.7.2020.08.16.12.06.48 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Sun, 16 Aug 2020 12:06:49 -0700 (PDT) From: selva.nair@gmail.com To: openvpn-devel@lists.sourceforge.net Date: Sun, 16 Aug 2020 15:06:39 -0400 Message-Id: <1597604799-23135-1-git-send-email-selva.nair@gmail.com> X-Mailer: git-send-email 2.1.4 In-Reply-To: <1552943809-6367-1-git-send-email-selva.nair@gmail.com> References: <1552943809-6367-1-git-send-email-selva.nair@gmail.com> X-Spam-Report: Spam Filtering performed by mx.sourceforge.net. See http://spamassassin.org/tag/ for more details. 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail provider (selva.nair[at]gmail.com) -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at https://www.dnswl.org/, no trust [209.85.222.176 listed in list.dnswl.org] -0.0 RCVD_IN_MSPIKE_H2 RBL: Average reputation (+2) [209.85.222.176 listed in wl.mailspike.net] 0.0 URIBL_BLOCKED ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [URIs: utoronto.ca] -0.0 SPF_PASS SPF: sender matches SPF record 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid X-Headers-End: 1k7Nzb-009UCY-TQ Subject: [Openvpn-devel] [PATCH v2] Improve the documentation for --dhcp-option X-BeenThere: openvpn-devel@lists.sourceforge.net X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Selva Nair MIME-Version: 1.0 Errors-To: openvpn-devel-bounces@lists.sourceforge.net X-getmail-retrieved-from-mailbox: Inbox From: Selva Nair - Stress that these are handled internally only on some platforms - Correct the statement about wintun - Document DOMAIN-SEARCH Signed-off-by: Selva Nair Acked-by: Gert Doering --- v2: Rebase to master and reword to match the new rst version Add doc for DOMAIN-SEARCH doc/man-sections/vpn-network-options.rst | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/doc/man-sections/vpn-network-options.rst b/doc/man-sections/vpn-network-options.rst index 7100c1ae..825dd1ca 100644 --- a/doc/man-sections/vpn-network-options.rst +++ b/doc/man-sections/vpn-network-options.rst @@ -93,12 +93,18 @@ routing. or :code:`tap`. --dhcp-option args - Set additional network settings via DHCP. On Windows, this is parsed by - the ``tap-windows6`` or ``wintun`` driver. On other platforms these - options can be picked up by an ``--up`` script or plug-in if it has been - pushed by the OpenVPN server. The option will then be saved in the - client's environment before the ``--up`` script is called, under the name - :code:`foreign_option_{n}`. + Set additional network parameters on supported platforms. May be specified + on the client or pushed from the server. On Windows these options are + handled by the ``tap-windows6`` driver by default or directly by OpenVPN + if dhcp is disabled or the ``wintun`` driver is in use. The + ``OpenVPN for Android`` client also handles them internally. + + On all other platforms these options are only saved in the client's + environment under the name :code:`foreign_options_{n}` before the + ``--up`` script is called. A plugin or an ``--up`` script must be used to + pick up and interpret these as required. Many Linux distributions include + such scripts and some third-party user interfaces such as tunnelblick also + come with scripts that process these options. Valid syntax: :: @@ -108,6 +114,11 @@ routing. :code:`DOMAIN` ``name`` Set Connection-specific DNS Suffix to :code:`name`. + :code:`DOMAIN-SEARCH` ``name`` + Add :code:`name` to the domain search list. + Repeat this option to add more entries. Up to + 10 domains are supported. + :code:`DNS` ``address`` Set primary domain name server IPv4 or IPv6 address. Repeat this option to set secondary DNS server addresses.