From nobody Mon Jan 17 15:32:17 2022 X-Original-To: dev-commits-doc-all@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 EBA1D196D51E for ; Mon, 17 Jan 2022 15:32:17 +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 4JcwrK6MHKz4cRW; Mon, 17 Jan 2022 15:32:17 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1642433537; 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=Jt87lUECceosZMP3uXeC4FQqW+c9RmVBA952t2JcQ4k=; b=hVI1n4wVagOf364/AkofidRFUVTSF8up/O9Mhm3q+C+ykCzn3lb7HvUddrxQ6tjU8Imc+J 0gSxFFAHzoClDBka8XVFPxXkX6ydCwpleE7TF9A/aJLhWHDXUCK2eL2e+gKiCfPDFodsYa n7us1vY8UdByNL6lK0+NKpscyztTq5rZmE2BI952jeoCcWfFeJTRgJUDjiU5pA/J3eVaF9 kWTY916L796aq+0goBCSutvwnc6mEhapth4IOze6IUnVJdF3ORUalqn5HmXMUHgdtBANTJ JvWB16W7z6GiJ+iW5lOAIVk9tyJoarFtciXvacI2TMncBmfE3YqwpNokRNNzXg== 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 BA55E1073F; Mon, 17 Jan 2022 15:32:17 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 20HFWHqg050934; Mon, 17 Jan 2022 15:32:17 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 20HFWHxZ050933; Mon, 17 Jan 2022 15:32:17 GMT (envelope-from git) Date: Mon, 17 Jan 2022 15:32:17 GMT Message-Id: <202201171532.20HFWHxZ050933@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Edward Tomasz Napierala Subject: git: e4831417a6 - main - handbook: Fix local documentation instructions List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: trasz X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: e4831417a67a4c94fbcb438fc37634025fa4bb1d Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1642433537; 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=Jt87lUECceosZMP3uXeC4FQqW+c9RmVBA952t2JcQ4k=; b=CsrLrBjONW7nHHcpSH2sWu8LTdKYaE5TFMNMBZ7fyJ+L0PAQbY9hoAVGoMWsQZNqs0usdU hPo49mY5Tp/UqBkYpWn6basXEyWIIHYWQ8RQEOi46NLBJh51uhkK73TCk7gTicXZjeyBrb WmyV8LT5XicC2WZOywmWmU5I21IyUFC8pwoF6/Sg6ZDKlicDuG2PwS4Mno8G+yZa4i29gv V4u6+APFG3kyn2jd2Sb2XfXXaucTGNC/Kl/knRfzg6EUTuBUtlc8XNSedVNejrjufVsaVw EyZKviay56/Y9JFCOs7m5nkR/23EEFb7cHAQdXLkImLJGaQS5MSRE7gS7Bn31A== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1642433537; a=rsa-sha256; cv=none; b=TH8yae3Ght0wRJyjSRNoFle9fEI11miJzef3E3NSyTPPbyBP6rT7fdTHssovZDNsZuYshi 1haonFG7JwiTzxsS1KtyPUEvluiFs7iU6jgcyc1V/xcVjwFbg240G4XIdbh83AFxkTs1eU IVXt59OWCn4z7SmsixN9/4EwQEApLzZQDTBN9vWQZcavloO1AFyARCXfwRtB14viMQihjB p/6Cb/Tyh/0jtgOJGkiL1lMWO9Z0NU/vFAQK5tRT/zdDlb0cyyrpKP/fjKpeaLOhLfIuF0 C6oXdcmkqt/blbCGrX2sJrMICyEX+anozI3WDYKobI8JfNmp9NKF1gfAIuZgJQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by trasz: URL: https://cgit.FreeBSD.org/doc/commit/?id=e4831417a67a4c94fbcb438fc37634025fa4bb1d commit e4831417a67a4c94fbcb438fc37634025fa4bb1d Author: Edward Tomasz Napierala AuthorDate: 2022-01-17 15:31:47 +0000 Commit: Edward Tomasz Napierala CommitDate: 2022-01-17 15:31:51 +0000 handbook: Fix local documentation instructions Previously it referred to a section that doesn't exist and file paths that don't match the actual ones. While here tweak wording. Reviewed By: bcr Sponsored By: EPSRC Differential Revision: https://reviews.freebsd.org/D33916 --- .../content/en/books/handbook/introduction/_index.adoc | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/documentation/content/en/books/handbook/introduction/_index.adoc b/documentation/content/en/books/handbook/introduction/_index.adoc index 587dafd64e..976fb7f174 100644 --- a/documentation/content/en/books/handbook/introduction/_index.adoc +++ b/documentation/content/en/books/handbook/introduction/_index.adoc @@ -271,13 +271,19 @@ More information on packages and ports can be found in crossref:ports[ports,Inst === Additional Documentation All supported FreeBSD versions provide an option in the installer to install additional documentation under [.filename]#/usr/local/share/doc/freebsd# during the initial system setup. -Documentation may also be installed at any later time using packages as described in crossref:cutting-edge[doc-ports-install-package,Updating Documentation from Ports]. -You may view the locally installed manuals with any HTML capable browser using the following URLs: +Documentation may also be installed at any later time using packages: +[source,shell] +.... +# pkg install en-freebsd-doc +.... + +For localized versions replace the "en" with language prefix of choice. +You may view the locally installed manuals with a web browser using the following URLs: The FreeBSD Handbook:: -[.filename]#link:file://localhost/usr/local/share/doc/freebsd/handbook/index.html[/usr/local/share/doc/freebsd/handbook/index.html]# +[.filename]#link:file:///usr/local/share/doc/freebsd/en/books/handbook/book.html[/usr/local/share/doc/freebsd/en/books/handbook/book.html]# The FreeBSD FAQ:: -[.filename]#link:file://localhost/usr/local/share/doc/freebsd/faq/index.html[/usr/local/share/doc/freebsd/faq/index.html]# +[.filename]#link:file://localhost/usr/local/share/doc/freebsd/en/books/faq/book.html[/usr/local/share/doc/freebsd/en/books/faq/book.html]# -You can also view the master (and most frequently updated) copies at https://www.FreeBSD.org/[https://www.FreeBSD.org/]. +You can always find the up to date copy at https://docs.FreeBSD.org/[https://docs.FreeBSD.org/].