Skip to content

Commit

Permalink
0.2: add man pages
Browse files Browse the repository at this point in the history
  • Loading branch information
zvezdochiot committed Oct 19, 2023
1 parent 3673dcb commit 63e3c77
Show file tree
Hide file tree
Showing 2 changed files with 99 additions and 0 deletions.
58 changes: 58 additions & 0 deletions man/man1/faxg4coder.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
.TH "faxg4coder" 1 0.2 "20 Oct 2023" "User Manual"

.SH NAME
faxg4coder

.SH DESCRIPTION
G3/G4 Fax En-/Decoder.

.SH SYNOPSIS
faxg4coder [options] [infile] [outfile]

.SH OPTIONS
.TP
-g3
G3 1-dimensional code (default)
.TP
-g3{K}
G3 2-dimensional code, parameter {K}, e.g. -g32 for K=2
.TP
-g4
G4 (2-dim) code
.TP
-hdr
Put/Read MMR header to file
.TP
-decode{W}
Decode to pbm-file, using image width {W}, e.g. -decode1728 (default, if not given), else : encode from pbm-file
.TP
-p
Write plain pbm
.TP
-b
Read/Write bitstrings
.TP
-h
Show help

Only K=2 (low resolution) and K=4 (high resolution) are standardized.
If outfile or both infile and outfile are not given
standard output and maybe standard input are used.


.SH EXAMPLE
faxg4coder -g4 page.pbm page.g4
faxg4coder -g4 -decode2480 page.g4 page.pbm

faxg4coder -g4 -hdr page.pbm page.g4whdr
djvumake page.djvu Smmr=page.g4whdr

.SH COPYRIGHT
GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007

.SH SEE ALSO
faxlzwcoder(1)

.SH CONTACTS
Website:
https://github.com/ImageProcessing-ElectronicPublications/faxcoder
41 changes: 41 additions & 0 deletions man/man1/faxlzwcoder.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
.TH "faxlzwcoder" 1 0.2 "20 Oct 2023" "User Manual"

.SH NAME
faxlzwcoder

.SH DESCRIPTION
LZW BW En-/Decoder.

.SH SYNOPSIS
faxlzwcoder [options] [infile] [outfile]

.SH OPTIONS
.TP
-d
Decode, else : Encode
.TP
-early{E}
Enlarge the code length {E} entries early (default: 1)
.TP
-pbm{W}
Read/Write pbm-file; using image width {W} (for decoding)
.TP
-h
Show this help

If outfile or both infile and outfile are not given
standard output and maybe standard input are used.

.SH EXAMPLE
faxlzwcoder page.pbm page.lzw
faxlzwcoder -d page.lzw page.pbm

.SH COPYRIGHT
GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007

.SH SEE ALSO
faxg4coder(1)

.SH CONTACTS
Website:
https://github.com/ImageProcessing-ElectronicPublications/faxcoder

0 comments on commit 63e3c77

Please sign in to comment.