Update manpages
This commit is contained in:
dmarakom6
parent
ef9e1d1552
commit
53cfe1cb36
12 changed files with 312 additions and 123 deletions
|
|
@ -1,19 +1,36 @@
|
|||
.\" Manpage for delnote
|
||||
.\" Manpage for shellnotes-delnote.
|
||||
.\" Contact dmarakom@gmail.com to correct errors or typos.
|
||||
.TH man 8 "30/12/2020" "" "delnote man page"
|
||||
|
||||
.TH delnote 1
|
||||
.SH NAME
|
||||
|
||||
shellnotes-delnote \- Delete a note in your notes folder.
|
||||
|
||||
.SH SYNOPSIS
|
||||
delnote [FILENAME] [OPTION]
|
||||
.PP
|
||||
.B delnote
|
||||
.IR [FILE...]
|
||||
.PP
|
||||
.B delnote
|
||||
.IR [FILE...]
|
||||
[\fIOPTION\fR]
|
||||
.PP
|
||||
.B delnote
|
||||
[\fIOPTION\fR]
|
||||
|
||||
.SH DESCRIPTION
|
||||
delnote() finds and removes the desired note or all the notes from your notes folder.
|
||||
|
||||
.B delnote
|
||||
finds and removes the desired note (or all the notes) from your notes folder.
|
||||
|
||||
.SH OPTIONS
|
||||
[FILENAME] \- The name of the note to delete.
|
||||
\fR \or\fR
|
||||
[-all] \- Delete all notes.
|
||||
\fR \or\fR
|
||||
leave a blank parameter ("delnote") and shellnotes will ask you for the filename with an input.
|
||||
.SH BUGS
|
||||
If the default path for delnote() is not valid, the program is likely to return an error.
|
||||
|
||||
.TP
|
||||
.BR \-all
|
||||
Delete all notes.
|
||||
|
||||
.\".SH BUGS
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
Dimitris Marakomihelakis (dmarakom@gmail.com)
|
||||
|
|
@ -1,16 +1,30 @@
|
|||
.\" Manpage for findmisplacednote
|
||||
.\" Manpage for shellnotes-findmisplacednote.
|
||||
.\" Contact dmarakom@gmail.com to correct errors or typos.
|
||||
.TH man 8 "30/12/2020" "" "findmisplacednote man page"
|
||||
|
||||
.TH findmisplacednote 1
|
||||
.SH NAME
|
||||
|
||||
shellnotes-findmisplacednote \- Find a note missing from your notes folder.
|
||||
|
||||
.SH SYNOPSIS
|
||||
findmisplacednote [FILENAME]
|
||||
.PP
|
||||
.B findmisplacednote
|
||||
.IR [FILE...]
|
||||
|
||||
.SH DESCRIPTION
|
||||
findmisplacednote() uses find (do "man find") to check if a note exists in the user's system. This command must be run only when findnote (do "man findnote") doesn't result in an existing note.
|
||||
.SH OPTIONS
|
||||
[FILENAME] \- The name of the note.
|
||||
leave a blank parameter ("findmisplacednote") and shellnotes will ask you for the filename with an input.
|
||||
.SH BUGS
|
||||
No known bugs.
|
||||
|
||||
.B findmisplacednote
|
||||
uses find (do "man find") to check if a note exists in the user's system.
|
||||
This command must be run only when findnote (do "man findnote") doesn't result in an existing note.
|
||||
|
||||
.\".SH OPTIONS
|
||||
|
||||
.\".SH BUGS
|
||||
|
||||
.\".TP
|
||||
.\".BR \Withoutstringbug ", " \-wsBug ", " \72
|
||||
.\"If there are no matches in the input, "notegrep -ws" will display the file as is.
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
Dimitris Marakomihelakis (dmarakom@gmail.com)
|
||||
|
|
@ -1,16 +1,30 @@
|
|||
.\" Manpage for findnote
|
||||
.\" Manpage for shellnotes-findnote.
|
||||
.\" Contact dmarakom@gmail.com to correct errors or typos.
|
||||
.TH man 8 "30/12/2020" "" "findnote man page"
|
||||
|
||||
.TH findnote 1
|
||||
.SH NAME
|
||||
|
||||
shellnotes-findnote \- Find a note in your notes folder.
|
||||
|
||||
.SH SYNOPSIS
|
||||
findnote [FILENAME]
|
||||
.PP
|
||||
.B findnote
|
||||
.IR [FILE...]
|
||||
|
||||
.SH DESCRIPTION
|
||||
findnote() checks if a note exists in your notes folder.
|
||||
.SH OPTIONS
|
||||
[FILENAME] \- The name of the note.
|
||||
leave a blank parameter ("findnote") and shellnotes will ask you for the filename with an input.
|
||||
.SH BUGS
|
||||
No known bugs.
|
||||
|
||||
.B findnote
|
||||
checks if a note exists in your notes folder using the "find" command. This is a handy command for users with numerous notes who would just like to know whether a note actually exists in their notes folder.
|
||||
|
||||
.\".SH OPTIONS
|
||||
|
||||
|
||||
.\".SH BUGS
|
||||
|
||||
.\".TP
|
||||
.\".BR \Withoutstringbug ", " \-wsBug ", " \72
|
||||
.\"If there are no matches in the input, "notegrep -ws" will display the file as is.
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
Dimitris Marakomihelakis (dmarakom@gmail.com)
|
||||
|
|
@ -1,18 +1,43 @@
|
|||
.\" Manpage for listnotes.
|
||||
.\" Manpage for shellnotes-listnotes.
|
||||
.\" Contact dmarakom@gmail.com to correct errors or typos.
|
||||
.TH man 8 "30/12/2020" "" "listnotes man page"
|
||||
|
||||
.TH listnotes 1
|
||||
.SH NAME
|
||||
shellnotes-listnotes \- List your notes in your note folder from wherever you are.
|
||||
|
||||
shellnotes-listnotes \- list your notes from wherever you are.
|
||||
|
||||
.SH SYNOPSIS
|
||||
listnotes
|
||||
.PP
|
||||
.B listnotes
|
||||
[\fIOPTION\fR]
|
||||
|
||||
.SH DESCRIPTION
|
||||
listnotes() uses ls (do "man ls") to list all your notes.
|
||||
|
||||
.B listnotes
|
||||
uses ls (do "man ls") to list all your notes in different ways.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
-d or --dynamic \- Dynamic view of all your notes and their content.
|
||||
-n or --number \- Number of notes in your notes folder.
|
||||
-f or --folder \- The current Notes folder.
|
||||
leave a blank parameter ("listnotes") and shellnotes will show a regular list of your notes.
|
||||
|
||||
.TP
|
||||
.BR \-d ", " \--dynamic
|
||||
Dynamic view of all your notes and their content.
|
||||
|
||||
.TP
|
||||
.BR \-n ", " \--number
|
||||
Count the number of notes in your notes folder.
|
||||
|
||||
.TP
|
||||
.BR \-f ", " \--folder
|
||||
Show the current default notes folder.
|
||||
|
||||
.SH BUGS
|
||||
If the default path for listnotes() is not valid, the program is likely to crash.
|
||||
|
||||
.TP
|
||||
.BR \-DynamicOutputBug ", " \-dOutBug ", " \116
|
||||
.PP
|
||||
listnotes -d output generates autoscroll, instead of starting from where the command was executed.
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
Dimitris Marakomihelakis (dmarakom@gmail.com)
|
||||
|
|
@ -1,16 +1,29 @@
|
|||
.\" Manpage for newnote
|
||||
.\" Manpage for shellnotes-newnote.
|
||||
.\" Contact dmarakom@gmail.com to correct errors or typos.
|
||||
.TH man 8 "30/12/2020" "" "newnote man page"
|
||||
|
||||
.TH newnote 1
|
||||
.SH NAME
|
||||
shellnotes-newnote \- Write a new note using your text editor.
|
||||
|
||||
shellnotes-newnote \- write a new note using your text editor.
|
||||
|
||||
.SH SYNOPSIS
|
||||
newnote [FILENAME]
|
||||
.PP
|
||||
.B newnote
|
||||
.IR [FILE...]
|
||||
|
||||
.SH DESCRIPTION
|
||||
newnote() uses your default text-editor to write a new note and saves it into your notes folder when finished.
|
||||
.SH OPTIONS
|
||||
[FILENAME] \- The name of the new note.
|
||||
leave a blank parameter ("newnote") and shellnotes will ask you for the filename with an input.
|
||||
|
||||
.B newnote
|
||||
uses your default text-editor to write a new note and saves it into your notes folder when finished.
|
||||
|
||||
.\" .SH OPTIONS
|
||||
|
||||
.SH BUGS
|
||||
If the default editor for newnote() is not valid, the program is likely to crash.
|
||||
|
||||
.TP
|
||||
.BR \-noSaveBug ", " \-nsBug ", " \110
|
||||
If the text editor is closed without saving the new file, newnote diplays "Note saved...", but the file is not really saved.
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
Dimitris Marakomihelakis (dmarakom@gmail.com)
|
||||
|
|
@ -1,4 +1,5 @@
|
|||
.\" Manpage for shellnotes-notegrep.
|
||||
.\" Contact dmarakom@gmail.com to correct errors or typos.
|
||||
|
||||
.TH notegrep 1
|
||||
.SH NAME
|
||||
|
|
@ -9,20 +10,21 @@ shellnotes-notegrep \- manipulate notes with grep tools
|
|||
.PP
|
||||
.B notegrep
|
||||
[\fIPATTERN\fR]
|
||||
.IR file...
|
||||
.IR [FILE...]
|
||||
.PP
|
||||
.B notegrep
|
||||
[\fIOPTION\fR]
|
||||
[\fIPATTERN\fR]
|
||||
.IR file ...
|
||||
.IR [FILE...]
|
||||
.PP
|
||||
.B notegrep
|
||||
[\fIOPTION\fR]
|
||||
.IR file...
|
||||
.IR [FILE...]
|
||||
.PP
|
||||
.B notegrep
|
||||
[\fIOPTION\fR]
|
||||
[\fIPATTERN\fR]
|
||||
|
||||
.SH DESCRIPTION
|
||||
|
||||
.B notegrep
|
||||
|
|
|
|||
|
|
@ -1,16 +1,27 @@
|
|||
.\" Manpage for notewc
|
||||
.\" Manpage for shellnotes-notewc.
|
||||
.\" Contact dmarakom@gmail.com to correct errors or typos.
|
||||
.TH man 8 "30/12/2020" "" "notewc man page"
|
||||
|
||||
.TH notewc 1
|
||||
.SH NAME
|
||||
shellnotes-notewc \- Get info about a note in your notes folder.
|
||||
|
||||
shellnotes-notewc \- get info about a note.
|
||||
|
||||
.SH SYNOPSIS
|
||||
notewc [FILENAME]
|
||||
.PP
|
||||
.B notewc
|
||||
.IR [FILE...]
|
||||
|
||||
.SH DESCRIPTION
|
||||
notewc() uses wc (do "man wc") to show (lines/words/chars/name) of a note.
|
||||
.SH OPTIONS
|
||||
[FILENAME] \- The name of the note.
|
||||
leave a blank parameter ("notewc") and shellnotes will ask you for the filename with an input.
|
||||
.SH BUGS
|
||||
If wc is not pre-installed the command won't work.
|
||||
|
||||
.B notewc
|
||||
uses wc (do "man wc") to show lines, words, chars and name of a note.
|
||||
|
||||
|
||||
.\".SH OPTIONS
|
||||
|
||||
.\".SH BUGS
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
Dimitris Marakomihelakis (dmarakom@gmail.com)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,16 +1,27 @@
|
|||
.\" Manpage for quicknote.
|
||||
.\" Manpage for shellnotes-quicknote.
|
||||
.\" Contact dmarakom@gmail.com to correct errors or typos.
|
||||
.TH man 8 "30/12/2020" "" "quicknote man page"
|
||||
|
||||
.TH quicknote 1
|
||||
.SH NAME
|
||||
shellnotes-quicknote \- Write a new note directly via terminal.
|
||||
|
||||
shellnotes-quicknote \- write a new note directly via terminal.
|
||||
|
||||
.SH SYNOPSIS
|
||||
quicknote [FILENAME]
|
||||
.PP
|
||||
.B quicknote
|
||||
.IR [FILE...]
|
||||
|
||||
.SH DESCRIPTION
|
||||
quicknote() uses your in-terminal text-editor to write a new note and saves it into your notes folder when finished.
|
||||
.SH OPTIONS
|
||||
[FILENAME] \- The name of the new note.
|
||||
leave a blank parameter ("quicknote") and shellnotes will ask you for the filename with an input.
|
||||
.SH BUGS
|
||||
If the default editor for quicknote() is not valid, the program is likely to crash.
|
||||
|
||||
.B quicknote
|
||||
uses your in-terminal text-editor to write a new note and saves it into your notes folder when finished.
|
||||
It works well with the nano editor.
|
||||
|
||||
.\".SH OPTIONS
|
||||
|
||||
.\".SH BUGS
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
Dimitris Marakomihelakis (dmarakom@gmail.com)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,16 +1,34 @@
|
|||
.\" Manpage for quickread.
|
||||
.\" Contact dmarakom@gmail.com to correct errors or typos.
|
||||
.TH man 8 "30/12/2020" "" "quickread man page"
|
||||
|
||||
.TH quickread 1
|
||||
.SH NAME
|
||||
|
||||
shellnotes-quickread \- Read new note directly in your terminal.
|
||||
|
||||
.SH SYNOPSIS
|
||||
quickread [FILENAME]
|
||||
.PP
|
||||
.B notegrep
|
||||
[\fIOPTION\fR]
|
||||
.IR [FILE...]
|
||||
|
||||
.SH DESCRIPTION
|
||||
quickread() uses cat (do "man cat") to view a note.
|
||||
.SH OPTIONS
|
||||
[FILENAME] \- The name of the note.
|
||||
leave a blank parameter ("quickread") and shellnotes will ask you for the filename with an input.
|
||||
.SH BUGS
|
||||
No known bugs.
|
||||
|
||||
.B quickread
|
||||
uses cat (do "man cat") to view a note. It only runs inside your notes folder.
|
||||
|
||||
.\".SH OPTIONS
|
||||
|
||||
.TP
|
||||
.BR \-sc ", " \--split-char =\fISTRING\fR
|
||||
Split the note on a string or character and then display it.
|
||||
|
||||
.\".SH BUGS
|
||||
|
||||
.\".TP
|
||||
.\".BR \Withoutstringbug ", " \-wsBug ", " \72
|
||||
.\"If there are no matches in the input, "notegrep -ws" will display the file as is.
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
Dimitris Marakomihelakis (dmarakom@gmail.com)
|
||||
|
|
@ -1,16 +1,31 @@
|
|||
.\" Manpage for readnote.
|
||||
.\" Manpage for shellnotes-readnote.
|
||||
.\" Contact dmarakom@gmail.com to correct errors or typos.
|
||||
.TH man 8 "30/12/2020" "" "readnote man page"
|
||||
|
||||
.TH readnote 1
|
||||
.SH NAME
|
||||
shellnotes-readnote \- Read a note using your text editor.
|
||||
|
||||
shellnotes-readnote \- read a note using your favourite text editor.
|
||||
|
||||
.SH SYNOPSIS
|
||||
readnote [FILENAME]
|
||||
.PP
|
||||
.B readnote
|
||||
.IR [FILE...]
|
||||
|
||||
.SH DESCRIPTION
|
||||
readnote() uses your default text-editor to read a note.
|
||||
.SH OPTIONS
|
||||
[FILENAME] \- The name of the note.
|
||||
leave a blank parameter ("readnote") and shellnotes will ask you for the filename with an input.
|
||||
|
||||
.B readnote
|
||||
uses your default text-editor to read a note.
|
||||
|
||||
.\".SH OPTIONS
|
||||
|
||||
.SH BUGS
|
||||
If the default editor for readnote() is not valid, the program is likely to crash.
|
||||
|
||||
.TP
|
||||
.BR \-nonReadOnlyMode", " \-nrmBug ", " \114
|
||||
.PP
|
||||
readnote does not launch the text editor in read-only mode, giving the user permission to make changes.
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
Dimitris Marakomihelakis (dmarakom@gmail.com)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,17 +1,27 @@
|
|||
.\" Manpage for renamenote
|
||||
.\" Manpage for shellnotes-renamenote.
|
||||
.\" Contact dmarakom@gmail.com to correct errors or typos.
|
||||
.TH man 8 "30/12/2020" "" "renamenote man page"
|
||||
|
||||
.TH renamenote 1
|
||||
.SH NAME
|
||||
shellnotes-renamenote \- Rename a note in your notes folder.
|
||||
|
||||
shellnotes-renamenote \- rename a note in your notes folder.
|
||||
|
||||
.SH SYNOPSIS
|
||||
renamenote [FILENAME] [NEW_FILENAME]
|
||||
.PP
|
||||
.B renamenote
|
||||
.IR [FILE...]
|
||||
.IR new_[FILE...]
|
||||
|
||||
.SH DESCRIPTION
|
||||
renamenote() uses mv (do "man mv") to rename a note in your default notes folder
|
||||
.SH OPTIONS
|
||||
[FILENAME] \- The name of the note.
|
||||
[NEW_FILENAME] \- The new name of the note
|
||||
leave a blank parameter ("renamenote") and shellnotes will ask you for the filename and the new filename with an input.
|
||||
.SH BUGS
|
||||
No known bugs.
|
||||
|
||||
.B renamenote
|
||||
uses mv (do "man mv") to rename a note in your default notes folder.
|
||||
|
||||
.\".SH OPTIONS
|
||||
|
||||
.\".SH BUGS
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
Dimitris Marakomihelakis (dmarakom@gmail.com)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,22 +1,61 @@
|
|||
.\" Manpage for shellnotes.
|
||||
.\" Contact dmarakom@gmail.com to correct errors or typos.
|
||||
.TH man 8 "30/12/2020" "" "shellnotes man page"
|
||||
|
||||
.TH shellnotes 1
|
||||
.SH NAME
|
||||
shellnotes \- An easy, simple and fast way to keep notes directly via terminal.
|
||||
|
||||
shellnotes \- an easy, simple and fast way to keep notes directly via terminal.
|
||||
|
||||
.SH SYNOPSIS
|
||||
shellnotes [OPTION]
|
||||
.PP
|
||||
.B shellnotes
|
||||
[\fROPTION\fR]
|
||||
|
||||
.SH DESCRIPTION
|
||||
Shellnotes is a note system for advanced linux and terminal users. It is made out of a lot of other commands and scripts, so if you want to get information and help for every single one of them, you should visit the Help Page (~/.shellnotes/docs/help manually, or type shellnotes --help in the terminal).
|
||||
|
||||
.B shellnotes
|
||||
is a note system for advanced linux and terminal users. With this tool, you can wither write, read, rename or delete your notes safely and rapidly.
|
||||
Shellnotes also has numerous other features and subtools, that can help every user on a daily basis.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
-u or --update \- Update shellnotes.
|
||||
-v or --version \- Display the current version.
|
||||
-h or --help \- Display help from the Help Page.
|
||||
-r \- View the github repository of the program.
|
||||
-sd or --set-defaults \- Set default editors and folder for writing and storing your notes.
|
||||
-au or --auto-update \- Toggle the auto-update feature.
|
||||
-l or --logs \- Open a logfile.
|
||||
leave a blank parameter ("shellnotes") for checking if shellnotes is installed correctly.
|
||||
.SH BUGS
|
||||
No known bugs.
|
||||
|
||||
.TP
|
||||
.BR \-i ", " \--info
|
||||
Get info about shellnotes, as well as a copyright notice.
|
||||
|
||||
.TP
|
||||
.BR \-v ", " \--version
|
||||
Displays your current version of shellnotes.
|
||||
|
||||
.TP
|
||||
.BR \-r ", " \--repository
|
||||
Get info about the project's github repository.
|
||||
|
||||
.TP
|
||||
.BR \-h ", " \--help
|
||||
Enter the Shellnotes Help Page (SHP).
|
||||
|
||||
.TP
|
||||
.BR \-u ", " \--update
|
||||
Searches for an update and applies it on shellnotes if necessary.
|
||||
|
||||
.TP
|
||||
.BR \-au ", " \--auto-update
|
||||
Toggle the auto-update feature.
|
||||
Shellnotes auto-update searches for a new a new update in the project's github repository every time you open your terminal and asks you whether to apply it or not.
|
||||
|
||||
.TP
|
||||
.BR \-sd ", " \--set-defaults
|
||||
Redirects the user to the shellnotes configuration tool (set_defaults.sh)
|
||||
|
||||
.TP
|
||||
.BR \-l ", " \--logs
|
||||
View a logfile.
|
||||
|
||||
.\".SH BUGS
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
Dimitris Marakomihelakis (dmarakom@gmail.com)
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue