feedwarrior

Slim, portable tooling for creating and distributing decentralized append logs
git clone git://git.defalsify.org/logwarrior.git
Info | Log | Files | Refs | README | LICENSE

feedwarrior.1 (3259B)


      1 .TH feedwarrior 1
      2 
      3 
      4 .SH NAME
      5 feedwarrior - Feeds, warrior style
      6 
      7 
      8 .SH DESCRIPTION
      9 
     10 Inspired by
     11 .UR https\://taskwarrior.org
     12 .UE ,
     13 this project seeks to simplify the creation and maintenance of engineering work logs.
     14 
     15 Entries of each individual log has core text content. Additionally, every entry may have any number of file attachments associated with it.
     16 
     17 
     18 .SH SYNOPSIS
     19 
     20 .SY feedwarrior
     21 add [ -c config_file] [ -z ] [ --task-id ] [ --task-uuid ] < -s subject >
     22 .YS
     23 
     24 .SY feedwarrior
     25 attach [ -c config_file] [ -z ] < -e entry > file
     26 .YS
     27 
     28 .SY feedwarrior
     29 create [ -c config_file] [ --alias name ]
     30 .YS
     31 
     32 .SY feedwarrior
     33 entry [ -c config_file] [ -z ] [ --task-id ] [ --task-uuid ] < -s subject > < path_to_content >
     34 .YS
     35 
     36 .SY feedwarrior
     37 list [ -c config_file]
     38 .YS
     39 
     40 .SY feedwarrior
     41 show [ -c config_file] < -l feed_id >
     42 .YS
     43 
     44 
     45 .SS Common options
     46 
     47 .TP
     48 .BI -l log_id
     49 Log id to operate on. May be the full uuid or the alias defined at creation time.
     50 
     51 .TP
     52 .BI -c config_file
     53 Load configuration from file.
     54 
     55 .SS Options for show
     56 
     57 .TP
     58 .B --headers
     59 Include multipart-headers in output.
     60 
     61 .SS Options for attach
     62 
     63 .TP
     64 .BI -e entry_id
     65 uuid of entry to attach file to.
     66 
     67 .SS Options for create
     68 
     69 .TP
     70 .BI --alias alias_id
     71 Create log id alias that may be used as argument to \fB-l\fP for future operations.
     72 
     73 
     74 .SS Options for add and entry
     75 
     76 .TP
     77 .BI -s subject
     78 Entry subject.
     79 
     80 .TP
     81 .BI --task-id id
     82 Associate the log entry with the given taskwarrior numeric id. This is a quasi-magical instruction which will resolve to the actual taskwarrior uuid.
     83 
     84 .TP
     85 .BI --task-uuid uuid
     86 Associate the log entry with the given taskwarrior numeric uuid.
     87 
     88 
     89 .SH ATTACHMENTS
     90 
     91 Both \fBfeedwarrior add\fP and \fBfeedwarrior entry\fP will return the created entry id.
     92 
     93 This id can be used further with the \fB-e\fP flag for attachments.
     94 
     95 Any file in any format may be an attachment. The feedwarrior tool imposes little if no restriction on what data qualifies as valid attachment data.
     96 
     97 
     98 .SH INTERACTIVE ENTRIES
     99 
    100 The \fBfeedwarrior add\fP command enables interactive definition of textual update entry contents.
    101 
    102 It will open an editor (at the moment hardcoded to \fBvim\fP) to receive the contents.
    103 
    104 
    105 .SH DATA STORE
    106 
    107 Log entries are stored as email-like MIME Multipart messages, wrapped in a json metadata structure.
    108 
    109 Only the default, simple filesystem structure is currently available as storage backend.
    110 
    111 
    112 .SH EXAMPLE
    113 
    114 .EX
    115 # create feed
    116 feedwarrior create --alias myfeed
    117 
    118 ¤ add log entry
    119 ENTRY=`feedwarrior -l myfeed entry -s "first update" /path/to/contents.txt
    120 
    121 # attach file to entry
    122 feedwarrior attach -e $ENTRY <attachment_file>
    123 
    124 ¤ interactively add log entry contents
    125 entry=`feedwarrior -l myfeed add -s "second update" 
    126 
    127 # show current state of feed (chronologically)
    128 feedwarrior -l myfeed show
    129 .EE
    130 
    131 
    132 .SH LICENSE
    133 
    134 This documentation and its source is licensed under the Creative Commons Attribution-Sharealike 4.0 International license.
    135 
    136 The source code of the tool this documentation describes is licensed under the GNU General Public License 3.0.
    137 
    138 
    139 .SH COPYRIGHT AND CONTACT
    140 
    141 .MT dev@holbrook.no
    142 Louis Holbrook
    143 .ME
    144 
    145 .UR https://holbrook.no
    146 .UE https://holbrook.no
    147 
    148 .P
    149 PGP: 59A844A484AC11253D3A3E9DCDCBD24DD1D0E001
    150 
    151 
    152 .SH SOURCE CODE
    153 
    154 https://holbrook.no/src/feedwarrior/log.html