blob: abef6081a8801f46fc079b2383f32d5451ffaacc (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
.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 \fC$XDG_DATA_HOME/profile-name\fR if \fC$XDG_DATA_HOME\fR is defined.
Otherwise, it lives in \fC~/.local/share/remembering/profile-name\fR.
.P
Each line of the \fIPROFILE\fR contains three pieces of information:
.IP 1
the \fBrank\fR of the current entry;
.IP 2
the \fC:\fR separator;
.IP 3
the \fBentry\fR itself.
.
.P
The \fBrank\fR is a number, and the \fBentry\fR is all the text until the end of the line after the \fC:\fR separator:
.nf
0:an entry
0:banana
0:entry
0:something
0:zzz
.fi
.P
Above is an example of a \fIPROFILE\fR file where all the entries have the default
\fBrank\fR value: \fB0\fR.
.P
If the \fICOMMAND\fR runs and chooses \fCbanana\fR, the new \fIPROFILE\fR will be:
.nf
0:an entry
1:banana
0:entry
0:something
0:zzz
.fi
.P
The entries of the \fIPROFILE\fR are created and kept sorted.
\fBremembering\fR(1) 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
.P
\fBremembering\fR(1)
.
.
.SH AUTHORS
.P
.MT eu@euandre.org
EuAndreh
.ME
and contributors.
.
.
.SH BUGS
Report bugs to the
.MT ~euandreh/public-inbox@lists.sr.ht
mailing list
.ME .
.br
Browse bugs
.UR https://euandreh.xyz/remembering/TODOs.html
online
.UE .
.br
.UR https://euandreh.xyz/remembering/
Home page
.UE .
.br
.UR https://lists.sr.ht/~euandreh/public-inbox?search=[remembering]
Comments and discussions
.UE .
|
