jdonedb

storage format desctiption for jdone

Author: Oleksandr Gavenko <gavenkoa@gmail.com>
Organization: jdone project
Manual section:5
Manual group:jdonedb manual

Contents

Version

For jdone version: 0.6.

Source files are at revision: 0006dfebb720.

Package is at release state.

Build date: 2012-09-22.

Description

jdonedb is a format of .

Files

~/.jdonedb
Default path for djone storage root (DBROOT). You can specify another path by JDONE environment variable or by ~/.jdonerc configuration file. For details, see jdonerc(5).
<DBROOT>/VERSION
Storage format version.
<DBROOT>/current
Place for storing recent entries.
<DBROOT>/archive-YYYY-MM
Place for archiving old entries.
<DBROOT>/backup/YYYY-MM-DD/
Place for backup.

VERSION file format.

VERSION file holt version of storage format as number on single line:

NUMBER '\n'

Current version is 0 and seems there are no reason to increase it in future.

current file format.

current file store recent post from jdone client programs. It format inspired from diff format:

POSTS ::= POST | POSTS POST
POST ::= HEADER '\n' DATE '\n' TAGS MSG
HEADER ::= '================================================================'
DATE ::= 'date: ' YYYY '-' MM '-' DD ' ' HH ':' MI ':' SE '+' ZONE
TAGS ::= '' | TAGS TAG '\n'
TAG ::= TAGNAME  ': ' TAGVALUE '\n'
TAGNAME ::= [a-z-]+
TAGVALUE ::= [^\n]+
MSG ::= '' | MSG LINE '\n'
LINE := ' ' [^\n]+

So DATE is ISO 8601 date with space between date and time + 4 digits for timezone.

All line in message start with space which does not part of message.

Tags come before message. Noone tag name was choosen currently for any use except DATE tag.

Line oriented format allow easy processing of storage by wide range of tools. You can do this ever with sed(1)!

See Also

jdone(1), jdonerc(5)

Bugs

Probably lots, please post them to the mailing list (see Resources below) when you find them.

Author

Written by Oleksandr Gavenko <gavenkoa@gmail.com>

Resources

Home page: https://sourceforge.net/p/jdone/

Source code repository: https://sourceforge.net/p/jdone/code/

Mailing list: <jdone-general@lists.sourceforge.net>

Copying

Copyright (C) 2011 Oleksandr Gavenko. Feel free use this software for any purpose without any any warranty.