diff options
Diffstat (limited to 'doc/remembering.5')
| -rw-r--r-- | doc/remembering.5 | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/doc/remembering.5 b/doc/remembering.5 index 9404225..abef608 100644 --- a/doc/remembering.5 +++ b/doc/remembering.5 @@ -2,18 +2,23 @@ . . .SH NAME -remembering - format of \fIPROFILE\fB text file. +remembering - format of the \fIPROFILE\fR text file. . . .SH PROFILE -The \fIPROFILE\fR 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. +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 two pieces of information: the \fBrank\fR of the current entry, and the \fBentry\fR itself. +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 that, and the \fBentry\fR is all the text until the end of the line: +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 @@ -26,7 +31,7 @@ The \fBrank\fR is a number that, and the \fBentry\fR is all the text until the e 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 "banana", the new \fIPROFILE\fR will be: +If the \fICOMMAND\fR runs and chooses \fCbanana\fR, the new \fIPROFILE\fR will be: .nf 0:an entry |