Differential D57254 Diff 178668 usr.sbin/zzz/zzz.8

Changeset View

Standalone View

usr.sbin/zzz/zzz.8

	.\" Copyright (c) 2003 Nate Lawson			.\"-
	.\" All rights reserved.			.\" SPDX-License-Identifier: BSD-2-Clause
	.\"			.\"
	.\" Redistribution and use in source and binary forms, with or without			.\" Copyright (c) 2026 The FreeBSD Foundation
	.\" modification, are permitted provided that the following conditions
	.\" are met:
	.\" 1. Redistributions of source code must retain the above copyright
	.\" notice, this list of conditions and the following disclaimer.
	.\" 2. Redistributions in binary form must reproduce the above copyright
	.\" notice, this list of conditions and the following disclaimer in the
	.\" documentation and/or other materials provided with the distribution.
	.\"			.\"
	.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND			.\" This documentation was written by Aymeric Wibo <obiwac@freebsd.org> under
	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE			.\" sponsorship from the FreeBSD Foundation.
	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	.\" SUCH DAMAGE.
	.\"			.\"
	.Dd July 13, 2003			.Dd May 26, 2026
				olceUnsubmitted Done Inline Actions So you put SPDX even after the addendum about authorship? Interesting. Not too sure about what's right. olce: So you put SPDX even after the addendum about authorship? Interesting. Not too sure about…
				obiwacAuthorUnsubmitted Done Inline Actions no, I just copied it from another manpage and didn't think haha I don't think there's necessarily a rule; this says that it just has to be "near the top": https://spdx.github.io/spdx-spec/v2.3/using-SPDX-short-identifiers-in-source-files/ obiwac: no, I just copied it from another manpage and didn't think haha I don't think there's…
	.Dt ZZZ 8			.Dt ZZZ 8
	.Os			.Os
	.Sh NAME			.Sh NAME
	.Nm zzz			.Nm zzz
	.Nd suspend an ACPI or APM system			.Nd suspend the system
	.Sh SYNOPSIS			.Sh SYNOPSIS
	.Nm			.Nm
	.Sh DESCRIPTION			.Sh DESCRIPTION
	The			The
	.Nm			.Nm
	utility			utility suspends the system by writing a suspend transition request to
	checks for			.Pa /dev/power .
	.Tn ACPI
	or
	.Tn APM
	support and then suspends the system appropriately.
	For
	.Tn APM ,
	.Pp			.Pp
	.Dl apm -z			The specific sleep method used
	.Pp			.Pq e.g.\& suspend-to-idle or firmware suspend
	will be issued.			is determined by the
	For			.Va kern.power.suspend
	.Tn ACPI,			sysctl.
	the configured suspend state will be looked up, checked to see
	if it is supported and,
	.Pp
	.Dl acpiconf -s <state>
	.Pp
	will be issued.
	.Sh SEE ALSO			.Sh SEE ALSO
	.Xr acpi 4 ,			.Xr acpi 4 ,
	.Xr apm 4 ,			.Xr acpiconf 8
	.Xr acpiconf 8 ,			.Sh HISTORY
				The
				.Nm
				utility first appeared as a shell script in
				.Fx 5.1 .
				It suspended the system by invoking
				.Xr acpiconf 8
				with the suspend state configured via
				.Va hw.acpi.suspend_state ,
				or
	.Xr apm 8			.Xr apm 8
				on systems without ACPI support.
				.Pp
				It was rewritten in C in
				.Fx 16.0
				to use the generic power management interface provided by
				.Pa /dev/power .
	.Sh AUTHORS			.Sh AUTHORS
	This manual page was written by			The original
				.Nm
				script was written by
				.An Mark Santcroos Aq Mt marks@ripe.net .
				This manual page was originally written by
	.An Nate Lawson Aq Mt njl@FreeBSD.org .			.An Nate Lawson Aq Mt njl@FreeBSD.org .
				Both the current program and manual page were written by
				.An Aymeric Wibo Aq Mt obiwac@FreeBSD.org ,
				under sponsorship from the
				.Fx
				obiwacAuthorUnsubmitted Done Inline Actions is there a better way to do this? Just writing "FreeBSD Foundation" gets flagged by the mandoc linter obiwac: is there a better way to do this? Just writing "FreeBSD Foundation" gets flagged by the mandoc…
				olceUnsubmitted Done Inline Actions Don't know... Looks slightly over-engineered, but why not. Not sure if `.Fx` is to be considered just a shortcut for "FreeBSD", or if in addition we have some indexing behind it. olce: Don't know... Looks slightly over-engineered, but why not. Not sure if `.Fx` is to be…
				obiwacAuthorUnsubmitted Done Inline Actions or if in addition we have some indexing behind it. that's why i wanted to do "FreeBSD Foundation" instead, but I think it's better to just make the linter happy here obiwac: > or if in addition we have some indexing behind it. that's why i wanted to do "FreeBSD…
				Foundation.