Skip to content

Commit

Permalink
Doc for RI
Browse files Browse the repository at this point in the history
  • Loading branch information
BurdetteLamar committed Apr 12, 2024
1 parent 3b136ba commit ec2be8c
Showing 1 changed file with 9 additions and 18 deletions.
27 changes: 9 additions & 18 deletions RI.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,22 +188,13 @@ with either of:
When you switch to that window, `ri` is ready to respond quickly,
without the performance overhead of re-reading `ri` sources.

### Pager \Options

You can set the pager value to a pager program name with options;
this example (output omitted) sets the pager to `'less'`,
with options `'-E'` (quit at EOF) and `'-F'` (quit if one screen):

```sh
$ RI_PAGER="less -E -F" ri Array
```

See the options for your chosen pager program
(e.g, type `'less --help'`).

### Output Filters

The "pager" value actually need not specify a simple pager program.
The "pager" value actually need not be simply the path to an executable;
it's actually a full-fledged command line,
and so can include not only the executable path,
but also whatever options and arguments that executable accepts.

You can, for example, set the pager value to `'grep . | less'`,
which will exclude blank lines (thus saving screen space)
before piping the result to `less`;
Expand All @@ -213,6 +204,9 @@ example (output omitted):
$ RI_PAGER="grep . | less" ri Array
```

See the documentation for your chosen pager programs
(e.g, type `'grep --help'`, `'less --help'`).

### Links in `ri` Output

#### Implicit Link
Expand Down Expand Up @@ -690,10 +684,7 @@ If you set environment variable `RI_PAGER` or `PAGER`,
its value should be the name of an executable program
that will accept the `ri` output (such as `'pager'`, `'less'`, or `'more'`).
See also:
- {Pager Options}[rdoc-ref:RI.md@Pager+Options].
- {Output Filters}[rdoc-ref:RI.md@Output+Filters].
See also {Output Filters}[rdoc-ref:RI.md@Output+Filters].
## \Options
Expand Down

0 comments on commit ec2be8c

Please sign in to comment.