From e6510c83a2146436778fbd905bf6597eb187ca4f Mon Sep 17 00:00:00 2001 From: EuAndreh Date: Sat, 26 Jun 2021 18:15:33 -0300 Subject: Makefile, README.md: Adapt to changes in aux/ --- doc/remembering.eo.1 | 231 --------------------------------------------------- 1 file changed, 231 deletions(-) delete mode 100644 doc/remembering.eo.1 (limited to 'doc/remembering.eo.1') diff --git a/doc/remembering.eo.1 b/doc/remembering.eo.1 deleted file mode 100644 index 13a674f..0000000 --- a/doc/remembering.eo.1 +++ /dev/null @@ -1,231 +0,0 @@ -.\"******************************************************************* -.\" -.\" This file was generated with po4a. Translate the source file. -.\" -.\"******************************************************************* -.TH REMEMBERING 1 @DATE@ "remembering @VERSION@" - - -.SH NOMO - -remembering \- sort list from \fISTDIN\fP using past choices as weight. - - -.SH RESUMO - -\fBremembering\fP \fB\-p\fP \fIPROFILE\fP \fB\-c\fP \fICOMMAND\fP - - -.SH PRISKRIBO - -\fBremembering\fP takes a command that chooses an option as its behaviour, such -as \fBfzf\fP(1) or \fBdmenu\fP(1), and \fIremembers\fP what option is chosen, and as -it is used, will put the most used choices at the beginning of the list. - -\fBremembering\fP reads from STDIN and writes to STDOUT. It expects STDIN to -be sorted. - - -.SH EBLOJ - -.TP -\fB\-c\fP \fICOMMAND\fP -The \fICOMMAND\fP to be executed, reading from standard input (STDIN). - -.TP -\fB\-p\fP \fIPROFILE\fP -The name of the \fIPROFILE\fP where to look up and store raking data. - -.TP -\fB\-h\fP, \fB\-\-help\fP -Show short help text. - -.TP -\fB\-V\fP, \fB\-\-version\fP -Montras versian numeron. - - -.SH EKZEMPLOJ - -List current directory and feed it to \fBfzf\fP(1) via \fBremembering\fP: - -.RS -.nf -$ ls | remembering \-p fzf\-ls \-c fzf -.fi -.RE - - -Lists all executables available in \fI$PATH\fP, and feed those to \fBdmenu\fP(1) -via \fBremembering\fP, and execute with \fBsh\fP(1) the choice picked: - -.RS -.nf -$ dmenu_path | remembering \-p dmenu\-exe \-c 'dmenu' | sh -.fi -.RE - -.P -Successive invocations will put the frequent choices at the beginning. - -.SS "Simulation of an interactive session" - -Below is a simulation of an interactive session, comparing the usage of -plain \fBfzf\fP(1) against composing it with \fBremembering\fP: - -.RS -.nf -$ mkdir \-p example/ -$ cd example/ -$ touch a b c d e -$ ls -a b c d e -$ ls | fzf -.fi -.RE - -We begin creating a sample directory called "\f(CRexample/\fR", we cd into -it and create 5 empty files: a, b, c, d and e. - -\f(CRls\fR can list the directory for us, in this case in alphabetical -order. - -When we pipe the output of \f(CRls\fR into \fBfzf\fP(1), we are give given its -prompt to pick one option: - -.RS -.nf - e - d - c - b -> a - 5/5 -> -.fi -.RE - -Here \fBfzf\fP(1) lists the items it gets from \fISTDIN\fP in the order that it -was given, and starts at the first one, "a". - -Once we type "d" and press return, the output of \fBfzf\fP(1) is the choice: - -.RS -.nf -$ ls | fzf -d -.fi -.RE - -Now if we run the same command again, we'll be given the same options, in -the same order: - -.RS -.nf -$ ls | fzf - - e - d - c - b -> a - 5/5 -> - -$ ls | fzf -d -.fi -.RE - -\fBfzf\fP(1) is doing what it is told to: making a prompt with the options -given to it from \fISTDIN\fP, in the order it was given. - -In order to have our past choices show up in the beginning of the list, we -can compose \fBfzf\fP(1) with \fBremembering\fP: - -.RS -.nf -$ ls | remembering \-p tutorial\-example \-c 'fzf' - - e - d - c - b -> a - 5/5 -> - -$ ls | remembering \-p tutorial\-example \-c 'fzf' -d -.fi -.RE - -So far we get the exact same behaviour, but saying extra things. We tell -\fBremembering\fP that we want this specific \fIPROFILE\fP to be called -"\f(CRtutorial\-example\fR", and we give \fBremembering\fP the \f(CR'fzf'\fR -command to be ran. - -From now on if we run the exact same command again, \fBremembering\fP will -\fIremember\fP that the last choice was "d", and put it in the beginning of the -list, which \fBfzf\fP(1) happily displays in the order it was given: - -.RS -.nf -$ ls | remembering \-p tutorial\-example \-c 'fzf' - - e - c - b - a -> d - 5/5 -> - -$ ls | remembering \-p tutorial\-example \-c 'fzf' -d -.fi -.RE - -This time the "d" option was already the first one, and we can just press -return to get it as the output value from the command. - -This example used \fBfzf\fP(1) as the \fICOMMAND\fP given to \fBremembering\fP, but -you can give to the \fB\-c\fP option anything that reads from \fISTDIN\fP, picks a -line and writes to \fBSTDOUT\fP. - - -.SH "VIDU ANKAŬ" - -\fBremembering\fP(5) - - -.SH AŬTOROJ - -.MT eu@euandre.org -EuAndreh -.ME -kaj la kontribuuloj. - - -.SH MISFUNKCIOJ - -.IP \(bu -Raportu misfunkcioj al la -.MT ~euandreh/public\-inbox@lists.sr.ht -dissendolisto -.ME . -Uzu la subjekton "\f(CR[remembering] BUG aŭ TASK: -\fR". -.IP \(bu -Foliumu misfunkcioj -.UR https://euandreh.xyz/remembering/TODOs.html -rete -.UE . -.IP \(bu -.UR https://euandreh.xyz/remembering/ -Ĉefpaĝo -.UE . -.IP \(bu -.UR https://lists.sr.ht/~euandreh/public\-inbox?search=%5Bremembering%5D -Komentoj kaj diskutoj -.UE . -- cgit v1.2.3