mirror of
https://github.com/fumiama/base16384.git
synced 2026-06-23 00:38:32 +08:00
add manpage
This commit is contained in:
86
base16384.1
Normal file
86
base16384.1
Normal file
@@ -0,0 +1,86 @@
|
||||
.TH BASE16384 1 "27 April 2022" "GNU" "User Commands"
|
||||
.SH NAME
|
||||
base16384 \- Encode binary files to printable utf16be
|
||||
.SH SYNOPSIS
|
||||
.B base16384
|
||||
-[e|d] <\fIinputfile\fR> <\fIoutputfile\fR>
|
||||
.SH DESCRIPTION
|
||||
.LP
|
||||
There are
|
||||
.B 16384
|
||||
Chinese characters ( from
|
||||
.B 4E00
|
||||
to
|
||||
.B 8DFF
|
||||
) being selected as the
|
||||
.I "alphabet"
|
||||
, just like what base64 did. If length of the data has a remainder after mod 7, an unicode Chinese character
|
||||
.B 3Dxx
|
||||
will be appended to present it with
|
||||
.I xx
|
||||
ranging from
|
||||
.I 01
|
||||
to
|
||||
.I 06
|
||||
.
|
||||
.SH OPTIONS
|
||||
.sp 1
|
||||
.TP 0.5i
|
||||
\fB\-e\fR
|
||||
Read data from \fIinputfile\fR and encode them into \fIoutputfile\fR.
|
||||
.TP 0.5i
|
||||
\fBinputfile\fR
|
||||
An absolute or relative file path. Specially, pass - to read from stdin.
|
||||
.TP 0.5i
|
||||
\fBoutputfile\fR
|
||||
An absolute or relative file path. Specially, pass - to write to stdout.
|
||||
.SH "EXIT STATUS"
|
||||
.TP 0.5i
|
||||
\fB0\fR
|
||||
Exit on success.
|
||||
.TP 0.5i
|
||||
\fB1\fR
|
||||
Get file size error.
|
||||
.TP 0.5i
|
||||
\fB2\fR
|
||||
Fopen output file error.
|
||||
.TP 0.5i
|
||||
\fB3\fR
|
||||
Fopen input file error.
|
||||
.TP 0.5i
|
||||
\fB4\fR
|
||||
Write file error.
|
||||
.TP 0.5i
|
||||
\fB5\fR
|
||||
Open input file error.
|
||||
.TP 0.5i
|
||||
\fB6\fR
|
||||
Map input file error.
|
||||
.TP 0.5i
|
||||
\fB7\fR
|
||||
Write file error in mmap.
|
||||
.SH "SEE ALSO"
|
||||
https://github.com/fumiama/base16384
|
||||
.SH BUGS
|
||||
There are currently no known bugs in this application. If you have found them, please contact the
|
||||
.B author
|
||||
on github.
|
||||
.SH AUTHOR
|
||||
This manual page contributed by fumiama.
|
||||
.SH "COPYRIGHT"
|
||||
Copyright \(co 1992-1993, 1996-2022 Free Software Foundation, Inc.
|
||||
This file is part of
|
||||
.IR "base16384" .
|
||||
.LP
|
||||
Base16384 is free software; you can redistribute it and/or modify it under the
|
||||
terms of the GNU General Public License as published by the Free Software
|
||||
Foundation; either version 3 of the License, or (at your option) any later
|
||||
version.
|
||||
.LP
|
||||
Base16384 is distributed in the hope that it will be useful, but WITHOUT ANY
|
||||
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
|
||||
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
||||
.LP
|
||||
You should have received a copy of the GNU General Public License along with
|
||||
this program. If not, see
|
||||
.IR http://www.gnu.org/licenses/ .
|
||||
Reference in New Issue
Block a user