Bug#360271: hdparm: manpage has a chaotic structure

2006-03-31 Thread Joerg Hoh
Package: hdparm
Version: 6.3-3
Severity: wishlist
Tags: patch

Please apply the attached patch. It groups the variuos options of hdparm
into logical sections.

-- System Information:
Debian Release: testing/unstable
  APT prefers unstable
  APT policy: (500, 'unstable')
Architecture: i386 (i686)
Shell:  /bin/sh linked to /bin/bash
Kernel: Linux 2.6.16jh
Locale: [EMAIL PROTECTED], [EMAIL PROTECTED] (charmap=ISO-8859-15)

Versions of packages hdparm depends on:
ii  libc6 2.3.6-4GNU C Library: Shared libraries an
ii  lsb-base  3.0-16 Linux Standard Base 3.0 init scrip

hdparm recommends no packages.

-- no debconf information
--- hdparm.8.old2006-03-31 20:06:32.319368250 +0200
+++ hdparm.82006-03-31 22:28:55.881307500 +0200
@@ -15,6 +15,157 @@
 When no flags are given,
 .I -acdgkmnru
 is assumed.
+
+.TP
+.SH Show information on hard disk
+
+.TP
+.I -C
+Check the current IDE power mode status, which will always be one of
+.B unknown
+(drive does not support this command),
+.B active/idle
+(normal operation),
+.B standby
+(low power mode, drive has spun down),
+or
+.B sleeping
+(lowest power mode, drive is completely shut down).
+The
+.B -S, -y, -Y,
+and
+.B -Z
+flags can be used to manipulate the IDE power modes.
+
+.TP
+.I -g
+Display the drive geometry (cylinders, heads, sectors),
+the size (in sectors) of the device,
+and the starting offset (in sectors) of the device from
+the beginning of the drive.
+.TP
+.I -i
+Display the identification info that was obtained from the drive at
+.I boot time,
+if available.
+This is a feature of modern IDE drives,
+and may not be supported by older devices.
+The data returned may or may not be current, depending on activity
+since booting the system.
+However, the current multiple sector mode count is always shown.
+For a more detailed interpretation of the identification info,
+refer to
+.I AT Attachment Interface for Disk Drives
+(ANSI ASC X3T9.2 working draft, revision 4a, April 19/93).
+
+.TP
+.I -I
+Request identification info directly from the drive,
+which is displayed in a new expanded format with considerably
+more detail than with the older
+.I -i
+flag.
+
+.TP
+.I -Istdin
+This is a special "no seatbelts" variation on the
+.B -I
+option,
+which accepts a drive identification block as standard input
+instead of using a /dev/hd* parameter.
+The format of this block must be
+.I exactly
+the same as that found in the /proc/ide/*/hd*/identify "files",
+or that produced by the
+.B -Istdout
+option described below.
+This variation is designed for use with collected "libraries" of drive
+identification information, and can also be used on ATAPI
+drives which may give media errors with the standard mechanism.
+.TP
+.I -Istdout
+This option simply dumps the identify data in hex to stdout,
+in a format similar to that from /proc/, and suitable for
+later use with the
+.I -Istdin
+option.
+
+
+.TP
+.I -v 
+Display all settings, except -i (same as -acdgkmnru for IDE, -gr for SCSI or
+-adgr for XT).  This is also the default behaviour when no flags are specified.
+
+
+
+
+.TP
+.SH Power/Noise settings
+.TP
+.I -A
+Disable/enable the IDE drive\'s read-lookahead feature (usually ON by default).
+Usage:
+.B -A0
+(disable) or
+.B -A1
+(enable).
+
+.TP
+.I -M
+Get/set Automatic Acoustic Management (AAM) setting. Most modern harddisk 
drives 
+have the ability to speed down the head movements to reduce their noise output.
+The possible values are between 0 and 254. 128 is the most quiet (and therefore
+slowest) setting and 254 the fastest (and loudest). Some drives have only two 
+levels (quiet / fast), while others may have different levels between 128 and 
254.
+At the moment, most drives only support 3 options, off, quiet, and fast.
+These have been assigned the values 0, 128, and 254 at present, respectively,
+but integer space has been incorporated for future expansion, should this 
change.
+
+.TP
+.I -S
+Set the standby (spindown) timeout for the drive.  This value is used
+by the drive to determine how long to wait (with no disk activity)
+before turning off the spindle motor to save power.  Under such
+circumstances, the drive may take as long as 30 seconds to respond to
+a subsequent disk access, though most drives are much quicker.  The
+encoding of the timeout value is somewhat peculiar.  A value of zero
+means "timeouts are disabled": the device will not automatically enter
+standby mode.  Values from 1 to 240 specify multiples of 5 seconds,
+yielding timeouts from 5 seconds to 20 minutes.  Values from 241 to
+251 specify from 1 to 11 units of 30 minutes, yielding timeouts from
+30 minutes to 5.5 hours.  A value of 252 signifies a timeout of 21
+minutes. A value of 253 sets a vendor-defined timeout period between 8
+and 12 hours, and the value 254 is reserved.  255 is interpreted as 21
+minutes plus 15 seconds.  Note that some older drives may have very
+different interpretations of these values.
+.TP
+.I

Bug#360271: hdparm: manpage has a chaotic structure

2006-03-31 Thread Joerg Hoh
On Fri, Mar 31, 2006 at 11:40:41PM +0100, Stephen Gran wrote:
> This one time, at band camp, Joerg Hoh said:
> > Please apply the attached patch. It groups the variuos options of hdparm
> > into logical sections.
> 
> Er, have you noticed that the current manpage is alphabetical, which is
> the sort of unwritten norm?

Yes, but looking for "which parameter is the right one to put my HD into
sleep" is quite anoying.

> I'll think about it, and I understand your frustration, but it will take
> quite a bit for me to feel that breaking the normal convention is worth
> it.

It takes much time if you don't know which parameter you need.

Jörg

-- 
What did you do to the cat? It looks half-dead. -Schroedinger's wife


signature.asc
Description: Digital signature


Bug#360271: hdparm: manpage has a chaotic structure

2006-03-31 Thread Stephen Gran
This one time, at band camp, Joerg Hoh said:
> Please apply the attached patch. It groups the variuos options of hdparm
> into logical sections.

Er, have you noticed that the current manpage is alphabetical, which is
the sort of unwritten norm?

I'll think about it, and I understand your frustration, but it will take
quite a bit for me to feel that breaking the normal convention is worth
it.
-- 
 -
|   ,''`.Stephen Gran |
|  : :' :[EMAIL PROTECTED] |
|  `. `'Debian user, admin, and developer |
|`- http://www.debian.org |
 -


signature.asc
Description: Digital signature


Bug#360271: hdparm: manpage has a chaotic structure

2006-03-31 Thread Stephen Gran
This one time, at band camp, Joerg Hoh said:
> On Fri, Mar 31, 2006 at 11:40:41PM +0100, Stephen Gran wrote:
> > This one time, at band camp, Joerg Hoh said:
> > > Please apply the attached patch. It groups the variuos options of hdparm
> > > into logical sections.
> > 
> > Er, have you noticed that the current manpage is alphabetical, which is
> > the sort of unwritten norm?
> 
> Yes, but looking for "which parameter is the right one to put my HD into
> sleep" is quite anoying.

There are 2 lines with the word sleep in them.  This is not that bad.  I
would need more to be convinced, I am sorry.

Take care,
-- 
 -
|   ,''`.Stephen Gran |
|  : :' :[EMAIL PROTECTED] |
|  `. `'Debian user, admin, and developer |
|`- http://www.debian.org |
 -


signature.asc
Description: Digital signature


Bug#360271: hdparm: manpage has a chaotic structure

2006-04-01 Thread Joerg Hoh
On Sat, Apr 01, 2006 at 01:40:29AM +0100, Stephen Gran wrote:
> This one time, at band camp, Joerg Hoh said:
> > On Fri, Mar 31, 2006 at 11:40:41PM +0100, Stephen Gran wrote:
> > > This one time, at band camp, Joerg Hoh said:
> > > > Please apply the attached patch. It groups the variuos options of hdparm
> > > > into logical sections.
> > > 
> > > Er, have you noticed that the current manpage is alphabetical, which is
> > > the sort of unwritten norm?
> > 
> > Yes, but looking for "which parameter is the right one to put my HD into
> > sleep" is quite anoying.
> 
> There are 2 lines with the word sleep in them.  This is not that bad.  I
> would need more to be convinced, I am sorry.

Ok, after talking with other people about that they told me that
alphabetical order is natural to them and they are used to use the search
function of their pager.

You can close this "bug".

Jörg



-- 
What did you do to the cat? It looks half-dead. -Schroedinger's wife


signature.asc
Description: Digital signature