diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/remembering.1 | 42 | ||||
| -rw-r--r-- | doc/remembering.5 | 51 |
2 files changed, 22 insertions, 71 deletions
diff --git a/doc/remembering.1 b/doc/remembering.1 index 824e46a..7ee0dce 100644 --- a/doc/remembering.1 +++ b/doc/remembering.1 @@ -6,37 +6,23 @@ remembering - sort list using previous choices as weight . . .SH SYNOPSYS -.B remembering -.RB -p -.IR profile -.RB -c -.IR command +.P +\fBremembering\fR -p \fIPROFILE\fR -c \fICOMMAND\fR . . .SH DESCRIPTION -.B remembering -takes a command that chooses an option as its behaviour, such as -.B fzf -or -.B dmenu -and -.IR remembers -what option is chosen, and as it is used, will put the most used choices at the beginning of the list. +\fBremembering\fR takes a command that chooses an option as its behaviour, such as \fBfzf\fR(1) or \fBdmenu\fR(1) and \fIremembers\fR what option is chosen, and as it is used, will put the most used choices at the beginning of the list. . . .SH OPTIONS . .TP .B -c -The -.IR command -to be executed, reading from standard input (STDIN). +The \fIcommand\fR to be executed, reading from standard input (STDIN). . .TP .B -p -The name of the -.IR profile -where to look up and store raking data. +The name of the \fIprofile\fR where to look up and store raking data. . .TP .B -h @@ -49,10 +35,7 @@ Show version number. . .SH EXAMPLES .P -List current directory and feed it to -.IR fzf -via -.B remembering: +List current directory and feed it to \fBfzf\fR(1) via \fBremembering\fR: .RS .EX @@ -61,15 +44,7 @@ $ ls | remembering -p fzf-ls -c fzf .RE . .P -Lists all executables available in -.B $PATH, -and feed those to -.IR dmenu -via -.B remembering, -and execute with -.B sh -the choice picked: +Lists all executables available in \fI$PATH\fR, and feed those to \fBdmenu\fR(1) via \fBremembering\fR, and execute with \fBsh\fR(1) the choice picked: .RS .EX @@ -82,7 +57,8 @@ Successive invocations will put the frequent choices at the beginning. . . .SH SEE ALSO -.IR remembering (5) +.P +\fBremembering\fR(5) . . .SH AUTHORS 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 |