diff --git a/doc/git-annex-examinekey.mdwn b/doc/git-annex-examinekey.mdwn index 50156afbf1..f2c7a095fb 100644 --- a/doc/git-annex-examinekey.mdwn +++ b/doc/git-annex-examinekey.mdwn @@ -20,7 +20,8 @@ that can be determined purely by looking at the key. The value is a format string, in which '${var}' is expanded to the value of a variable. To right-justify a variable with whitespace, use '${var;width}' ; to left-justify a variable, use '${var;-width}'; - to escape unusual characters in a variable, use '${escaped_var}' + to escape unusual characters (including control characters) + in a variable, use '${escaped_var}' To generate a path from the top of the repository to the git-annex object for a key, use ${objectpath}. To generate the value of a diff --git a/doc/git-annex-find.mdwn b/doc/git-annex-find.mdwn index 675c22ee22..dde58ff61b 100644 --- a/doc/git-annex-find.mdwn +++ b/doc/git-annex-find.mdwn @@ -41,7 +41,8 @@ finds files in the current directory and its subdirectories. The value is a format string, in which '${var}' is expanded to the value of a variable. To right-justify a variable with whitespace, use '${var;width}' ; to left-justify a variable, use '${var;-width}'; - to escape unusual characters in a variable, use '${escaped_var}' + to escape unusual characters (including control characters) + in a variable, use '${escaped_var}' These variables are available for use in formats: file, key, backend, bytesize, humansize, keyname, hashdirlower, hashdirmixed, mtime (for diff --git a/doc/git-annex-findkeys.mdwn b/doc/git-annex-findkeys.mdwn index d195c2f132..45419e8f1a 100644 --- a/doc/git-annex-findkeys.mdwn +++ b/doc/git-annex-findkeys.mdwn @@ -36,7 +36,8 @@ Outputs a list of keys known to git-annex. The value is a format string, in which '${var}' is expanded to the value of a variable. To right-justify a variable with whitespace, use '${var;width}' ; to left-justify a variable, use '${var;-width}'; - to escape unusual characters in a variable, use '${escaped_var}' + to escape unusual characters (including control characters) + in a variable, use '${escaped_var}' These variables are available for use in formats: key, backend, bytesize, humansize, keyname, hashdirlower, hashdirmixed, mtime (for diff --git a/doc/git-annex-whereis.mdwn b/doc/git-annex-whereis.mdwn index 4e427ed540..ffa0647918 100644 --- a/doc/git-annex-whereis.mdwn +++ b/doc/git-annex-whereis.mdwn @@ -85,7 +85,8 @@ received from remotes. The value is a format string, in which '${var}' is expanded to the value of a variable. To right-justify a variable with whitespace, use '${var;width}' ; to left-justify a variable, use '${var;-width}'; - to escape unusual characters in a variable, use '${escaped_var}' + to escape unusual characters (including control characters) + in a variable, use '${escaped_var}' These variables are available for use in formats: file, key, uuid, url, backend, bytesize, humansize, keyname, hashdirlower, hashdirmixed,