bob/screensaver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Replace boilerplate man page with relevant content

Browse Source
This commit is contained in:
Bob Polis
2025-04-10 15:57:21 +02:00
parent 45a5257ffa
commit ad79fa59cc
1 changed files with 30 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
man/man1/screensaver.1
View File

@ -1,56 +1,66 @@
.Dd $Mdocdate$ .Dd April 10, 2025
.Dt screensaver 1 .Dt screensaver 1
.Os .Os
.Sh NAME .Sh NAME
.Nm screensaver .Nm screensaver
.Nd one line about what it does .Nd Tool to display screensaver plugins fullscreen
.\" .Sh LIBRARY
.\" For sections 2, 3, and 9 only.
.\" Not used in OpenBSD.
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Fl h | v .Fl h | v | l
.Nm .Nm
.Op Fl r
.Op Fl w
.Op Ar .Op Ar
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
utility processes files ... tool displays a graphic animation, either fullscreen on the primary screen (the
When no file arguments are given, default), or in a window, when the
.Fl w
flag is given.
When no argument is supplied,
.Nm .Nm
will read from the standard input. will display a default module.
Otherwise, it will load and use the specified module.
.Pp .Pp
The options are as follows: The options are as follows:
.Bl -tag -width Ds .Bl -tag -width Ds
.It Fl h, \-help .It Fl h, \-help
Print help text and exit. 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 .It Fl v, \-version
Print version info and exit. Print version info and exit.
.El .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 .\" .Sh ENVIRONMENT
.\" For sections 1, 6, 7, and 8 only. .\" 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 .Sh EXIT STATUS
.\" For sections 1, 6, and 8 only.
.Nm .Nm
exits 0 on success, and 1 if an error occurs. exits 0 on success, and 1 if an error occurs.
.\" .Sh EXAMPLES .\" .Sh EXAMPLES
.\" .Sh DIAGNOSTICS .\" .Sh DIAGNOSTICS
.\" For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only. .\" 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 .\" .Sh SEE ALSO
.\" .Xr foobar 1 .\" .Xr foobar 1
.\" .Sh STANDARDS .\" .Sh STANDARDS
.\" .Sh HISTORY .\" .Sh HISTORY
.Sh AUTHORS .Sh AUTHORS
Bob Polis .An Bob Polis
.\" .Sh CAVEATS .\" .Sh CAVEATS
.\" .Sh BUGS .\" .Sh BUGS
.\" .Sh SECURITY CONSIDERATIONS .\" .Sh SECURITY CONSIDERATIONS