Bug 176648 - restore(8) man page is misleading/confusing
Summary: restore(8) man page is misleading/confusing
Status: Open
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: Normal Affects Only Me
Assignee: freebsd-bugs (Nobody)
Depends on:
Reported: 2013-03-04 20:00 UTC by Ronald F. Guilmette
Modified: 2018-04-11 20:11 UTC (History)
1 user (show)

See Also:


Note You need to log in before you can comment on or make changes to this bug.
Description Ronald F. Guilmette 2013-03-04 20:00:01 UTC
The following text appears in the restore(8) man page:

    The -r flag ... can be detrimental to one's health if
    not used carefully (not to mention the disk).  An example:

             newfs /dev/da0s1a
             mount /dev/da0s1a /mnt
             cd /mnt

             restore rf /dev/sa0

The above passage is confusing because first it is giving an omnious
warning about bad effects that can derive from misusing the -r option,
and then, immediately following that, it gives an example of _correct_
usage of the -r option.

It has been suggested that the material begining with "An example:" should
be placed into its own separate paragraph, and I agree with that suggestion.
Furthermore, I think that it would be best to make the meaning entirely
clear by changing "An example:" to "Here is an example of how to
_correctly_ use the -r option:"


See above.
man 8 restore
Comment 1 Eitan Adler freebsd_committer freebsd_triage 2017-12-31 07:58:33 UTC
For bugs matching the following criteria:

Status: In Progress Changed: (is less than) 2014-06-01

Reset to default assignee and clear in-progress tags.

Mail being skipped