From ad79fa59cc02a7d717726c6fc5305b31bed4870b Mon Sep 17 00:00:00 2001 From: Bob Polis Date: Thu, 10 Apr 2025 15:57:21 +0200 Subject: [PATCH] Replace boilerplate man page with relevant content --- man/man1/screensaver.1 | 50 +++++++++++++++++++++++++----------------- 1 file changed, 30 insertions(+), 20 deletions(-) diff --git a/man/man1/screensaver.1 b/man/man1/screensaver.1 index 17473d7..e421380 100644 --- a/man/man1/screensaver.1 +++ b/man/man1/screensaver.1 @@ -1,56 +1,66 @@ -.Dd $Mdocdate$ +.Dd April 10, 2025 .Dt screensaver 1 .Os .Sh NAME .Nm screensaver -.Nd one line about what it does -.\" .Sh LIBRARY -.\" For sections 2, 3, and 9 only. -.\" Not used in OpenBSD. +.Nd Tool to display screensaver plugins fullscreen .Sh SYNOPSIS .Nm -.Fl h | v +.Fl h | v | l .Nm +.Op Fl r +.Op Fl w .Op Ar .Sh DESCRIPTION The .Nm -utility processes files ... -When no file arguments are given, +tool displays a graphic animation, either fullscreen on the primary screen (the +default), or in a window, when the +.Fl w +flag is given. +When no argument is supplied, .Nm -will read from the standard input. +will display a default module. +Otherwise, it will load and use the specified module. .Pp The options are as follows: .Bl -tag -width Ds .It Fl h, \-help Print help text and exit. +.It Fl l, \-list +List all available modules, with their current version numbers. +.It Fl r, \-random +Choose a module randomly, and use that. +.It Fl w, \-window +Show the animation in a resizable window, so you can drag it to another screen, +for example. .It Fl v, \-version Print version info and exit. .El -.\" .Sh CONTEXT -.\" For section 9 functions only. -.\" .Sh IMPLEMENTATION NOTES -.\" Not used in OpenBSD. -.\" .Sh RETURN VALUES -.\" For sections 2, 3, and 9 function return values only. .\" .Sh ENVIRONMENT .\" For sections 1, 6, 7, and 8 only. -.\" .Sh FILES +.Sh FILES +.Bl -tag -width Ds +.It Pa /usr/local/share/screensaver/plugins +This directory is where the screensaver modules are installed, +along with their JSON configuration files, if any. +The first part of this path, +.Pa /usr/local , +could be another prefix, depending on the prefix used when the screensaver and +its modules were installed. +.El .Sh EXIT STATUS -.\" For sections 1, 6, and 8 only. .Nm exits 0 on success, and 1 if an error occurs. .\" .Sh EXAMPLES .\" .Sh DIAGNOSTICS .\" For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only. -.\" .Sh ERRORS -.\" For sections 2, 3, 4, and 9 errno settings only. .\" .Sh SEE ALSO .\" .Xr foobar 1 .\" .Sh STANDARDS .\" .Sh HISTORY .Sh AUTHORS -Bob Polis +.An Bob Polis .\" .Sh CAVEATS .\" .Sh BUGS .\" .Sh SECURITY CONSIDERATIONS