From db72d533e70f8daee90459067be89fc1d66c1e02 Mon Sep 17 00:00:00 2001 From: dmarakom6 Date: Thu, 1 Apr 2021 08:11:35 +0300 Subject: [PATCH] manpages --- docs/manpages/delnote.1 | 19 +++++++++++++++++++ docs/manpages/findmisplacednote.1 | 16 ++++++++++++++++ docs/manpages/findnote.1 | 16 ++++++++++++++++ docs/manpages/listnotes.1 | 18 ++++++++++++++++++ docs/manpages/newnote.1 | 16 ++++++++++++++++ docs/manpages/noteinfo.1 | 16 ++++++++++++++++ docs/manpages/quicknote.1 | 16 ++++++++++++++++ docs/manpages/quickread.1 | 16 ++++++++++++++++ docs/manpages/readnote.1 | 16 ++++++++++++++++ docs/manpages/renamenote.1 | 17 +++++++++++++++++ docs/manpages/shellnotes.1 | 22 ++++++++++++++++++++++ 11 files changed, 188 insertions(+) create mode 100644 docs/manpages/delnote.1 create mode 100644 docs/manpages/findmisplacednote.1 create mode 100644 docs/manpages/findnote.1 create mode 100644 docs/manpages/listnotes.1 create mode 100644 docs/manpages/newnote.1 create mode 100644 docs/manpages/noteinfo.1 create mode 100644 docs/manpages/quicknote.1 create mode 100644 docs/manpages/quickread.1 create mode 100644 docs/manpages/readnote.1 create mode 100644 docs/manpages/renamenote.1 create mode 100644 docs/manpages/shellnotes.1 diff --git a/docs/manpages/delnote.1 b/docs/manpages/delnote.1 new file mode 100644 index 0000000..e8d48b0 --- /dev/null +++ b/docs/manpages/delnote.1 @@ -0,0 +1,19 @@ +.\" Manpage for delnote +.\" Contact dmarakom@gmail.com to correct errors or typos. +.TH man 8 "30/12/2020" "" "delnote man page" +.SH NAME +shellnotes-delnote \- Delete a note in your notes folder. +.SH SYNOPSIS +delnote [FILENAME] [OPTION] +.SH DESCRIPTION +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. +.SH AUTHOR +Dimitris Marakomihelakis (dmarakom@gmail.com) \ No newline at end of file diff --git a/docs/manpages/findmisplacednote.1 b/docs/manpages/findmisplacednote.1 new file mode 100644 index 0000000..1fbfb4b --- /dev/null +++ b/docs/manpages/findmisplacednote.1 @@ -0,0 +1,16 @@ +.\" Manpage for findmisplacednote +.\" Contact dmarakom@gmail.com to correct errors or typos. +.TH man 8 "30/12/2020" "" "findmisplacednote man page" +.SH NAME +shellnotes-findmisplacednote \- Find a note missing from your notes folder. +.SH SYNOPSIS +findmisplacednote [FILENAME] +.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. +.SH AUTHOR +Dimitris Marakomihelakis (dmarakom@gmail.com) \ No newline at end of file diff --git a/docs/manpages/findnote.1 b/docs/manpages/findnote.1 new file mode 100644 index 0000000..4054c07 --- /dev/null +++ b/docs/manpages/findnote.1 @@ -0,0 +1,16 @@ +.\" Manpage for findnote +.\" Contact dmarakom@gmail.com to correct errors or typos. +.TH man 8 "30/12/2020" "" "findnote man page" +.SH NAME +shellnotes-findnote \- Find a note in your notes folder. +.SH SYNOPSIS +findnote [FILENAME] +.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. +.SH AUTHOR +Dimitris Marakomihelakis (dmarakom@gmail.com) \ No newline at end of file diff --git a/docs/manpages/listnotes.1 b/docs/manpages/listnotes.1 new file mode 100644 index 0000000..9dc865e --- /dev/null +++ b/docs/manpages/listnotes.1 @@ -0,0 +1,18 @@ +.\" Manpage for listnotes. +.\" Contact dmarakom@gmail.com to correct errors or typos. +.TH man 8 "30/12/2020" "" "listnotes man page" +.SH NAME +shellnotes-listnotes \- List your notes in your note folder from wherever you are. +.SH SYNOPSIS +listnotes +.SH DESCRIPTION +listnotes() uses ls (do "man ls") to list all your notes. +.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. +.SH BUGS +If the default path for listnotes() is not valid, the program is likely to crash. +.SH AUTHOR +Dimitris Marakomihelakis (dmarakom@gmail.com) \ No newline at end of file diff --git a/docs/manpages/newnote.1 b/docs/manpages/newnote.1 new file mode 100644 index 0000000..2d9dd8b --- /dev/null +++ b/docs/manpages/newnote.1 @@ -0,0 +1,16 @@ +.\" Manpage for newnote +.\" Contact dmarakom@gmail.com to correct errors or typos. +.TH man 8 "30/12/2020" "" "newnote man page" +.SH NAME +shellnotes-newnote \- Write a new note using your text editor. +.SH SYNOPSIS +newnote [FILENAME] +.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. +.SH BUGS +If the default editor for newnote() is not valid, the program is likely to crash. +.SH AUTHOR +Dimitris Marakomihelakis (dmarakom@gmail.com) \ No newline at end of file diff --git a/docs/manpages/noteinfo.1 b/docs/manpages/noteinfo.1 new file mode 100644 index 0000000..7733ea1 --- /dev/null +++ b/docs/manpages/noteinfo.1 @@ -0,0 +1,16 @@ +.\" Manpage for noteinfo +.\" Contact dmarakom@gmail.com to correct errors or typos. +.TH man 8 "30/12/2020" "" "noteinfo man page" +.SH NAME +shellnotes-noteinfo \- Get info about a note in your notes folder. +.SH SYNOPSIS +noteinfo [FILENAME] +.SH DESCRIPTION +noteinfo() 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 ("noteinfo") and shellnotes will ask you for the filename with an input. +.SH BUGS +If wc is not pre-installed the command won't work. +.SH AUTHOR +Dimitris Marakomihelakis (dmarakom@gmail.com) \ No newline at end of file diff --git a/docs/manpages/quicknote.1 b/docs/manpages/quicknote.1 new file mode 100644 index 0000000..99a54fa --- /dev/null +++ b/docs/manpages/quicknote.1 @@ -0,0 +1,16 @@ +.\" Manpage for quicknote. +.\" Contact dmarakom@gmail.com to correct errors or typos. +.TH man 8 "30/12/2020" "" "quicknote man page" +.SH NAME +shellnotes-quicknote \- Write a new note directly via terminal. +.SH SYNOPSIS +quicknote [FILENAME] +.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. +.SH AUTHOR +Dimitris Marakomihelakis (dmarakom@gmail.com) \ No newline at end of file diff --git a/docs/manpages/quickread.1 b/docs/manpages/quickread.1 new file mode 100644 index 0000000..ab8c52d --- /dev/null +++ b/docs/manpages/quickread.1 @@ -0,0 +1,16 @@ +.\" Manpage for quickread. +.\" Contact dmarakom@gmail.com to correct errors or typos. +.TH man 8 "30/12/2020" "" "quickread man page" +.SH NAME +shellnotes-quickread \- Read new note directly in your terminal. +.SH SYNOPSIS +quickread [FILENAME] +.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. +.SH AUTHOR +Dimitris Marakomihelakis (dmarakom@gmail.com) \ No newline at end of file diff --git a/docs/manpages/readnote.1 b/docs/manpages/readnote.1 new file mode 100644 index 0000000..a25f375 --- /dev/null +++ b/docs/manpages/readnote.1 @@ -0,0 +1,16 @@ +.\" Manpage for readnote. +.\" Contact dmarakom@gmail.com to correct errors or typos. +.TH man 8 "30/12/2020" "" "readnote man page" +.SH NAME +shellnotes-readnote \- Read a note using your text editor. +.SH SYNOPSIS +readnote [FILENAME] +.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. +.SH BUGS +If the default editor for readnote() is not valid, the program is likely to crash. +.SH AUTHOR +Dimitris Marakomihelakis (dmarakom@gmail.com) \ No newline at end of file diff --git a/docs/manpages/renamenote.1 b/docs/manpages/renamenote.1 new file mode 100644 index 0000000..5b93ee8 --- /dev/null +++ b/docs/manpages/renamenote.1 @@ -0,0 +1,17 @@ +.\" Manpage for renamenote +.\" Contact dmarakom@gmail.com to correct errors or typos. +.TH man 8 "30/12/2020" "" "renamenote man page" +.SH NAME +shellnotes-renamenote \- Rename a note in your notes folder. +.SH SYNOPSIS +renamenote [FILENAME] [NEW_FILENAME] +.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. +.SH AUTHOR +Dimitris Marakomihelakis (dmarakom@gmail.com) \ No newline at end of file diff --git a/docs/manpages/shellnotes.1 b/docs/manpages/shellnotes.1 new file mode 100644 index 0000000..23a37ee --- /dev/null +++ b/docs/manpages/shellnotes.1 @@ -0,0 +1,22 @@ +.\" Manpage for shellnotes. +.\" Contact dmarakom@gmail.com to correct errors or typos. +.TH man 8 "30/12/2020" "" "shellnotes man page" +.SH NAME +shellnotes \- An easy, simple and fast way to keep notes directly via terminal. +.SH SYNOPSIS +shellnotes [OPTION] +.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). +.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. +.SH AUTHOR +Dimitris Marakomihelakis (dmarakom@gmail.com) \ No newline at end of file