Date: 24 Jan 2002 14:16:36 -0800 From: "Gary W. Swearingen" <swear@blarg.net> To: FreeBSD-gnats-submit@freebsd.org Subject: docs/34239: tunefs(8) man page doesn't describe arguments. Message-ID: <q77kq78ke3.kq7@localhost.localdomain>
next in thread | raw e-mail | index | archive | help
>Number: 34239 >Category: docs >Synopsis: tunefs(8) man page doesn't describe arguments. >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Thu Jan 24 14:20:01 PST 2002 >Closed-Date: >Last-Modified: >Originator: Gary W. Swearingen >Release: FreeBSD 4.5-PRERELEASE i386 (26 dec) >Organization: none >Environment: n/a ================ >Description: -- The tunefs(8) man page doesn't describe the optional arguments "special" and "filesystem". -- It doesn't say what the default is and from my experiment and look at code /usr/src/sbin/tunefs/tunefs.c I think there is no default; at least one argument must be used. -- The two argument names are not as clear as they should be, since both are intended to identify the filesystem to be tuned and "special" is not even standard jargon when used alone. (Change "usage" later.) -- It uses both "filesystem" and "file system" in similar contexts. -- It doesn't say that it reads from /etc/fstab if the filesytem is specified by a mount point. -- It uses "flags" for "options" in one place. (A flag is the first part of an option.) ================ >How-To-Repeat: tunefs -p ================ >Fix: Replace "special" with "device-file" and "filesystem" with "mount-point". Remove the option brackets. Add descriptions. Replace "file system" with "filesystem" throughout. patch -d "unknown uncompressed man directory" < this-PR --- /tmp/tunefs..orig.8 Thu Jan 24 13:10:07 2002 +++ /tmp/tunefs.8 Thu Jan 24 14:06:43 2002 @@ -37,7 +37,7 @@ .Os .Sh NAME .Nm tunefs -.Nd tune up an existing file system +.Nd tune up an existing filesystem .Sh SYNOPSIS .Nm .Op Fl A @@ -52,16 +52,22 @@ .Op Fl p .Op Fl s Ar avgfpdir .Ek -.Op Ar special | Ar filesystem +.Ar device-file | mount-point .Sh DESCRIPTION .Nm Tunefs -is designed to change the dynamic parameters of a file system +is designed to change the dynamic parameters of a filesystem which affect the layout policies. -The parameters which are to be changed are indicated by the flags -given below: +.Pp +.Pp +The filesystem to be tuned is specified by either its device-special file, +.Ar device-file , +or its mount point, +.Ar mount-point +(if that is in a standard entry in /etc/fstab). +The parameters which are to be changed are indicated by these options: .Bl -tag -width indent .It Fl A -The file system has several backups of the super-block. Specifying +The filesystem has several backups of the super-block. Specifying this option will cause all backups to be modified as well as the primary super-block. This is potentially dangerous - use with caution. .It Fl a Ar maxcontig @@ -92,7 +98,7 @@ The effect of this limit is to cause big files to do long seeks more frequently than if they were allowed to allocate all the blocks in a cylinder group before seeking elsewhere. -For file systems with exclusively large files, +For filesystems with exclusively large files, this parameter should be set higher. .It Fl f Ar avgfilezsize Specify the expected average file size. @@ -113,16 +119,16 @@ Turn on/off soft updates. An unmounted filesystem is required. .It Fl o Ar space | time -The file system can either try to minimize the time spent +The filesystem can either try to minimize the time spent allocating blocks, or it can attempt to minimize the space fragmentation on the disk. Optimization for space has much higher overhead for file writes. The kernel normally changes the preference automatically as -the percent fragmentation changes on the file system. +the percent fragmentation changes on the filesystem. .It Fl p Show a summary of what the current tunable settings -are on the selected file system. More detailed information can be +are on the selected filesystem. More detailed information can be obtained in the .Xr dumpfs 8 manual page. @@ -133,7 +139,7 @@ If .Nm .Fl n -is run to enable/disable soft update on an unmounted file system +is run to enable/disable soft update on an unmounted filesystem after booting single-user then .Nm will output the warning @@ -167,16 +173,16 @@ .%O "(reprinted in the BSD System Manager's Manual, SMM:5)" .Re .Sh BUGS -This program should work on mounted and active file systems. +This program should work on mounted and active filesystems. Because the super-block is not kept in the buffer cache, the changes will only take effect if the program -is run on dismounted file systems. -To change the root file system, the system must be rebooted -after the file system is tuned. +is run on dismounted filesystems. +To change the root filesystem, the system must be rebooted +after the filesystem is tuned. .\" Take this out and a Unix Demon will dog your steps from now until .\" the time_t's wrap around. .Pp -You can tune a file system, but you can't tune a fish. +You can tune a filesystem, but you can't tune a fish. .Sh HISTORY The .Nm >Release-Note: >Audit-Trail: >Unformatted: To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?q77kq78ke3.kq7>