diff options
Diffstat (limited to 'doc/remembering.1')
| -rw-r--r-- | doc/remembering.1 | 78 |
1 files changed, 41 insertions, 37 deletions
diff --git a/doc/remembering.1 b/doc/remembering.1 index 87275d7..d26da06 100644 --- a/doc/remembering.1 +++ b/doc/remembering.1 @@ -1,89 +1,93 @@ .TH REMEMBERING 1 @DATE@ "remembering @VERSION@" -. -. + + .SH NAME -remembering - sort list using previous choices as weight. -. -. + +remembering - sort list from \fISTDIN\fR using past choices as weight. + + .SH SYNOPSYS -.P + \fBremembering\fR \fB-p\fR \fIPROFILE\fR \fB-c\fR \fICOMMAND\fR -. -. + + .SH DESCRIPTION -.P + \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. -.P + \fBremembering\fR reads from STDIN and writes to STDOUT. It expects STDIN to be sorted. -. -. + + .SH OPTIONS -. + .TP \fB-c\fR \fICOMMAND\fR The \fICOMMAND\fR to be executed, reading from standard input (STDIN). -. + .TP \fB-p\fR \fIPROFILE\fR The name of the \fIPROFILE\fR where to look up and store raking data. -. + .TP -.B -h +\fB-h\fR Show short help text. -. + .TP -.B -V +\fB-V\fR Show version number. -. -. + + .SH EXAMPLES -.P + List current directory and feed it to \fBfzf\fR(1) via \fBremembering\fR: .nf $ ls | remembering -p fzf-ls -c fzf .fi -. -.P + + 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: .nf $ dmenu_path | remembering -p dmenu-exe -c 'dmenu' | sh .fi -. + .P Successive invocations will put the frequent choices at the beginning. -. -. + + .SH SEE ALSO -.P + \fBremembering\fR(5) -. -. + + .SH AUTHORS -.P + .MT eu@euandre.org EuAndreh .ME and contributors. -. -. + + .SH BUGS + +.IP \(bu Report bugs to the .MT ~euandreh/public-inbox@lists.sr.ht mailing list .ME . -.br +Use the subject "\fC[remembering] BUG or TASK: <description>\fR". +.IP \(bu Browse bugs .UR https://euandreh.xyz/remembering/TODOs.html online .UE . -.br +.IP \(bu .UR https://euandreh.xyz/remembering/ -Home page +Homepage .UE . -.br -.UR https://lists.sr.ht/~euandreh/public-inbox?search=%5Bfallible%5D +.IP \(bu +.UR https://lists.sr.ht/~euandreh/public-inbox?search=%5Bremembering%5D Comments and discussions .UE . |