From 1d8e1252bff2523e753d9983cdfa833fdc3be6d0 Mon Sep 17 00:00:00 2001 From: Yves Biener Date: Sat, 14 Oct 2023 11:19:32 +0200 Subject: [PATCH] add(doc): initial man page --- doc/sp.1 | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 doc/sp.1 diff --git a/doc/sp.1 b/doc/sp.1 new file mode 100644 index 0000000..e41ce38 --- /dev/null +++ b/doc/sp.1 @@ -0,0 +1,38 @@ +.\" This is the groff documentation source for sp +.\" +.\" Preview with: groff -man -Tascii sp.1 +.\" or: man -l sp.1 +.\" + +.TH SP 1 "2023-10-14" "User Commands" +.SH NAME +sp \- A ispell wrapper to automatically correct spelling errors +.SH SYNOPSIS +.B sp +.RI WORD +. +.SH DESCRIPTION +.B sp +Is a cli tool to automatically select the first correction of the provided word using gnu/linux ispell. +.PP +sp is a wrapper program around ispell +. +.SH EXAMPLES +sp opprotunity +.PP +echo opprotunity | sp +.PP +Both sp executions will result into the same output of +.I opportunity +wether you provide the word as an command line argument or pipe the argument to sp. +. +.SH AUTHOR +Written by Yves Biener. +Man page by Yves Biener. +. +.SH BUGS +Please report bugs at +.IR https://gitea.yves-biener.de/yves-biener/sp/issues +. +.SH COPYRIGHT +This software is provided by Yves Biener ''as is'' and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall Yves Biener be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.