Document pager (#36)

* Update README

* Clean up FIXME

* Clean up

* Document pager

README.md

@@ -1,4 +1,4 @@
-# Rep Grep
+# Rep
 
 `rep` is a command-line utility that takes [`grep`](https://en.wikipedia.org/wiki/Grep)-formatted lines via standard input, and performs a find-and-replace on them. By default, it outputs a [`diff`](https://en.wikipedia.org/wiki/Diff)-preview of the changes to standard output, and with a flag it can write the changes to the files in place.
 
@@ -28,9 +28,13 @@ The `-n` (`--line-number`) option is required so that `grep` outputs the line nu
 cargo install rep-grep
 ```
 
+## Configuration
+
+The default pager is `less`, the `REP_PAGER` environment variable can be used to override the pager (e.g., `export REP_PAGER=delta` in Bash).
+
 ## Help
 
-`rep -h` (or `rep --help`) will list help for all the command-line flags.
+`rep -h` (or `rep --help`, `--help` provides slightly longer explanations of some options) will list help for all the command-line flags.
 
 ## Acknowledgements
 

src/cli.rs

@@ -8,7 +8,7 @@ use structopt::{clap::AppSettings, StructOpt};
 )]
 pub(crate) struct Options {
  #[structopt(short = "w", long = "write")]
- /// 
+ ///
  /** Write the output to files directly (instead of outputting a patch)
 
 If this flag is not present, and a patch is output, then the default pager is `less`. The

src/main.rs

@@ -5,7 +5,6 @@ mod edit;
 mod patcher;
 mod writer;
 mod output;
-// FIXME: Look at `pub(crate)` calls are all these necessary?
 pub(crate) mod replacer;
 pub(crate) mod utils;
 mod less;

src/output.rs

@@ -44,7 +44,6 @@ impl OutputType {
  let pager_path = PathBuf::from(pager_name);
 
  let is_less = pager_path.file_stem() == Some(&OsString::from("less"));
- // FIXME: When return fails, `quit_if_one_screen = true`, `replace_arguments_to_less = true`, `is_less = true`
  let process = if is_less {
  Self::make_process_from_less_path(
  pager_path,
@@ -55,7 +54,6 @@ impl OutputType {
  } else {
  Self::make_process_from_pager_path(pager_path, args)
  };
- // FIXME: Commenting out this and just returning `OutputType::stdout()` fixes the problem
  if let Some(mut process) = process {
  process
  .stdin(Stdio::piped())