Page MenuHomeFreeBSD

New manual page for save-entropy
Needs ReviewPublic

Authored by trhodes on Mar 11 2019, 8:42 PM.
Referenced Files
Unknown Object (File)
Jan 13 2024, 1:38 PM
Unknown Object (File)
Jan 11 2024, 6:26 AM
Unknown Object (File)
Dec 20 2023, 7:17 AM
Unknown Object (File)
Nov 22 2023, 5:12 PM
Unknown Object (File)
Jun 12 2023, 9:10 PM
Unknown Object (File)
Mar 21 2023, 8:17 PM
Unknown Object (File)
Mar 4 2023, 12:11 AM
Unknown Object (File)
Nov 26 2022, 8:18 AM
Subscribers
This revision needs review, but there are no reviewers specified.

Details

Reviewers
None
Summary

Add a save-entropy.1 manual page. Question, does this go in .1 or somewhere else? The locate.updatedb.8 manual page is in section 8 so maybe this should be there? Thoughts? This supports the list of manual page PR (108980) and an individual one which is specific to this manual page (23998).

Diff Detail

Repository
rD FreeBSD doc repository - subversion
Lint
Lint Skipped
Unit
Tests Skipped
Build Status
Buildable 23014

Event Timeline

Some comments. I'm more inclined on putting it into section 8 of the man pages. Going from the description of sections in man(1), it's more geared towards sysadmins rather than being a general FreeBSD command to run.
Have you run textproc/igor over it and "mandoc -Tlint" for any errors/warnings it might find?

save-entropy.1
47

"Environmental noise" sounds like it's using your microphone to pick up entropy in loud surroundings. ;)
Maybe we can find a more unambiguous term here without repeating the word "random" within the sentence?

51

Maybe s/noise/bits of collected random data/ ?

59

s/place/places/

Interestingly, igor only complains about the date not being today, but this is the latest version for section 8:

.\"-
.\" Copyright (c) 2019 Tom Rhodes
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" 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
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" 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.
.\"
.\" $Id$
.\"
.Dd March 11, 2019
.Dt save-entropy
.Os
.Sh NAME
.Nm save-entropy
.Nd "Save system entropy"
.Sh SYNOPSIS
.Nm
.Sh DESCRIPTION
The
.Nm
script is used to store bits of randomness which are
then used to seed
.Dv /dev/random
on boot.
On
.Fx
the
.Dv /dev/random
device is seeded with collected bits from the environment
to aid in random number generation.
The expectation is that this information is random and unpredictable.
The
.Nm
script allows this noise to be stored for boot time usage.
The
.Nm
script is ran from a line in
.Fa /etc/crontab
as the operator user.
This script will rotate entropy files located in
.Pa /var/db/entropy
and places a number at the end of each file.
.Sh EXIT STATUS
Exit status is 0 on success or 1 if the command has failed.
An error will be logged when the command fails.
.Sh SEE ALSO
.Xr random 4 ,
.Xr rc.conf 5 .