blob: dd51ef21064bb530ded4b116d1212093e60d7eff (
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
82
83
84
85
86
87
|
.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 to: ~euandreh/public-inbox@lists.sr.ht
.br
Home page: https://remembering.euandreh.xyz
|
