diff --git a/build.rs b/build.rs index b7f26f17..7f92f3c2 100644 --- a/build.rs +++ b/build.rs @@ -168,7 +168,12 @@ fn formatted_arg(arg: &RGArg) -> io::Result { } fn formatted_doc_txt(arg: &RGArg) -> io::Result { - let paragraphs: Vec<&str> = arg.doc_long.split("\n\n").collect(); + let paragraphs: Vec = arg.doc_long + .replace("{", "{") + .replace("}", r"}") + .split("\n\n") + .map(|s| s.to_string()) + .collect(); if paragraphs.is_empty() { return Err(ioerr(format!("missing docs for --{}", arg.name))); } diff --git a/src/app.rs b/src/app.rs index 6b39f8f4..57093fa6 100644 --- a/src/app.rs +++ b/src/app.rs @@ -788,17 +788,17 @@ to one of eight choices: red, blue, green, cyan, magenta, yellow, white and black. Styles are limited to nobold, bold, nointense, intense, nounderline or underline. -The format of the flag is `{type}:{attribute}:{value}`. `{type}` should be -one of path, line, column or match. `{attribute}` can be fg, bg or style. -`{value}` is either a color (for fg and bg) or a text style. A special format, -`{type}:none`, will clear all color settings for `{type}`. +The format of the flag is '{type}:{attribute}:{value}'. '{type}' should be +one of path, line, column or match. '{attribute}' can be fg, bg or style. +'{value}' is either a color (for fg and bg) or a text style. A special format, +'{type}:none', will clear all color settings for '{type}'. For example, the following command will change the match color to magenta and the background color for line numbers to yellow: rg --colors 'match:fg:magenta' --colors 'line:bg:yellow' foo. -Extended colors can be used for `{value}` when the terminal supports ANSI color +Extended colors can be used for '{value}' when the terminal supports ANSI color sequences. These are specified as either 'x' (256-color) or 'x,x,x' (24-bit truecolor) where x is a number between 0 and 255 inclusive. x may be given as a normal decimal number or a hexadecimal number, which is prefixed by `0x`.