diff options
Diffstat (limited to 'blobs/stitch/0.0.1/stitch.1')
| -rw-r--r-- | blobs/stitch/0.0.1/stitch.1 | 131 |
1 files changed, 131 insertions, 0 deletions
diff --git a/blobs/stitch/0.0.1/stitch.1 b/blobs/stitch/0.0.1/stitch.1 new file mode 100644 index 0000000..4351d5d --- /dev/null +++ b/blobs/stitch/0.0.1/stitch.1 @@ -0,0 +1,131 @@ +.\" Pipe this output to groff -m man -K utf8 -T utf8 | less -R +.\" +.mso an.tmac +.TH "STITCH" 1 "" "Stitch 0.1 ALPHA" "Stitch Manual" +.\" Disable hyphenation and ragged-right +.nh +.ad l +.SH NAME +.P +stitch \N'45' write notes seperately and compose +.SH SYNOPSIS +.P +\fBstitch\fR [\fB\N'45'\N'45'tag\fR=\fITAG\fR] [\fIOPTION\fR]… +.SH BUGS +.P +Email bug reports to marc@mccd\N'46'space +.SH AUTHORS +.P +Marc Coquand (mccd\N'46'space) +.SH DESCRIPTION +.P +Stitch is a minimal note and todo composing tool inspired by Howm for Emacs\N'46' It works with any CLI editor and file format\N'46' +.P +Stitch comes preconfigured to handle an org\N'45'esque file format, but can be reconfigured to handle any file format you want (SEE ENVIRONMENT)\N'46' +.P +To set up, you will need to set STITCH_DIRECTORY (SEE ENVIRONMENT) at minimum\N'46' Stitch does not come with any built\N'45'in note\N'45'capturing tool, but you can easily set one up on your own (SEE EXAMPLES)\N'46' +.P +Stitch currently only works with a system where you have one file per note\N'46' +.P +When you enter the program for the first time, press \N'39'?\N'39' to see the list of keybindings\N'46' +.SH OPTIONS +.TP 4 +\fB\N'45't\fR \fITAG\fR, \fB\N'45'\N'45'tag\fR=\fITAG\fR +Search entries for a given tag\N'46' +.SH COMMON OPTIONS +.TP 4 +\fB\N'45'\N'45'help\fR[=\fIFMT\fR] (default=\fBauto\fR) +Show this help in format \fIFMT\fR\N'46' The value \fIFMT\fR must be one of \fBauto\fR, \fBpager\fR, \fBgroff\fR or \fBplain\fR\N'46' With \fBauto\fR, the format is \fBpager\fR or \fBplain\fR whenever the \fBTERM\fR env var is \fBdumb\fR or undefined\N'46' +.TP 4 +\fB\N'45'\N'45'version\fR +Show version information\N'46' +.SH EXIT STATUS +.P +\fBstitch\fR exits with: +.TP 4 +0 +on success\N'46' +.TP 4 +123 +on indiscriminate errors reported on standard error\N'46' +.TP 4 +124 +on command line parsing errors\N'46' +.TP 4 +125 +on unexpected internal errors (bugs)\N'46' +.SH ENVIRONMENT +.P +These environment variables affect the execution of \fBstitch\fR: +.TP 4 +\fBSTITCH_DIRECTORY\fR +Directory where Stitch should search for notes\N'46' Needs to be set in order for the program to work\N'46' Must be absolute path, I\N'46'E /home/bob/notes +.TP 4 +\fBSTITCH_DONE\fR +Pattern for DONE items\N'46' Used for substitution\N'46' (Default "* DONE") +.TP 4 +\fBSTITCH_DONE_REGEXP\fR +Regexp used by grep to find DONE items\N'46' Needs to be double escaped for OCaml\N'46' (Default "^\N'92'* DONE") +.TP 4 +\fBSTITCH_GREP_CMD\fR +Grep command to use (defaults to "grep")\N'46' Stitch also works well with ugrep, which greatly speeds up the program\N'46' +.TP 4 +\fBSTITCH_HEADLINE_PATTERN\fR +Pattern to use for headlines\N'46' (Default "* ") +.TP 4 +\fBSTITCH_HEADLINE_PATTERN_REGEXP\fR +Pattern to use by grep to fetch headlines\N'46' Needs to be double escaped for OCaml\N'46' (Default "^\N'92'* ") +.TP 4 +\fBSTITCH_TAG_PATTERN\fR +Pattern used by grep to find tags\N'46' (Default ":[a\N'45'z\N'45']+:", matches :a\N'45'tag: +.TP 4 +\fBSTITCH_TODO\fR +Pattern for TODOS\N'46' Used for substitution\N'46' (Default "* TODO") +.TP 4 +\fBSTITCH_TODO_REGEXP\fR +Regexp used by grep to find TODO items\N'46' Needs to be double escaped for OCaml\N'46' (Default "^\N'92'* TODO") +.SH EXAMPLES +.P +To get started, start by setting up a note directory in your shell profile +.P +.nf +export STITCH_DIRECTORY=/home/bob/notes +.fi +.P +Stitch does not specify anything on how to capture your notes, but you can add the following in your profile to have a basic note capture command +.P +.nf +function capture { + NEW_NOTE="$STITCH_DIRECTORY/$(date +\N'39'%y\N'45'%m\N'45'%d\N'46'%H:%M\N'46'%S\N'39')\N'46'org" + echo \N'39'* \N'39' >> $NEW_NOTE + $EDITOR "$NEW_NOTE" +1:3 " +} + +.fi +.P +With that, you can begin to capture your notes and they will be displayed in reverse chronological order in stitch\N'46' You can add tags, for example :journal: and :work:\N'46' +.P +Once added, you can start viewing your notes in Stitch\N'46' So if you added a few journal notes, you can view them with +.P +.nf +stitch \N'45't :journal: +.fi +.P +If you press s, you will see toggle to see all notes stitched together\N'46' You can see all commands with \N'39'?\N'39' +.P +You can also launch stitch without arguments to see all\N'46' +.P +To set up TODO capturing, you can add a command to your shell profile to capture TODO items +.P +.nf +function todo { + NEW_NOTE="$STITCH_DIRECTORY/$(date +\N'39'%y\N'45'%m\N'45'%d\N'46'%H:%M\N'46'%S\N'39')\N'46'org" + echo \N'39'* TODO \N'39' >> $NEW_NOTE + $EDITOR "$NEW_NOTE" +1 +} +.fi +.P +After that, you can capture a few TODO items, and you will be able to view them if you press 2\N'46' You can see done items if you press 3\N'46' Press \N'39'?\N'39' to see how to toggle the todo items\N'46' +.SH CREDIT +.P +Stitch was inspired by the note\N'45'taking tool Howm for EMacs by HIRAOKA Kazuyuki\N'46'
\ No newline at end of file |