svn commit: r224533 - head/share/man/man4

[Joel Dahl]

On 01-08-2011 12:12, Hiroki Sato wrote:
> Hi Joel,
> 
> Joel Dahl <joel at FreeBSD.org> wrote
>   in <201107302309.p6UN9rhJ019321 at svn.freebsd.org>:
> 
> jo> Author: joel (doc committer)
> jo> Date: Sat Jul 30 23:09:52 2011
> jo> New Revision: 224533
> jo> URL: http://svn.freebsd.org/changeset/base/224533
> jo>
> jo> Log:
> jo>   Add a better description, a few examples and a couple of minor fixes.
> jo>
> jo>   Reviewed by:	brueffer
> jo>   Approved by:	re (kib)
> jo>
> jo> Modified:
> jo>   head/share/man/man4/pcm.4
> jo>
> jo> Modified: head/share/man/man4/pcm.4
> jo> ==============================================================================
> 
> (snip)
> 
> jo> @@ -173,7 +244,7 @@ controls (bass and treble).
> jo>  Commonly used for ear-candy or frequency compensation due to the vast
> jo>  difference in hardware quality.
> jo>  EQ is disabled by default, but can be enabled with the
> jo> -.Va hint.pcm. Ns Ao Ar X Ac Ns Va .eq
> jo> +.Va hint.pcm.%d.eq
> 
>  :
> 
> jo> -.It Va hint.pcm. Ns Ao Ar X Ac Ns Va .eq
> jo> +.It Va hint.pcm.%d.eq
> 
>  :
> 
> jo> -.It Va hint.pcm. Ns Ao Ar X Ac Ns Va .vpc
> jo> +.It Va hint.pcm.%d.vpc
> 
>  I know several manual pages are also using this expression (%d) for
>  replaceables, but I am wondering if this is friendly for average
>  users.  Is ".Ar N" for an integer problematic, for example?  I would
>  like comments since other documents in DocBook have used such a
>  notation for a long time and I feel we need consistency with them.

I changed it to be consistent with the rest of the manual page, but I'm also
not a big fan of using %d as it might be a bit confusing for some users...

-- 
Joel