diff options
| author | EuAndreh <eu@euandre.org> | 2021-06-13 19:48:01 -0300 |
|---|---|---|
| committer | EuAndreh <eu@euandre.org> | 2021-06-13 19:48:01 -0300 |
| commit | de7838f0568e0d437822407d46d95e0269a81912 (patch) | |
| tree | f134fbdc20259f4fe29b9fd5cb8d62b551a61701 /doc/remembering.5 | |
| parent | src/remembering.sh: Remove \" from COMMAND in help text (diff) | |
| download | remembering-de7838f0568e0d437822407d46d95e0269a81912.tar.gz remembering-de7838f0568e0d437822407d46d95e0269a81912.tar.xz | |
doc/remembering.*: Rewrite troff using inline requests for bold and italic
Diffstat (limited to 'doc/remembering.5')
| -rw-r--r-- | doc/remembering.5 | 51 |
1 files changed, 13 insertions, 38 deletions
diff --git a/doc/remembering.5 b/doc/remembering.5 index 7fecc3e..f8ae6ad 100644 --- a/doc/remembering.5 +++ b/doc/remembering.5 @@ -2,32 +2,18 @@ . . .SH NAME -remembering - format of -.IR profile -text file. +remembering - format of \fIPROFILE\fB text file. . . .SH PROFILE -The -.IR profile -is a text file, stored on $XDG_DATA_HOME/profile-name +The \fIPROFILE\fR is a text file, stored on $XDG_DATA_HOME/profile-name if $XDG_DATA_HOME is defined. Otherwise, it lives in ~/.local/share/remembering/profile-name. .P -Each line of the -.IR profile -contains two pieces of information: the -.B rank -of the current entry, and the -.B entry -itself. +Each line of the \fIPROFILE\fR contains two pieces of information: the \fBrank\fR of the current entry, and the \fBentry\fR itself. . .P -The -.B rank -is a number that, and the -.B entry -is all the text until the end of the line: +The \fBrank\fR is a number that, and the \fBentry\fR is all the text until the end of the line: .RS .EX @@ -39,18 +25,10 @@ is all the text until the end of the line: .EE .RE .P -Above is an example of a -.IR profile -file where all the entries have the default -.B rank -value: -.B 0. +Above is an example of a \fIPROFILE\fR file where all the entries have the default +\fBrank\fR value: \fB0\fR. .P -If the -.IR command -runs and chooses "banana", the new -.IR profile -will be: +If the \fICOMMAND\fR runs and chooses "banana", the new \fIPROFILE\fR will be: .RS .EX @@ -62,19 +40,16 @@ will be: .EE .RE .P -The entries of the -.IR profile -are created and kept sorted. -.B remembering -expects to always find sorted entries in the \fIprofile\fR. +The entries of the \fIPROFILE\fR are created and kept sorted. +\fBremembering\fR(1) expects to always find sorted entries in the \fIPROFILE\fR. .P -The current raking algorithm increments entries as a simple -counter. Every time an entry is picked, its ranked is incremented -in the \fIprofile\fR. +The current raking algorithm increments entries as a simple counter. +Every time an entry is picked, its ranked is incremented in the \fIPROFILE\fR. . . .SH SEE ALSO -.IR remembering (1) +.P +\fBremembering\fR(1) . . .SH AUTHORS |