shellnotes/docs/manpages/readnote.1

16 lines
598 B
Groff
Raw Normal View History

2021-07-05 10:50:01 +02:00
.\" Manpage for readnote.
2021-04-01 07:11:35 +02:00
.\" Contact dmarakom@gmail.com to correct errors or typos.
2021-07-05 10:50:01 +02:00
.TH man 8 "30/12/2020" "" "readnote man page"
2021-04-01 07:11:35 +02:00
.SH NAME
2021-07-05 10:50:01 +02:00
shellnotes-readnote \- Read a note using your text editor.
2021-04-01 07:11:35 +02:00
.SH SYNOPSIS
2021-07-05 10:50:01 +02:00
readnote [FILENAME]
2021-04-01 07:11:35 +02:00
.SH DESCRIPTION
2021-07-05 10:50:01 +02:00
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.
2021-04-01 07:11:35 +02:00
.SH BUGS
2021-07-05 10:50:01 +02:00
If the default editor for readnote() is not valid, the program is likely to crash.
2021-04-01 07:11:35 +02:00
.SH AUTHOR
2021-07-05 10:50:01 +02:00
Dimitris Marakomihelakis (dmarakom@gmail.com)