Revamp code under aux/

1 files changed, 106 insertions, 0 deletions

diff --git a/doc/remembering.es.5.in b/doc/remembering.es.5.in
index e69de29..3f78c56 100644
--- a/doc/remembering.es.5.in
+++ b/doc/remembering.es.5.in
@@ -0,0 +1,106 @@
+.\"*******************************************************************
+.\"
+.\" This file was generated with po4a. Translate the source file.
+.\"
+.\"*******************************************************************
+.TH REMEMBERING 5 @DATE@ "remembering @VERSION@" 
+
+
+.SH NAME
+
+remembering \- format of the \fIPROFILE\fP text file.
+
+
+.SH PROFILE
+
+The \fIPROFILE\fP is a text file, stored on
+\f(CR$XDG_DATA_HOME/remembering/profile\-name\fR if \f(CR$XDG_DATA_HOME\fR is
+defined.  Otherwise, it lives in
+\f(CR~/.local/share/remembering/profile\-name\fR.
+
+Each line of the \fIPROFILE\fP contains three pieces of information:
+
+.RS
+.IP 1
+the \fBrank\fP of the current entry;
+.IP 2
+the \f(CR:\fR separator;
+.IP 3
+the \fBentry\fP itself.
+.RE
+
+The \fBrank\fP is a number, and the \fBentry\fP is all the text until the end of
+the line after the \f(CR:\fR separator:
+
+.RS
+.nf
+0:an entry
+0:banana
+0:entry
+0:something
+0:zzz
+.fi
+.RE
+
+Above is an example of a \fIPROFILE\fP file where all the entries have the
+default \fBrank\fP value: \fB0\fP.
+
+If the \fICOMMAND\fP runs and chooses \f(CRbanana\fR, the new \fIPROFILE\fP will
+be:
+
+.RS
+.nf
+0:an entry
+1:banana
+0:entry
+0:something
+0:zzz
+.fi
+.RE
+
+Now the next time the \fICOMMAND\fP runs it will get \f(CRbanana\fR at the
+beginning of the list, and as new picks happen their weight will increase,
+and will keep going up in priority.
+
+The entries of the \fIPROFILE\fP are created and kept sorted.
+\fBremembering\fP(1) expects to always find sorted entries in the \fIPROFILE\fP.
+
+The current raking algorithm increments entries as a simple counter.  Every
+time an entry is picked, its ranked is incremented in the \fIPROFILE\fP.
+
+
+.SH "SEE ALSO"
+
+\fBremembering\fP(1)
+
+
+.SH AUTHORS
+
+.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 .
+Use the subject "\f(CR[remembering] BUG or TASK:
+<description>\fR".
+.IP \(bu
+Browse bugs
+.UR https://euandreh.xyz/remembering/TODOs.html
+online
+.UE .
+.IP \(bu
+.UR https://euandreh.xyz/remembering/en/
+Homepage
+.UE .
+.IP \(bu
+.UR https://lists.sr.ht/~euandreh/public\-inbox?search=%5Bremembering%5D
+Comments and discussions
+.UE .