Re: [PATCH] fixup for hex encoding desription in notmuch-tag.1

[Jani Nikula <jani@nikula.org>]

On Sat, 15 Dec 2012, david@tethera.net wrote:
> From: David Bremner <bremner@debian.org>
>
> ---
> and here is the updated description.
>
>  man/man1/notmuch-tag.1 |   19 ++++++++++++++-----
>  1 file changed, 14 insertions(+), 5 deletions(-)
>
> diff --git a/man/man1/notmuch-tag.1 b/man/man1/notmuch-tag.1
> index ac2c8d7..a203f53 100644
> --- a/man/man1/notmuch-tag.1
> +++ b/man/man1/notmuch-tag.1
> @@ -67,13 +67,22 @@ The input must consist of lines of the format:
>  Each line is interpreted similarly to
>  .B notmuch tag
>  command line arguments. The delimiter is one or more spaces ' '. Any
> -characters in <tag> and <search-term>
> +characters in
> +.RI < tag >
> +and
> +.RI < search-term >
>  .B may
> -be hex encoded with %NN where NN is the hexadecimal value of the
> -character. Any ' ' and '%' characters in <tag> and <search-terms>
> +be hex-encoded with %NN where NN is the hexadecimal value of the
> +character (more precisely with %NN[%MM...] where NN, MM, etc... are
> +the hexadecimal values of the bytes in the UTF-8 encoding of
> +the character).  Any characters in <tag> and <search-term> not
> +matching the regex
> +.B [A-Za-z0-9@=.,_+-]

And this actually means you can't have "id:foo" there, as : needs to be
encoded. Not user friendly at all. If it should really mean : is okay
un-encoded as prefix delimiter but not otherwise... it gets a bit messy
to document.

BR,
Jani.

>  .B must
> -be hex encoded (using %20 and %25, respectively). Any characters that
> -are not part of <tag> or <search-terms>
> +be hex-encoded. Any characters that are not part of
> +.RI  < tag >
> +or
> +.RI < search-term >
>  .B must not
>  be hex encoded.
>  
> -- 
> 1.7.10.4
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch