diff options
| author | EuAndreh <eu@euandre.org> | 2021-01-21 22:03:10 -0300 |
|---|---|---|
| committer | EuAndreh <eu@euandre.org> | 2021-01-21 22:03:10 -0300 |
| commit | 6d5fd6dd0a1c0a927876f7786c406ce19c78c20e (patch) | |
| tree | f4d873b8b33d4acf9fbd5c9c34d490fda5fe9e73 /remembering.5 | |
| parent | Add COPYING (diff) | |
| download | remembering-6d5fd6dd0a1c0a927876f7786c406ce19c78c20e.tar.gz remembering-6d5fd6dd0a1c0a927876f7786c406ce19c78c20e.tar.xz | |
Add current working files
Diffstat (limited to '')
| -rw-r--r-- | remembering.5 | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/remembering.5 b/remembering.5 new file mode 100644 index 0000000..944af63 --- /dev/null +++ b/remembering.5 @@ -0,0 +1,83 @@ +.TH REMEMBERING 5 @DATE@ "remembering @VERSION@" +. +. +.SH NAME +remembering - file format of +.IR profiles. +. +. +.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/remember/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 +.IR profile. +. +. +.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 |