-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add manpage, provided by Marcos Talau (#78)
See issue #78 for the original zipfile. I'm adding only the man page file itself, not the original `.txt` file and the shell script to convert it using `txt2man`. The idea here is having less dependencies. There's also man page editors out there for future updates.
- Loading branch information
1 parent
a5e82ed
commit 8fa4e7f
Showing
1 changed file
with
95 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
.\" Text automatically generated by txt2man | ||
.TH sedsed 1 "08 Dec 2021" "sedsed-2.0.0" "Debugger and code formatter for sed scripts" | ||
.SH NAME | ||
\fBsedsed \fP- debugger and code formatter for sed scripts | ||
\fB | ||
.SH SYNOPSIS | ||
.nf | ||
.fam C | ||
\fBsedsed\fP \fIOPTION\fP [\fB-e\fP \fIsedscript\fP] [\fB-f\fP \fIsedscriptfile\fP] [\fIinputfile\fP] | ||
.fam T | ||
.fi | ||
.fam T | ||
.fi | ||
.SH DESCRIPTION | ||
\fBsedsed\fP can debug, indent, tokenize and HTMLize sed scripts. | ||
.PP | ||
In debug mode, it reads the target script and adds extra commands | ||
to it. When executed it shows the data flow between the commands, | ||
revealing all the magic sed does on its internal buffers. | ||
.PP | ||
In indent mode, the script is reformatted with standard spacing. | ||
.PP | ||
In tokenize mode, it shows the elements of every command used. | ||
.PP | ||
In HTMLize mode, the script is converted to a beautiful colored | ||
HTML file, with all the commands and parameters identified for | ||
best viewing. | ||
.SH OPTIONS | ||
.TP | ||
.B | ||
\fB-f\fP, \fB--file\fP | ||
Add file contents to the commands to be parsed. | ||
.TP | ||
.B | ||
\fB-e\fP, \fB--expression\fP | ||
Add the script to the commands to be parsed. | ||
.TP | ||
.B | ||
\fB-n\fP, \fB--quiet\fP | ||
Suppress automatic printing of pattern space. | ||
.TP | ||
.B | ||
\fB--silent\fP | ||
Alias to \fB--quiet\fP. | ||
.TP | ||
.B | ||
\fB-d\fP, \fB--debug\fP | ||
Debug the sed script. | ||
.TP | ||
.B | ||
\fB--hide\fP | ||
Hide some debug info (options: PATT, HOLD, COMM). | ||
.TP | ||
.B | ||
\fB--color\fP | ||
Shows debug output in colors (default: ON). | ||
.TP | ||
.B | ||
\fB--nocolor\fP | ||
No colors on debug output. | ||
.TP | ||
.B | ||
\fB--dump-debug\fP | ||
Dumps to screen the debugged sed script. | ||
.TP | ||
.B | ||
\fB-i\fP, \fB--indent\fP | ||
Script beautifier, prints indented and | ||
one-command-per-line output do STDOUT. | ||
.TP | ||
.B | ||
\fB--prefix\fP | ||
Indent prefix string (default: 4 spaces). | ||
.TP | ||
.B | ||
\fB-t\fP, \fB--tokenize\fP | ||
Script tokenizer, prints extensive | ||
command by command information. | ||
.TP | ||
.B | ||
\fB-H\fP, \fB--htmlize\fP | ||
Converts sed script to a colorful HTML page. | ||
.TP | ||
.B | ||
\fB-V\fP, \fB--version\fP | ||
Prints the program version and exit. | ||
.TP | ||
.B | ||
\fB-h\fP, \fB--help\fP | ||
Prints this help message and exit. | ||
.SH AUTHOR | ||
\fBsedsed\fP was written by Aurelio Jargas <[email protected]>. | ||
.PP | ||
This manual page was written by Marcos Talau <[email protected]> | ||
for the Debian project (but may be used by others). |