From 4441f2f6a9d33e58708c143e8397d69a75610421 Mon Sep 17 00:00:00 2001 From: EuAndreh Date: Sat, 19 Jun 2021 17:18:14 -0300 Subject: Setup base i18n infrastructure --- doc/remembering.pt.5 | 105 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 105 insertions(+) create mode 100644 doc/remembering.pt.5 (limited to 'doc/remembering.pt.5') diff --git a/doc/remembering.pt.5 b/doc/remembering.pt.5 new file mode 100644 index 0000000..d261249 --- /dev/null +++ b/doc/remembering.pt.5 @@ -0,0 +1,105 @@ +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH REMEMBERING 5 @DATE@ "remembering @VERSION@" + + +.SH NOME + +remembering \- format of the \fIPROFILE\fP text file. + + +.SH PROFILE + +The \fIPROFILE\fP 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\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 "VEJA TAMBÉM" + +\fBremembering\fP(1) + + +.SH AUTORES + +.MT eu@euandre.org +EuAndreh +.ME +e colaboradores. + + +.SH BUGS + +.IP \(bu +Relate bugs na +.MT ~euandreh/public\-inbox@lists.sr.ht +lista de discussão +.ME . +Use o assunto "\f(CR[remembering] BUG ou TASK: +\fR". +.IP \(bu +Veja os bugs +.UR https://euandreh.xyz/remembering/TODOs.html +online +.UE . +.IP \(bu +.UR https://euandreh.xyz/remembering/ +Página inicial +.UE . +.IP \(bu +.UR https://lists.sr.ht/~euandreh/public\-inbox?search=%5Bremembering%5D +Comentários e discussões +.UE . -- cgit v1.2.3