Skip to content

Commit

Permalink
add a few manpages
Browse files Browse the repository at this point in the history
  • Loading branch information
hydrargyrum committed Apr 24, 2016
1 parent c489530 commit 92d73f8
Show file tree
Hide file tree
Showing 5 changed files with 141 additions and 0 deletions.
23 changes: 23 additions & 0 deletions hexgen/hexgen.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
.TH hexgen 1
.SH NAME
hexgen \- generate bytes from ASCII hexadecimal dump
.SH SYNOPSIS
hexgen
.SH DESCRIPTION
.BR hexgen
reads hexadecimal numbers on stdin and writes bytes with values corresponding
to the numbers.
.PP
Whitespace (spaces, tabs, newlines) are simply ignored when read. Any other
character that is not a hex digit will quit
.B hexgen
with an error.
.SH EXAMPLES
.TP
echo "4865 6c6c 6f20 776f 726c 64 21 0a" | hexgen
Will output
.br
.PP
Hello world!
.SH SEE ALSO
.BR hd (1), xxd (1)
44 changes: 44 additions & 0 deletions qunpak/qunpak.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
.TH qunpak 1
.SH NAME
qunpak \- extract Quake PAK archives
.SH SYNOPSIS
\fBqunpak\fR [-x] [-O \fIDIR\fP] \fIFILE.PAK\fP [\fIPATTERN\fP]
.br
\fBqunpak\fR -l \fIFILE.PAK\fP [\fIPATTERN\fP]
.SH DESCRIPTION
.PP
.B qunpak
extracts and lists archives in the Quake PAK format.
By just giving an archive file name, it will extract all files contained in
the archive (in the current directory).
.TP
.B -x
Extract the archive (default)
.TP
.B -l
List the archive
.TP
.B -O
Extract the archive in DIR instead of current directory.
.PP
If a PATTERN is specified, it will only extract (or list) files matching
the pattern. The PATTERN can contain wildcard characters, and "*" will
match any "/" or ".".
.SH EXAMPLES
.TP
qunpak pak0.pak
Extract all files from
.I pak0.pak
.TP
qunpak -O my_sounds pak1.pak "*.wav"
Extract all
.I .wav
files from
.I pak1.pak
into the
.I my_sounds
directory
.SH AUTHOR
Report bugs to <[email protected]>
.SH SEE ALSO
.BR tar (1)
16 changes: 16 additions & 0 deletions tailsleep/tailsleep.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.TH tailsleep 1
.SH NAME
tailsleep \- continuously read a file as long as it's modified
.SH SYNOPSIS
.B tailsleep
.I FILE
.SH DESCRIPTION
.B tailsleep
reads a file continuously, as the file is being appended data to by another
process.
.SH EXAMPLES
.TP
tailsleep archive_being_downloaded.tar.gz | tar xzf -
Extracts a file that is being downloaded and quits when download is finished
.SH SEE ALSO
.BR tail (1)
41 changes: 41 additions & 0 deletions univisible/univisible.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
.TH univisible 1
.SH NAME
univisible \- visualize Unicode compositions and codepoints
.SH SYNOPSIS
univisible [\fIcommon options\fP] -i
.br
univisible [\fIcommon options\fP] [-d | -c]
.br
univisible [\fIcommon options\fP] -v
.SH DESCRIPTION
univisible can display info about codepoints, can compose and decompose
Unicode compositions, and also display visually the decompositions. It reads
stdin and processes the codepoints.
.TP
.B -i
print info about each individual codepoint: give its number and name
.TP
.B -c
compose codepoints where possible with NFKC and display on stdout
.TP
.B -d
decompose codepoints with NFKD and display on stdout
.TP
.B -v
display decomposed codepoints by separating visually the combining characters
and show them in a reverse-video background
.TP
.B -f
Use specified encoding for decoding stdin
.TP
.B -t
Use specified encoding for encoding stdout
.TP
.B -h
print help and exit
.SH EXAMPLES
.TP
univisible -d < composed.txt > decomposed.txt
Decompose codepoints from composed.txt and write in decomposed.txt
.SH SEE ALSO
.BR iconv (1)
17 changes: 17 additions & 0 deletions wakeonwan/wakeonwan.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.TH wakeonwan 1
.SH NAME
wakeonwan \- Wake up a machine remotely with Wake-On-WAN
.SH SYNOPSIS
wakeonwan \fBIP\fP \fBMAC_ADDRESS\fP
.SH DESCRIPTION
.BR wakeonwan
can boot powered-off machines remotely. The BIOS needs to be properly set up
for it to work. The UDP packets used must also be forwarded despite the target
being off.
.PP
The IP address is the remote IP, and the MAC address is the address of the
remote network device.
.SH EXAMPLES
wakeonwan 1.2.3.4 11:22:33:44:55:66
.SH SEE ALSO
.BR wakeonlan(1)

0 comments on commit 92d73f8

Please sign in to comment.