From 746ade09e68fe235b3ab1cab4504679f8b1be4cf Mon Sep 17 00:00:00 2001 From: dmarakom6 Date: Mon, 5 Jul 2021 15:51:11 +0300 Subject: [PATCH] Manpages for hidden commands --- docs/manpages/clearlogs.1 | 21 +++++++++++++++++++++ docs/manpages/resetshellnotes.1 | 27 +++++++++++++++++++++++++++ 2 files changed, 48 insertions(+) create mode 100644 docs/manpages/clearlogs.1 create mode 100644 docs/manpages/resetshellnotes.1 diff --git a/docs/manpages/clearlogs.1 b/docs/manpages/clearlogs.1 new file mode 100644 index 0000000..1dff836 --- /dev/null +++ b/docs/manpages/clearlogs.1 @@ -0,0 +1,21 @@ +.\" Manpage for shellnotes-clearlogs(hidden). +.\" Contact dmarakom@gmail.com to correct errors or typos. + +.TH clearlogs 1 +.SH NAME + +clearlogs \- clear every shellnotes logfile in your system. + +.SH SYNOPSIS +.PP +.B clearlogs + +.SH DESCRIPTION + +.B clearlogs +Wipes out all the text from every singe logfile stored in .shellnotes/logs/ . This command MUST NOT be used, unless necessary. It won't have an affect on your Notes or on shellnotes' performance. + + +.SH AUTHOR + +Dimitris Marakomihelakis (dmarakom@gmail.com) diff --git a/docs/manpages/resetshellnotes.1 b/docs/manpages/resetshellnotes.1 new file mode 100644 index 0000000..2326086 --- /dev/null +++ b/docs/manpages/resetshellnotes.1 @@ -0,0 +1,27 @@ +.\" Manpage for shellnotes-resetshellnotes(hidden). +.\" Contact dmarakom@gmail.com to correct errors or typos. + +.TH resetshellnotes 1 +.SH NAME + +resetshellnotes \- reset your shellnotes. + +.SH SYNOPSIS +.PP +.B resetshellnotes +[\f-f\fR] + +.SH DESCRIPTION + +.B resetshellnotes +sets your shellnotes configurations, options, and logs to their normal state. This command MUST NOT be used, unless necessary. Your notes will remain where they are if you ever choose to run this command. Use "--force" to avoid prompt. + +.SH OPTIONS + +.TP +.BR \-f ", " \--force +Avoid information prompt and warnings. Doesn't return a message when the process is complete. + +.SH AUTHOR + +Dimitris Marakomihelakis (dmarakom@gmail.com)