123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384 |
- .TH note V1.0
- .SH NAME
- note - A simple command-line note taking application
- .SH SYNOPSIS
- .B note
- .RB [options] [filename/s]
- .SH DESCRIPTION
- note is a simple command\-line based note\-taking application.
- .P
- Notes are saved in the directory /home/user/.note/notes/
- .P
- Configuration options are saved in /home/user/.note/settings.cfg
- .P
- Configuration settings can be changed by manually editing /home/user/.note/settings.cfg or by running note's configuration script
- .BR notesettings (1)
- .SH USAGE
- .TP
- .B note
- .BR
- Lists all notes in the users notes directory (/home/user/.note/notes/)
- .TP
- .B note {file\-name}
- .BR
- Create a new note, or open an existing one in the text editor
- .TP
- .B note \-r {old\-file\-name} {new\-file\-name}
- .BR
- Rename an existing file
- .TP
- .B note \-d {filename1} {filename2} ...
- .BR
- Deletes all files listed after the \-d command
- .TP
- .B note \-la
- .BR
- Displays a detailed list of notes, sorted alphabetically
- .TP
- .B note \-ls
- .BR
- Displays a detailed list of notes, sorted by size
- .TP
- .B note \-v {filename}
- Opens the specified note in the pager/viewer application {default pager is less} see man-page for note configuration script
- .BR notesettings (1)
- to see how to change the default pager.
- .TP
- .B note -R {file1} {file2} {...}
- .BR
- Read notes aloud via espeak
- .TP
- .B note --backup
- .BR
- Back-up all notes and configuration - Creates a file in the users home directory called note-backup-YYYY-MM-DD.tar.gz - where YYYY-MM-DD is todays date (year, month, day)
- .TP
- .B note -s word
- .BR
- List notes containing "word" (case insensitive)
- .TP
- .B note -S word
- .BR
- List notes containing "word" (case sensitive)
- .TP
- .B note \-h
- .BR
- Displays help
- .SH SEE ALSO
- .BR notesettings (1)
- .SH LICENCE
- note is licensed under the GNU GPLV3 license.
- .TP
- This man page is licensed under the GNU FDL (Free documentation license) v1.3.
- Permission is granted to copy, distribute and/or modify this document
- under the terms of the GNU Free Documentation License, Version 1.3
- or any later version published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
- A copy of the license is included in the section entitled "GNU
- Free Documentation License".
- .SH COPYRIGHT
- .B ©2013-2023
- Jason Trunks < https://notabug.org/JasKinasis/note >
- .BR
|