From nobody Tue May 21 03:27:40 2024 X-Original-To: dev-commits-src-branches@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4Vk0Hd19x1z5L1xl; Tue, 21 May 2024 03:27:41 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Vk0Hd0Yrmz43K6; Tue, 21 May 2024 03:27:41 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1716262061; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=hKOSXIccseZuPeaJYz6deNvNUtj5u/BXBuhgpdfQsMo=; b=qXNXHMPkY4yGoQz+K8NTkRhPVpc5+8OJ075p1hyW/zAul0ca4y6B1cSlTkUcoi4MbIBW6Q 3yydGxIEn8hsBPH2vDBHGkjOcweqm2gKcELPdLpT76UFM64TDgnWNycEM1IhQGEy5LKMxC v6EEBM6GAJ3Hdl1Xwhh2cHKDGhFDv+ojGD5oralIeh0FjlrymGvWNe+SZqQ6wKoMWk95cx SrwBlPx19eJngs5lsIYRxARcA0bfluK8GNSvkB7+42CEcqHhKZgSp0rSkvR5SjyZvVRg6j 6Xxv4SZY5SzdnCU2n+Xj9Azn+PK5rYyUmkh+ddy6wdYeiWcFNnMCIK1/V+sKIg== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1716262061; a=rsa-sha256; cv=none; b=ydIVLJRMkEpbFVkcsS8SGt3wkbVK86CTV82ermqKfTlut0M0g65/HzxJ11zHG4LEG7XB+U ebAHSAyA8YE0eFBa4KYYq77s9aOTxcfkqF56H7Nw9yJRht9+T55+p4hRNofuUc6SQdFIhq aobMgj2/13dfG5GpVVXEKTkeZP6C5/zQYyZSxGBVhXYiL19jZxTVGqTEvX97viHKk1IfXA HtYbmv8WPB2nUNfujmJf9SInkJ0X9w/gFzxEpj7lnrfaQw4SY9YeE7iT7zXHBU59q7Pbd4 bOPq1nzBnBl/j/jUBtSDLMl20C3rtaGA7rOdU32QDvKHkSvgZTIs9WQsuLFL1A== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1716262061; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=hKOSXIccseZuPeaJYz6deNvNUtj5u/BXBuhgpdfQsMo=; b=Rxt7FK9VrSoa3uZeqxrptMoUmAy6qEAhb3D3hwng7nv6dUHIguzudQgiwckPj6dVnel6OP tV/CLTQ6Pn0AKd/XBkrcX4By8axK9VZSG866e5Np+xUdRImvXpud0clwjyFTJuXtLtqA2s g92VLhxGy/WbutF4R1asoPvuj2D7hWcEqH7SxAxs/2FBA/ePoz6TigYxBik1bpK/q8Ua49 72PVTaPnPBSvQcYzG3FMdpZQUyV/4/Ur/Eiob8wzdizDhJ5noh8BGMLxBOb6n89pFSz1ua +CdHlPGCLvHQo7+HFUQmywfvk++0kaXCY/poY1R2qTkKr26QnRbSdokofECX6w== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4Vk0Hd03t0z14kK; Tue, 21 May 2024 03:27:41 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 44L3Re74052843; Tue, 21 May 2024 03:27:40 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 44L3ReCf052840; Tue, 21 May 2024 03:27:40 GMT (envelope-from git) Date: Tue, 21 May 2024 03:27:40 GMT Message-Id: <202405210327.44L3ReCf052840@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Warner Losh Subject: git: 5dced4143910 - stable/14 - networking.7 : create network quickstart guide List-Id: Commits to the stable branches of the FreeBSD src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-branches List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-branches@freebsd.org Sender: owner-dev-commits-src-branches@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: imp X-Git-Repository: src X-Git-Refname: refs/heads/stable/14 X-Git-Reftype: branch X-Git-Commit: 5dced41439109368a8f3c9a818fe518542d7063e Auto-Submitted: auto-generated The branch stable/14 has been updated by imp: URL: https://cgit.FreeBSD.org/src/commit/?id=5dced41439109368a8f3c9a818fe518542d7063e commit 5dced41439109368a8f3c9a818fe518542d7063e Author: Alexander Ziaee AuthorDate: 2024-04-17 15:51:35 +0000 Commit: Warner Losh CommitDate: 2024-05-21 03:16:16 +0000 networking.7 : create network quickstart guide Now that the handbook has been moved to ports, I think it's very nice to have a network quickstart guide in-band, in base, in the system manual. If the user uses any of the following terms "man -k {network,networking,wifi,quickstart}" this page will come up, which is I think a very common use case for new users. Currently, this document explains connecting to a basic Ethernet network, a basic wifi network, scanning for wifi networks, and airplane mode, as well as linking to other sections, including the handbook Co-authored-by: Graham Perrin Reviewed by: imp, bcr, freebsd@igalic.co Pull Request: https://github.com/freebsd/freebsd-src/pull/833 (cherry picked from commit 75eda0096bf83b9b88996d9903b5d4e504047eba) --- share/man/man7/Makefile | 5 +++ share/man/man7/networking.7 | 101 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 106 insertions(+) diff --git a/share/man/man7/Makefile b/share/man/man7/Makefile index 11246195201c..7f506c1dfc5f 100644 --- a/share/man/man7/Makefile +++ b/share/man/man7/Makefile @@ -47,6 +47,11 @@ MLINKS+= c.7 c11.7 MLINKS+= c.7 c17.7 MLINKS+= c.7 c2x.7 +.if ${MK_INET} != "no" +MAN+= networking.7 +MLINKS+= networking.7 wifi.7 +.endif + .if ${MK_TESTS} != "no" ATF= ${SRCTOP}/contrib/atf .PATH: ${ATF}/doc diff --git a/share/man/man7/networking.7 b/share/man/man7/networking.7 new file mode 100644 index 000000000000..869812c05a9b --- /dev/null +++ b/share/man/man7/networking.7 @@ -0,0 +1,101 @@ +.\"- +.\" SPDX-License-Identifier: BSD-2-Clause +.\" +.\" Copyright (c) 2024 Alexander Ziaee +.\" +.Dd April 17, 2024 +.Dt "NETWORKING" 7 +.Os +.Sh NAME +.Nm networking , +.Nm wifi +.Nd quickstart guide to connecting to a network +.Sh DESCRIPTION +In the following examples, it is assumed that we are connecting to Ethernet +with the first interface found by the +.Xr em 4 +driver, and Wi-Fi with the first interface found by the +.Xr iwn 4 +driver, though your hardware will vary. +.Sh EXAMPLES +.Bl -tag -width 0n +.It Sy Connecting to an Ethernet network with DHCP: +.Bd -literal -offset 2n +.Ic # dhclient em0 +.Ed +.It Sy Connecting to a cellular network with USB tethering: +.Pp +Load the USB tethering driver, +.Xr urndis 4 : +.Bd -literal -offset 2n +.Ic # kldload urndis +.Ed +.Pp +Ask for a DHCP lease on the USB tethering interface: +.Bd -literal -offset 2n +.Ic # dhclient ue0 +.Ed +.It Sy Connecting to a Wi-Fi network: +.Pp +Identify your Wi-Fi hardware: +.Bd -literal -offset 2n +.Ic % sysctl net.wlan.devices +.Ed +.Pp +Configure your Wi-Fi hardware as wlan0 interface: +.Ed +.Bd -literal -offset 2n +.Ic # sysrc wlans_iwn0="wlan0" +.Ed +.Pp +Set that interface to negotiate a DHCP lease with +.Xr wpa_supplicant 8 : +.Bd -literal -offset 2n +.Ic # sysrc ifconfig_wlan0="WPA SYNCDHCP" +.Ed +.Pp +Enter the details of the Wi-Fi network: +.Bd -literal -offset 2n +.Ic # wpa_passphrase \(dqmyssid\(dq \(dqmypassphrase\(dq >> wpa_supplicant.conf +.Ed +.Pp +Restart the network interface daemon: +.Bd -literal -offset 2n +.Ic # service netif restart +.Ed +.Pp +.It Sy Scanning for Wi-Fi networks: +.Bd -literal -offset 2n +.Ic % ifconfig wlan0 scan +.Ed +.It Sy Airplane mode: +.Bd -literal -offset 2n +.Ic # service netif stop +.Ed +.El +.Sh SEE ALSO +.Xr bsdconfig 8 , +.Xr dhclient 8 , +.Xr ifconfig 8 , +.Xr wpa_passphrase 8 +.Pp +The Advanced Networking chapter of the +.Fx +Handbook. +.Sh CAVEATS +Shell Special Characters in the +.Ar SSID +or +.Ar passphrase +will need to be escaped for +.Xr wpa_passphrase 8 , +commonly using +.Ql \e , +see the manual page for your shell for more details. +.Pp +Currently +.Ql Ic service netif restart +does not restart routing. +A common workaround is to issue +.Ql Ic service netif restart && service routing restart +instead.