note/doc/notesettings.1

.TH notesettings V1.0
.SH NAME
notesettings - settings management script for "note" a simple command-line note application
.SH SYNOPSIS
.B notesettings
.RB [options]
.SH DESCRIPTION
notesettings is used to set user preferences for note \- a simple, terminal\-based note taking application \- see
.BR note (1)
.P
The parameters to notesettings can be specified in any order and you can use as many or as few of them as you like.
.SH
PARAMETERS
.TP
.B -h
\- display help
.TP
.B  -e
\- set path to editor \- defaults to $EDITOR (the default editor for the terminal)
.TP
.B -b
\- whether or not to keep text editor backup files (0 = remove backup files, any other value signifies that backup are to be retained)  
IMPORTANT: 
 This behaviour currently only looks for and removes vim-style backup files ending with a ~ tilde character.
.TP
.B -p
\- path to preferred pager. defaults to /usr/bin/less.

.SH EXAMPLE USAGE
.TP
.B notesettings
.br
\- Lists the current settings.  Also creates default settings if settings.cfg is not present in /home/user/.note/
.TP
.B notesettings \-e $(which vim) \-b 1 \-p $(which w3m)
.br
\- This would set vim as the text editor for creating/editing notes. Backup files will be retained and w3m will be used as notes pager. These settings will be written to /home/user/.note/settings.cfg
.TP
.B notesettings \-h
.BR
\- Displays help/usage information for notesettings

.SH SEE ALSO
.BR note (1)
.SH LICENCE
notesettings 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