mirror of
https://github.com/fumiama/base16384.git
synced 2026-06-05 02:00:31 +08:00
123 lines
2.6 KiB
Groff
123 lines
2.6 KiB
Groff
.TH BASE16384 1 "4 Sep 2025" "GNU" "User Commands"
|
|
.SH NAME
|
|
base16384 \- Encode binary files to printable utf16be
|
|
.SH SYNOPSIS
|
|
.B base16384
|
|
-[ed][t][n][cC] <\fIinputfile\fR> <\fIoutputfile\fR>
|
|
.SH DESCRIPTION
|
|
.LP
|
|
There are
|
|
.B 16384
|
|
Chinese characters ( from
|
|
.B 4E00
|
|
to
|
|
.B 8DFF
|
|
) 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. It's the default option when neither
|
|
.B -e
|
|
nor
|
|
.B -d
|
|
is specified.
|
|
.TP 0.5i
|
|
\fB\-d\fR
|
|
Read data from \fIinputfile\fR and decode them into \fIoutputfile\fR.
|
|
.TP 0.5i
|
|
\fB\-t\fR
|
|
Show spend time.
|
|
.TP 0.5i
|
|
\fB\-n\fR
|
|
Do not write utf16be file header
|
|
.B 0xFEFF
|
|
to the output.
|
|
.TP 0.5i
|
|
\fB\-c\fR
|
|
Embed or validate checksum in remainder when using \fIstdin\fR or \fIstdout\fR or inputsize > _BASE16384_ENCBUFSZ.
|
|
.TP 0.5i
|
|
\fB\-C\fR
|
|
Do
|
|
.B -c
|
|
forcely.
|
|
.TP 0.5i
|
|
\fBinputfile\fR
|
|
An absolute or relative file path. Specially, pass
|
|
.B -
|
|
to read from \fIstdin\fR.
|
|
.TP 0.5i
|
|
\fBoutputfile\fR
|
|
An absolute or relative file path. Specially, pass
|
|
.B -
|
|
to write to \fIstdout\fR.
|
|
.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.
|
|
.TP 0.5i
|
|
\fB8\fR
|
|
Invalid input/output filename.
|
|
.TP 0.5i
|
|
\fB9\fR
|
|
Invalid commandline parameter.
|
|
.TP 0.5i
|
|
\fB10\fR
|
|
Invalid decoding checksum.
|
|
.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 Minamoto.
|
|
.SH "COPYRIGHT"
|
|
Copyright \(co 2022-2025, Fumiama Minamoto
|
|
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/ .
|