JBinHex/README.md

84 lines
2.9 KiB
Markdown
Raw Permalink Normal View History

2020-04-30 09:09:43 +00:00
[![](https://jitpack.io/v/umjammer/jbinhex.svg)](https://jitpack.io/#umjammer/jbinhex) [![Parent](https://img.shields.io/badge/Parent-vavi--util--archive-pink)](https://github.com/umjammer/vavi-util-archive)
2019-06-09 01:00:20 +00:00
2019-06-09 00:58:09 +00:00
# JBinHex
2019-06-09 00:43:57 +00:00
JBinHex is both a library and a command-line tool to decode files in
the Apple Macintosh BinHex 4.0 format.
2019-06-09 00:58:09 +00:00
## Current version: 0.5
2019-06-09 00:43:57 +00:00
2019-06-09 00:58:09 +00:00
## Version history
2019-06-09 00:43:57 +00:00
2019-06-09 00:58:09 +00:00
* 0.5 First released version
2019-06-09 00:43:57 +00:00
2019-06-09 00:58:09 +00:00
## Limitations in this version
2019-06-09 00:43:57 +00:00
2019-06-09 00:58:09 +00:00
* This version does not support segmented files such as used
on `comp.binaries.mac.*` newsgroups
* Documentation is limited
* Command line tool has does not check wether the command line
2019-06-09 00:43:57 +00:00
parameters are completely correct
2019-06-09 00:58:09 +00:00
## Possible future features
2019-06-09 00:43:57 +00:00
2019-06-09 00:58:09 +00:00
* Encoding of BinHex files
* File-based interface that allows to switch between data and
2019-06-09 00:43:57 +00:00
resource fork at any moment, instead of the predetermined order
that the stream-based interface dictates
2019-06-09 00:58:09 +00:00
## Command-line tool
2019-06-09 00:43:57 +00:00
2019-06-09 00:58:09 +00:00
The class name of the command-line tool is `org.gjt.convert.binhex.DeBinHex`
2019-06-09 00:43:57 +00:00
2019-06-09 00:58:09 +00:00
It accepts the following command line parameters:
2019-06-09 00:43:57 +00:00
2019-06-09 00:58:09 +00:00
* Either `-u <url>` or `-f <file>`
2019-06-09 00:43:57 +00:00
to specify the source BinHexed file. If neither of those options
2019-06-09 00:58:09 +00:00
is present, `DeBinHex` reads `stdin`.
* `-d` to decode the data fork. It will be put in
2019-06-09 00:43:57 +00:00
the file with the name that came from the BinHex header.
2019-06-09 00:58:09 +00:00
* `-df <filename>` to decode the data fork
2019-06-09 00:43:57 +00:00
to the named file instead of the name that came from the BinHex
header.
2019-06-09 00:58:09 +00:00
* `-r` to decode the resource fork. It will be put
2019-06-09 00:43:57 +00:00
in the file with the name that came from the BinHex header, with
2019-06-09 00:58:09 +00:00
the extension "`.resource`" appended to
2019-06-09 00:43:57 +00:00
it.
2019-06-09 00:58:09 +00:00
* `-rf <filename>` to decode the resource
2019-06-09 00:43:57 +00:00
fork to the named file instead of the name that came from the
BinHex header.
2019-06-09 00:58:09 +00:00
* Both `-d`/`-df` options and `-r`/`-rf`
2019-06-09 00:43:57 +00:00
may be present at the same time. If none of these options is
2019-06-09 00:58:09 +00:00
present, `DeBinHex` will decode the data fork as if
the `-d` options was specified.
* `-h` to only show the header of the BinHex file
on `stdout`. The decoding options are ignored.
2019-06-09 00:43:57 +00:00
2019-06-09 00:58:09 +00:00
## Javadoc
2019-06-09 00:43:57 +00:00
2019-06-09 00:58:09 +00:00
The [Javadoc of the classes](https://www.klomp.org/JBinHex/javadoc/index.html) is included in the
distribution and available online.
2019-06-09 00:43:57 +00:00
2019-06-09 00:58:09 +00:00
## Download
2019-06-09 00:43:57 +00:00
2019-06-09 00:58:09 +00:00
[Download the complete package](http://www.klomp.org/packages/JBinHex.tar.gz) including source, javadoc and jarfile with classes (36 Kb).
2019-06-09 00:43:57 +00:00
2019-06-09 00:58:09 +00:00
## License
2019-06-09 00:43:57 +00:00
2019-06-09 00:58:09 +00:00
The package is licensed under the **GNU General Public License**,
also known as the GPL license. See file [COPYING](https://www.klomp.org/JBinHex/COPYING) for
details.
2019-06-09 00:43:57 +00:00
2019-06-09 00:58:09 +00:00
## References
2019-06-09 00:43:57 +00:00
2019-06-09 00:58:09 +00:00
* Article written by Yves Lempereur, available as Appendix A in [rfc1741](http://www.rfc.net/get2.php3/rfc1741.html)</A>
* Article titled [BinHex 4.0 Definition](http://wuarchive.wustl.edu/systems/mac/umich.edu/misc/documentation/binhex4.0specs.txt) by Peter N Lewis
2019-06-09 00:43:57 +00:00
2019-06-09 00:58:09 +00:00
## Copyright
2019-06-09 00:43:57 +00:00
2019-06-09 00:58:09 +00:00
All files in the package and on this site Copyright 2000 by Erwin
Bolwidt, &lt;[ejb@klomp.org](mailto:ejb@klomp.org)&gt;
2019-06-09 00:43:57 +00:00
2019-06-09 00:58:09 +00:00
----
This page was last updated at april 8, 2000.