Skip to content

Commit

Permalink
Added raw man page
Browse files Browse the repository at this point in the history
  • Loading branch information
missn0body committed Apr 12, 2024
1 parent 2c8165f commit 2965238
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
1 change: 0 additions & 1 deletion 1.0.2/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ LINT = cppcheck
LINTFLAGS = --check-level=exhaustive --enable=all --inconclusive --suppress=missingIncludeSystem --verbose

BIN = sfn

DDIR = doc

# Building -------------------------------------
Expand Down
31 changes: 31 additions & 0 deletions 1.0.2/doc/sfn.7
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
.TH sfn 7 "April 2024" "Version 1.0.2"
.SH NAME
sfn \- convert a string into an 8.3 Short FileName
.SH SYNOPSIS
.B sfn
.I <string>
.SH DESCRIPTION
.B sfn
recieves a string from the command-line, one that represents
a hypothetical, real-or-not filename, and shortens it to fit
an specific 8.3 schema. In this 8.3 schema, all non-alphabetical
characters save for the period are deleted, including numbers and
special characters. The filename sans extension is shortened so that
it does not exceed 8 characters, and the extension is also
shortened so that it does not exceed 3 characters.
.PP
If the given string lacks an extension,
.B sfn
automatically appends an extension "TMP" onto the result.
.PP
A string representing a path is not recommended as input.
.PP
.B sfn
is invokable through the terminal.
.SH OPTIONS
.IP "<string>"
The given string to be converted.
.SH BUGS
No known bugs
.SH AUTHORS
Written by anson <thesearethethingswesaw@gmail.com>

0 comments on commit 2965238

Please sign in to comment.