From owner-svn-src-all@freebsd.org Thu Jun 18 10:52:52 2020 Return-Path: Delivered-To: svn-src-all@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id 56AA134C48F; Thu, 18 Jun 2020 10:52:52 +0000 (UTC) (envelope-from 0mp@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 "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 49nf0h1bBSz4VyD; Thu, 18 Jun 2020 10:52:52 +0000 (UTC) (envelope-from 0mp@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 31C9B82DC; Thu, 18 Jun 2020 10:52:52 +0000 (UTC) (envelope-from 0mp@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id 05IAqqJF088311; Thu, 18 Jun 2020 10:52:52 GMT (envelope-from 0mp@FreeBSD.org) Received: (from 0mp@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id 05IAqqnB088310; Thu, 18 Jun 2020 10:52:52 GMT (envelope-from 0mp@FreeBSD.org) Message-Id: <202006181052.05IAqqnB088310@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: 0mp set sender to 0mp@FreeBSD.org using -f From: Mateusz Piotrowski <0mp@FreeBSD.org> Date: Thu, 18 Jun 2020 10:52:52 +0000 (UTC) To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r362321 - head/usr.sbin/periodic X-SVN-Group: head X-SVN-Commit-Author: 0mp X-SVN-Commit-Paths: head/usr.sbin/periodic X-SVN-Commit-Revision: 362321 X-SVN-Commit-Repository: base MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-src-all@freebsd.org X-Mailman-Version: 2.1.33 Precedence: list List-Id: "SVN commit messages for the entire src tree \(except for " user" and " projects" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 18 Jun 2020 10:52:52 -0000 Author: 0mp (doc,ports committer) Date: Thu Jun 18 10:52:51 2020 New Revision: 362321 URL: https://svnweb.freebsd.org/changeset/base/362321 Log: Improve periodic(8) manual page presentation - Update synopsis to present all available arguments. - Consistently call the argument specifying an arbitrary directory a "directory". - Do not put macros into -width argument to Bl. They do not expand there. - Stylize command modifiers like "daily" with Cm instead of Pa. While technically periodic(8) operates on directories with such names, it is confusing from the perspective of the manual page reader as Pa and Ar are stylized the same way. Also, I cannot recall a single manual page where Pa would be used to describe the syntax of command-line arguments. MFC after: 2 weeks Modified: head/usr.sbin/periodic/periodic.8 Modified: head/usr.sbin/periodic/periodic.8 ============================================================================== --- head/usr.sbin/periodic/periodic.8 Thu Jun 18 10:50:59 2020 (r362320) +++ head/usr.sbin/periodic/periodic.8 Thu Jun 18 10:52:51 2020 (r362321) @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd May 20, 2016 +.Dd June 18, 2020 .Dt PERIODIC 8 .Os .Sh NAME @@ -32,7 +32,10 @@ .Nd run periodic system functions .Sh SYNOPSIS .Nm -.Ar directory ... +.Sm off +.Cm daily | weekly | monthly | security | Ar directory +.Sm on +.Ar ... .Sh DESCRIPTION The .Nm @@ -42,22 +45,22 @@ to execute shell scripts located in the specified directory. .Pp One or more of the following arguments must be specified: -.Bl -tag -width ".Pa monthly" -.It Pa daily +.Bl -tag -width "directory" +.It Cm daily Perform the standard daily periodic executable run. This usually occurs early in the morning (local time). -.It Pa weekly +.It Cm weekly Perform the standard weekly periodic executable run. This usually occurs very early on Saturday mornings. -.It Pa monthly +.It Cm monthly Perform the standard monthly periodic executable run. This usually occurs on the first day of the month. -.It Pa security +.It Cm security Perform the standard daily security checks. This is usually spawned by the -.Pa daily +.Cm daily run. -.It Ar path +.It Ar directory An arbitrary directory containing a set of executables to be run. .El .Pp