|
| 1 | +.TH NOTES 1 |
| 2 | +.SH NAME |
| 3 | +notes \ - Simple delightful note taking, with more unix and less lock-in. |
| 4 | +.SH SYNOPSIS |
| 5 | +.B notes |
| 6 | +\fICOMMAND\fR |
| 7 | +.SH DESCRIPTION |
| 8 | +.B notes |
| 9 | +is a simple command line tool that makes note taking simpler. |
| 10 | +When run without a command, the help screen will appear and will offer a brief |
| 11 | +description of availible commands. |
| 12 | + |
| 13 | +\fBnotes\fR will run the default editor for your distribution when opening a |
| 14 | +note. You can set $EDITOR in your shell to override it. |
| 15 | +\fBnotes\fR uses a configuration file located at \fB~/.config/notes/config\fR. |
| 16 | +This file overrides any settings in your rc file. |
| 17 | +.SH COMMANDS |
| 18 | +.TP |
| 19 | +.BR new ", " n " " \fR[\fINAME\fR] |
| 20 | +Open your text editor with a new note, with given name. |
| 21 | +If no name is given, a quick note will be created with an auto-generated |
| 22 | +name. |
| 23 | +.TP |
| 24 | +.BR find ", " f " " \fR[\fIPATTERN\fR] |
| 25 | +Searches for notes using the given pattern, returning all matches. If no |
| 26 | +pattern is given, returns every note. |
| 27 | +.TP |
| 28 | +.BR grep ", " g " " \fIPATTERN\fR |
| 29 | +Searches the contents of all notes for the given pattern. Returns all matches. |
| 30 | +.TP |
| 31 | +.BR search ", " s " " \fIPATTERN\fR |
| 32 | +Combination of find and grep. |
| 33 | +.TP |
| 34 | +.BR ls " " \fR[\fIDIRECTORY\fR] |
| 35 | +Lists all notes within \fIDIRECTORY\fR. Lists contents of $NOTES_DIRECTORY if |
| 36 | +no path is provided. |
| 37 | +.TP |
| 38 | +.BR open ", " o |
| 39 | +Opens $NOTES_DIRECTORY in your file explorer. |
| 40 | +.TP |
| 41 | +.BR open ", " o " "\fINAME\fR |
| 42 | +Opens note \fINAME\fR using your configured editor. \fINAME\fR can either be an |
| 43 | +absolute path or relative to $NOTES_DIRECTORY. |
| 44 | +.TP |
| 45 | +.BR rm " "\fR[\fB\-r\fR | \fB\-\-recursive\fR] " "\fINAME\fR |
| 46 | +Removes \fINAME\fR. If \-r or \-\-recursive is given, folders will be removed. |
| 47 | +.SH AUTHORS |
| 48 | +Notes was created by Tim Perry, who is still the maintainer. Numerous |
| 49 | +contributions have been submitted via pull requests on github. |
| 50 | +<\fBhttp://github.com/pimterry/notes\fR>. |
| 51 | + |
| 52 | +If you have a clone of notes.git, the output of \fBgit-shortlog\fR(1) and |
| 53 | +\fBgit-blame\fR(1) can show you the authors for specific parts of the project. |
| 54 | + |
0 commit comments