nt

simple note taker
git clone git://edryd.org/nt
Log | Files | Refs | LICENSE

nt.1 (2513B)


      1 .TH nt 1
      2 .SH NAME
      3 .PP
      4 nt  \- simple note taker
      5 .SH SYNOPSIS
      6 .PP
      7 \fB\fCnt\fR [\fB\-Dilvy\fP] [\fB\-f\fP \fIFILE\fP] [\fB\-e\fP \fINOTE\fP] [\fB\-d\fP \fINOTE\fP] [\fB\-t\fP [\fITAG\fP]] [\fB\-n\fP \fINUM\fP | \fB\-NUM\fP] [\fINOTE\fP ...]
      8 .SH DESCRIPTION
      9 .PP
     10 Simple note taker for the command line. To take a note simply run the command
     11 with the new note as arguments or from stdin. The note will be saved to a plain
     12 text file with each line being a note. The file is saved to the file either
     13 specified with \fB\-f\fP or in the default one from \fB\fCconfig.h\fR\&. Notes can have tags
     14 by prefixing the note with a tag followed by a colon. For example a note
     15 \fB\fCchores: take out trash\fR will have the tag \fB\fCchores\fR\&.
     16 .SH OPTIONS
     17 .PP
     18 \fB\-d\fP \fINOTE\fP
     19     Delete \fINOTE\fP from notes
     20 .PP
     21 \fB\-D\fP
     22     Delete all notes from \fIFILE\fP
     23 .PP
     24 \fB\-e\fP \fINOTE\fP
     25     Edit \fINOTE\fP with new text given through stdin
     26 .PP
     27 \fB\-f\fP \fIFILE\fP
     28     Load \fIFILE\fP instead of default one
     29 .PP
     30 \fB\-i\fP
     31     Force prompt to confirm action
     32 .PP
     33 \fB\-l\fP
     34     List notes
     35 .PP
     36 \fB\-n\fP \fINUM\fP, \fB\-NUM\fP
     37     List last \fINUM\fP notes
     38 .PP
     39 \fB\-t\fP [\fITAG\fP]
     40     Search for \fITAG\fP in notes, list all tags if no \fITAG\fP is given
     41 .PP
     42 \fB\-v\fP
     43     Print version info and exit
     44 .PP
     45 \fB\-y\fP
     46     Auto reply yes to confirmation prompts
     47 .SH USAGE
     48 .PP
     49 Add simple note and list it:
     50 .PP
     51 .RS
     52 .nf
     53 $ nt clean dishes
     54 $ nt \-l
     55 clean dishes
     56 .fi
     57 .RE
     58 .PP
     59 Create note in specified file:
     60 .PP
     61 .RS
     62 .nf
     63 $ nt \-f list take out trash
     64 $ nt \-f list \-l
     65 take out trash
     66 .fi
     67 .RE
     68 .PP
     69 Add more notes by running command again:
     70 .PP
     71 .RS
     72 .nf
     73 $ nt wash car
     74 $ nt \-l
     75 clean dishes
     76 wash car
     77 $ nt buy pie
     78 $ nt \-l
     79 clean dishes
     80 wash car
     81 buy pie
     82 .fi
     83 .RE
     84 .PP
     85 List just the \fINUM\fP most recent notes:
     86 .PP
     87 .RS
     88 .nf
     89 $ nt \-1
     90 buy pie
     91 $ nt \-n 1
     92 buy pie
     93 $ nt \-2
     94 buy pie
     95 wash car
     96 $ nt \-n 2
     97 buy pie
     98 wash car
     99 .fi
    100 .RE
    101 .PP
    102 Search notes through an external program:
    103 .PP
    104 .RS
    105 .nf
    106 $ nt -l | grep pie
    107 buy pie
    108 $ nt make pie
    109 $ nt -l | grep pie
    110 buy pie
    111 make pie
    112 .fi
    113 .RE
    114 .PP
    115 Remove given note:
    116 .PP
    117 .RS
    118 .nf
    119 $ nt \-yd buy pie
    120 $ nt \-l
    121 clean dishes
    122 wash car
    123 make pie
    124 .fi
    125 .RE
    126 .PP
    127 Edit note with new text given from stdin:
    128 .PP
    129 .RS
    130 .nf
    131 $ echo eat pie | nt \-e make pie
    132 $ nt \-l
    133 clean dishes
    134 wash car
    135 eat pie
    136 .fi
    137 .RE
    138 .PP
    139 Remove all notes:
    140 .PP
    141 .RS
    142 .nf
    143 $ nt \-yD
    144 $ nt \-l
    145 $ nt \-f list \-yD
    146 $ nt \-f list \-l
    147 .fi
    148 .RE
    149 .SH AUTHOR
    150 .PP
    151 Ed van Bruggen 
    152 \<edvb54@gmail.com\>
    153 .SH SEE ALSO
    154 .PP
    155 View source code at: 
    156 \<https://gitlab.com/edvb/nt\>
    157 .SH LICENSE
    158 .PP
    159 zlib License