From nobody Thu Nov 06 18:46:57 2025 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 4d2WPs4nyYz6FDBB; Thu, 06 Nov 2025 18:46:57 +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 "R12" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4d2WPs4Hshz3mLh; Thu, 06 Nov 2025 18:46:57 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1762454817; 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=iD2Ez+HqoAL+oxv3ka1aPVV05q0bV8UpeuvxgPJsUrg=; b=T6XnH4CHCQsUm70SrjHEjEv7tBH4ADcOw/I7p8BXFVb+yy8uxR8OpahNgGW+j5eBZI6XHA QfsjYLozx2vI9sUCutWjpdKRvTKgQoc7r3GI6bhfh9SFyc802XhQV4zyfMyw/6H6aSJGx9 TMY9CnAARI+dZcc75NR7y60FqOHZkG/oi/95x8CXsedFkzF0JiI2WmdXLJ+HEK+OVXdptF ynn286bHdBejnXrD8ppdv5qY3Ww9ulFIhAuvXFveha5UytNroVefIUlSDl0YXBbzcXRB+O qShX4WPZbLFWIRToRYmiwWT+lRz2g8uOoOfh75bDhNXtN335vkL4+ZHm0mFEWw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1762454817; 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=iD2Ez+HqoAL+oxv3ka1aPVV05q0bV8UpeuvxgPJsUrg=; b=hbFULAZd01K3dZ4nQcWj2BNTNp00B8spC3HOiv5htGGsZmBfpY6UOYsUyS8G+fMx0FTq99 EnMw7cd13OWWRhCF6yTUzjTyiH8MZBfCEq0ZXguSbwmT7Gdh6J+uvzEyhF7xrkqvTp3Kgz qX5nTEZ+KzxjEeNDCO11P7elxlOidVw4Xxeq4FoXjjw0Js4zajw6kCEfB3YWTwrNMOy6+P qrk9rYxzMdGuII2OqWub1VtZGTFQPZt9wmrpbTTAIkXx7HIN6+JNiClpIp8eFmCa7EVcol bzn5Op6ZouwGsU5V6q0jqZcjTVa9qvIxKuC3uvpcD/qShvtY+tdqgGsHpozfSw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1762454817; a=rsa-sha256; cv=none; b=wTC7Hl7ZDhMUMWLRQdEHtWlWvlj23ztPj68wcU3n2VmMNynCbL9hN83oJkhfUXcz+b9UjD qNbEB0k6ifC6NIJOUKsnBL0IxWRWdj8459H1sSDvmERwWJSZYsOezKDKF5SI1DiuJybASG 680SA316wsDE9HIfDl/M4A/btdUFOyF0VZRi1D91Y0Mx/Kb2C52v/uR3KMRq6col0e/aoS bGMBVzHBjHscYs07ReqOHr94jl/cbSIS1HjzUkQgi7UtI6Ol3DtNrZZWWWm1KKYUZAKXnL Rt5hnucL65F7FgUpjtl17DQ/fu6seVw1g2XhI1arxiRzSXojH4THXkLk7Gl1oA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none 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 4d2WPs3pSCz9CH; Thu, 06 Nov 2025 18:46:57 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 5A6IkvFE005389; Thu, 6 Nov 2025 18:46:57 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 5A6IkvcV005386; Thu, 6 Nov 2025 18:46:57 GMT (envelope-from git) Date: Thu, 6 Nov 2025 18:46:57 GMT Message-Id: <202511061846.5A6IkvcV005386@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Alexander Ziaee Subject: git: 920c94b71043 - stable/14 - sysrc.8: Rewrite examples for mdoc conformance 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: ziaee X-Git-Repository: src X-Git-Refname: refs/heads/stable/14 X-Git-Reftype: branch X-Git-Commit: 920c94b71043012c5ebad1b68a7349d5e11eac0d Auto-Submitted: auto-generated The branch stable/14 has been updated by ziaee: URL: https://cgit.FreeBSD.org/src/commit/?id=920c94b71043012c5ebad1b68a7349d5e11eac0d commit 920c94b71043012c5ebad1b68a7349d5e11eac0d Author: Alexander Ziaee AuthorDate: 2025-11-06 18:42:06 +0000 Commit: Alexander Ziaee CommitDate: 2025-11-06 18:46:57 +0000 sysrc.8: Rewrite examples for mdoc conformance Tag SPDX while here. This is not a content change, so do not bump date. PR: 274164 MFC after: 3 seconds (cherry picked from commit 3f0dd7724658126dcfde488a994cf7698353a82c) --- usr.sbin/sysrc/sysrc.8 | 89 +++++++++++++++++++++++--------------------------- 1 file changed, 41 insertions(+), 48 deletions(-) diff --git a/usr.sbin/sysrc/sysrc.8 b/usr.sbin/sysrc/sysrc.8 index bdf3353c2cf9..cb32f72ea587 100644 --- a/usr.sbin/sysrc/sysrc.8 +++ b/usr.sbin/sysrc/sysrc.8 @@ -1,3 +1,6 @@ +.\" +.\" SPDX-License-Identifier: BSD-2-Clause +.\" .\" Copyright (c) 2011-2016 Devin Teske .\" All rights reserved. .\" @@ -408,62 +411,52 @@ and .It Pa /usr/local/etc/rc.conf.d/name/* .El .Sh EXAMPLES -Below are some simple examples of how -.Nm -can be used to query certain values from the -.Xr rc.conf 5 -collection of system configuration files: -.Pp -.Nm -sshd_enable -.Dl returns the value of $sshd_enable, usually YES or NO . +.Ss Working with rc.conf files +Ask the value of +.Cm sshd_enable , +usually YES or NO: +.Dl sysrc sshd_enable .Pp -.Nm -defaultrouter -.Dl returns IP address of default router Pq if configured . -.Pp -Working on other files, such as +Return the IP address of default router +.Pq if configured : +.Dl sysrc defaultrouter +.Ss Working with other files +Return the value of the MAILTO setting, if configured, from .Xr crontab 5 : +.Dl sysrc -f /etc/crontab MAILTO .Pp -.Nm --f /etc/crontab MAILTO -.Dl returns the value of the MAILTO setting Pq if configured . -.Pp -Appending to existing values: -.Pp -.Nm -\&cloned_interfaces+=gif0 -.Dl appends Qo gif0 Qc to $cloned_interfaces Pq see APPENDING VALUES . -.Pp -.Nm -\&cloned_interfaces-=gif0 -.Dl removes Qo gif0 Qc from $cloned_interfaces Pq see SUBTRACTING VALUES . -.Pp -In addition to the above syntax, -.Nm -also supports inline -.Xr sh 1 -PARAMETER expansion for changing the way values are reported, shown below: +Append +.Dq gif0 +to $cloned_interfaces +.Pq see Sx APPENDING VALUES : +.Dl sysrc cloned_interfaces+=gif0 .Pp -.Nm -\&'hostname%%.*' -.Dl returns $hostname up to (but not including) first `.' . +Remove +.Dq gif0 +from $cloned_interfaces +.Pq see Sx SUBTRACTING VALUES : +.Dl sysrc cloned_interfaces-=gif0 +.Ss Inline shell parameter expansion +Return $hostname up to, but not including, first +.Ql \&. : +.Dl sysrc 'hostname%%.*' .Pp -.Nm -\&'network_interfaces%%[$IFS]*' -.Dl returns first word of $network_interfaces . +Return first word of $network_interfaces: +.Dl sysrc 'network_interfaces%%[$IFS]*' .Pp -.Nm -\&'ntpdate_flags##*[$IFS]' -.Dl returns last word of $ntpdate_flags (time server address) . +Return last word of $ntpdate_flags +.Pq time server address : +.Dl sysrc 'ntpdate_flags##*[$IFS]' .Pp -.Nm -usbd_flags-"default" -.Dl returns $usbd_flags or "default" if unset or NULL . +Return $usbd_flags or +.Dq default +if unset or NULL: +.Dl sysrc usbd_flags-"default" .Pp -.Nm -cloned_interfaces+"alternate" -.Dl returns "alternate" if $cloned_interfaces is set . +Return +.Dq alternate +if $cloned_interfaces is set: +.Dl sysrc cloned_interfaces+"alternate" .Sh SEE ALSO .Xr rc.conf 5 , .Xr jail 8 ,