diff options
| -rw-r--r-- | doc/remembering.1 | 78 | ||||
| -rw-r--r-- | doc/remembering.5 | 60 |
2 files changed, 74 insertions, 64 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 . diff --git a/doc/remembering.5 b/doc/remembering.5 index 6fe7348..b130008 100644 --- a/doc/remembering.5 +++ b/doc/remembering.5 @@ -1,23 +1,27 @@ .TH REMEMBERING 5 @DATE@ "remembering @VERSION@" -. -. + + .SH NAME + remembering - format of the \fIPROFILE\fR text file. -. -. + + .SH PROFILE + The \fIPROFILE\fR is a text file, stored on \fC$XDG_DATA_HOME/profile-name\fR if \fC$XDG_DATA_HOME\fR is defined. Otherwise, it lives in \fC~/.local/share/remembering/profile-name\fR. -.P + Each line of the \fIPROFILE\fR contains three pieces of information: + +.RS .IP 1 the \fBrank\fR of the current entry; .IP 2 the \fC:\fR separator; .IP 3 the \fBentry\fR itself. -. -.P +.RE + The \fBrank\fR is a number, and the \fBentry\fR is all the text until the end of the line after the \fC:\fR separator: .nf @@ -27,10 +31,9 @@ The \fBrank\fR is a number, and the \fBentry\fR is all the text until the end of 0:something 0:zzz .fi -.P -Above is an example of a \fIPROFILE\fR file where all the entries have the default -\fBrank\fR value: \fB0\fR. -.P + +Above is an example of a \fIPROFILE\fR file where all the entries have the default \fBrank\fR value: \fB0\fR. + If the \fICOMMAND\fR runs and chooses \fCbanana\fR, the new \fIPROFILE\fR will be: .nf @@ -40,44 +43,47 @@ If the \fICOMMAND\fR runs and chooses \fCbanana\fR, the new \fIPROFILE\fR will b 0:something 0:zzz .fi -.P + Now the next time the \fICOMMAND\fR runs it will get \fCbanana\fR at the beginning of the list, and as new picks happen their weight will increase, and will keep going up in priority. -.P + 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. -. -. + + .SH SEE ALSO -.P + \fBremembering\fR(1) -. -. + + .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 . |