diff options
Diffstat (limited to 'remembering.5')
| -rw-r--r-- | remembering.5 | 89 |
1 files changed, 0 insertions, 89 deletions
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 <eu@euandre.org> -. -. -.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 |