[PATCH app/xrandr] man: Document the new --filter option

[Peter Hutterer]

On Thu, Jun 01, 2017 at 03:45:59PM -0700, Aaron Plattner wrote:
> Signed-off-by: Aaron Plattner <aplattner at nvidia.com>
> ---
> I noticed elsewhere that in PDF versions of the man pages, \- expands as U+2212
> MINUS SIGN and - expands to U+002D HYPHEN-MINUS. So I think our use of - and \-
> is backwards. I didn't try to fix that here.

>From http://man7.org/linux/man-pages/man7/groff_char.7.html:

       -      the ISO latin1 ‘Hyphen, Minus Sign’ (code 45) prints as a
              hyphen; a minus sign can be obtained with ‘\-’.

And from http://liw.fi/manpages/

    An unfortunate bit of arcane syntax is that dashes in options should be
    prefixed by backslashes. Thus, write \-\-bits, not just --bits. The
    Debian and Ubuntu implementation of man treats them the same, for
    terminal output, but this is not portable. Technically a naked - means a
    hyphen, whereas \- means a minus sign. Typographically these are
    distinct, and they are also distinct in Unicode. The typesetter is free
    to break a line at a hyphen, but not at a minus. For dashes in options,
    you should thus use minuses, but in normal text, for normal words, the hyphen.

So it seems the below bit is correct?

remote: I: patch #159552 updated using rev 8969b3c651eaae3e3a2370ec45f4eeae9750111d.
remote: I: 1 patch(es) updated to state Accepted.
To git+ssh://git.freedesktop.org/git/xorg/app/xrandr
   6ac2afc..8969b3c  master -> master

Cheers,
   Peter

> 
>  man/xrandr.man | 8 +++++++-
>  1 file changed, 7 insertions(+), 1 deletion(-)
> 
> diff --git a/man/xrandr.man b/man/xrandr.man
> index 55ea5dd9b6f4..65ccc2a2f9c6 100644
> --- a/man/xrandr.man
> +++ b/man/xrandr.man
> @@ -155,7 +155,9 @@ parameters specify the border and default to 0. A width or height set to zero
>  disables panning on the according axis. You typically have to set the screen
>  size with \fI--fb\fP simultaneously.
>  .IP "\-\-transform \fIa\fP,\fIb\fP,\fIc\fP,\fId\fP,\fIe\fP,\fIf\fP,\fIg\fP,\fIh\fP,\fIi\fP"
> -Specifies a transformation matrix to apply on the output. Automatically a bilinear filter is selected.
> +Specifies a transformation matrix to apply on the output.
> +A bilinear filter is selected automatically unless the \-\-filter parameter is
> +also specified.
>  The mathematical form corresponds to:
>  .RS
>  .RS
> @@ -201,6 +203,10 @@ As a special argument, instead of
>  passing a matrix, one can pass the string \fInone\fP, in which case the default
>  values are used (a unit matrix without filter).
>  .RE
> +.IP "\-\-filter \fIfiltermode\fP"
> +Chooses the scaling filter method to be applied when the screen is scaled or
> +transformed.
> +Can be either 'bilinear' or 'nearest'.
>  .IP "\-\-scale \fIx\fPx\fIy\fP"
>  Changes the dimensions of the output picture. Values superior to 1 will lead to
>  a compressed screen (screen dimension bigger than the dimension of the output
> -- 
> 2.13.0
> 
> _______________________________________________
> xorg-devel at lists.x.org: X.Org development
> Archives: http://lists.x.org/archives/xorg-devel
> Info: https://lists.x.org/mailman/listinfo/xorg-devel
>