From 710b00da87155c5c3446f664970a8700fbfcaa96 Mon Sep 17 00:00:00 2001 From: EuAndreh Date: Wed, 17 Feb 2021 21:52:54 -0300 Subject: Move manpages to doc/ --- doc/remembering.1 | 97 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/remembering.5 | 89 ++++++++++++++++++++++++++++++++++++++++++++++++++ remembering.1 | 97 ------------------------------------------------------- remembering.5 | 89 -------------------------------------------------- 4 files changed, 186 insertions(+), 186 deletions(-) create mode 100644 doc/remembering.1 create mode 100644 doc/remembering.5 delete mode 100644 remembering.1 delete mode 100644 remembering.5 diff --git a/doc/remembering.1 b/doc/remembering.1 new file mode 100644 index 0000000..d37b4ae --- /dev/null +++ b/doc/remembering.1 @@ -0,0 +1,97 @@ +.TH REMEMBERING 1 @DATE@ "remembering @VERSION@" +. +. +.SH NAME +remembering - sort list using previous choices as weight +. +. +.SH SYNOPSYS +.B remembering +.RB -p +.IR profile +.RB -c +.IR command +. +. +.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. +. +. +.SH OPTIONS +. +.TP +.B -c +The +.IR command +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. +. +.TP +.B -h +Show short help text. +. +.TP +.B -V +Show version number. +. +. +.SH EXAMPLES +.P +List current directory and feed it to +.IR fzf +via +.B remembering: +.RS +.EX + +$ ls | remembering -p fzf-ls -c fzf +.EE +.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: +.RS +.EX + +$ dmenu_path | remembering -p dmenu-exe -c 'dmenu' | sh +.EE +.RE +. +.P +Successive invocations will put the frequent choices at the beginning. +. +. +.SH SEE ALSO +.IR remembering (5) +. +. +.SH AUTHORS +EuAndreh +. +. +.SH BUGS +Report bugs and send patches to: ~euandreh/public-inbox@lists.sr.ht +.br +Home page: https://remembering.euandreh.xyz +.br +Source code: https://git.euandreh.xyz/remembering diff --git a/doc/remembering.5 b/doc/remembering.5 new file mode 100644 index 0000000..6f3f926 --- /dev/null +++ b/doc/remembering.5 @@ -0,0 +1,89 @@ +.TH REMEMBERING 5 @DATE@ "remembering @VERSION@" +. +. +.SH NAME +remembering - format of +.IR profile +text file. +. +. +.SH PROFILE +The +.IR profile +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. +. +.P +The +.B rank +is a number that, and the +.B entry +is all the text until the end of the line: +.RS +.EX + +0:an entry +0:banana +0:entry +0:something +0:zzz +.EE +.RE +.P +Above is an example of a +.IR profile +file where all the entries have the default +.B rank +value: +.B 0. +.P +If the +.IR command +runs and chooses "banana", the new +.IR profile +will be: +.RS +.EX + +0:an entry +1:banana +0:entry +0:something +0:zzz +.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. +.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 +.IR remembering (1) +. +. +.SH AUTHORS +EuAndreh +. +. +.SH BUGS +Report bugs and send patches to: ~euandreh/public-inbox@lists.sr.ht +.br +Home page: https://remembering.euandreh.xyz +.br +Source code: https://git.euandreh.xyz/remembering diff --git a/remembering.1 b/remembering.1 deleted file mode 100644 index d37b4ae..0000000 --- a/remembering.1 +++ /dev/null @@ -1,97 +0,0 @@ -.TH REMEMBERING 1 @DATE@ "remembering @VERSION@" -. -. -.SH NAME -remembering - sort list using previous choices as weight -. -. -.SH SYNOPSYS -.B remembering -.RB -p -.IR profile -.RB -c -.IR command -. -. -.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. -. -. -.SH OPTIONS -. -.TP -.B -c -The -.IR command -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. -. -.TP -.B -h -Show short help text. -. -.TP -.B -V -Show version number. -. -. -.SH EXAMPLES -.P -List current directory and feed it to -.IR fzf -via -.B remembering: -.RS -.EX - -$ ls | remembering -p fzf-ls -c fzf -.EE -.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: -.RS -.EX - -$ dmenu_path | remembering -p dmenu-exe -c 'dmenu' | sh -.EE -.RE -. -.P -Successive invocations will put the frequent choices at the beginning. -. -. -.SH SEE ALSO -.IR remembering (5) -. -. -.SH AUTHORS -EuAndreh -. -. -.SH BUGS -Report bugs and send patches to: ~euandreh/public-inbox@lists.sr.ht -.br -Home page: https://remembering.euandreh.xyz -.br -Source code: https://git.euandreh.xyz/remembering diff --git a/remembering.5 b/remembering.5 deleted file mode 100644 index 6f3f926..0000000 --- a/remembering.5 +++ /dev/null @@ -1,89 +0,0 @@ -.TH REMEMBERING 5 @DATE@ "remembering @VERSION@" -. -. -.SH NAME -remembering - format of -.IR profile -text file. -. -. -.SH PROFILE -The -.IR profile -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. -. -.P -The -.B rank -is a number that, and the -.B entry -is all the text until the end of the line: -.RS -.EX - -0:an entry -0:banana -0:entry -0:something -0:zzz -.EE -.RE -.P -Above is an example of a -.IR profile -file where all the entries have the default -.B rank -value: -.B 0. -.P -If the -.IR command -runs and chooses "banana", the new -.IR profile -will be: -.RS -.EX - -0:an entry -1:banana -0:entry -0:something -0:zzz -.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. -.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 -.IR remembering (1) -. -. -.SH AUTHORS -EuAndreh -. -. -.SH BUGS -Report bugs and send patches to: ~euandreh/public-inbox@lists.sr.ht -.br -Home page: https://remembering.euandreh.xyz -.br -Source code: https://git.euandreh.xyz/remembering -- cgit v1.2.3