From 4441f2f6a9d33e58708c143e8397d69a75610421 Mon Sep 17 00:00:00 2001
From: EuAndreh <eu@euandre.org>
Date: Sat, 19 Jun 2021 17:18:14 -0300
Subject: Setup base i18n infrastructure

---
 doc/remembering.en.5 | 94 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 94 insertions(+)
 create mode 100644 doc/remembering.en.5

(limited to 'doc/remembering.en.5')

diff --git a/doc/remembering.en.5 b/doc/remembering.en.5
new file mode 100644
index 0000000..c9b482b
--- /dev/null
+++ b/doc/remembering.en.5
@@ -0,0 +1,94 @@
+.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 \f(CR$XDG_DATA_HOME/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\fR contains three pieces of information:
+
+.RS
+.IP 1
+the \fBrank\fR of the current entry;
+.IP 2
+the \f(CR:\fR separator;
+.IP 3
+the \fBentry\fR itself.
+.RE
+
+The \fBrank\fR is a number, and the \fBentry\fR 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\fR file where all the entries have the default \fBrank\fR value: \fB0\fR.
+
+If the \fICOMMAND\fR runs and chooses \f(CRbanana\fR, the new \fIPROFILE\fR will be:
+
+.RS
+.nf
+0:an entry
+1:banana
+0:entry
+0:something
+0:zzz
+.fi
+.RE
+
+Now the next time the \fICOMMAND\fR 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\fR are created and kept sorted.
+\fBremembering\fR(1) expects to always find sorted entries in the \fIPROFILE\fR.
+
+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
+
+\fBremembering\fR(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/
+Homepage
+.UE .
+.IP \(bu
+.UR https://lists.sr.ht/~euandreh/public\-inbox?search=%5Bremembering%5D
+Comments and discussions
+.UE .
-- 
cgit v1.2.3