mirror of
https://github.com/umjammer/JBinHex.git
synced 2024-11-21 14:32:46 +00:00
update readme
This commit is contained in:
parent
30a46ddfba
commit
73acb7b1fb
110
README.md
110
README.md
@ -1,103 +1,81 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>JBinHex</TITLE>
|
||||
</HEAD>
|
||||
<BODY BGCOLOR="#ffffff" LINK="#ff0000" ALINK="#ff00ff" VLINK="#990000">
|
||||
# JBinHex
|
||||
|
||||
<H1 ALIGN="center">JBinHex</H1>
|
||||
|
||||
<P><FONT SIZE=+1>
|
||||
JBinHex is both a library and a command-line tool to decode files in
|
||||
the Apple Macintosh BinHex 4.0 format.
|
||||
</FONT></P>
|
||||
|
||||
<H2>Current version: 0.5</H2>
|
||||
## Current version: 0.5
|
||||
|
||||
<H3>Version history:</H3>
|
||||
## Version history
|
||||
|
||||
<DL>
|
||||
<DT>0.5
|
||||
<DD>First released version
|
||||
</DL>
|
||||
* 0.5 First released version
|
||||
|
||||
<H3>Limitations in this version:</H3>
|
||||
## Limitations in this version
|
||||
|
||||
<MENU>
|
||||
<LI>This version does not support segmented files such as used
|
||||
on comp.binaries.mac.* newsgroups
|
||||
<LI>Documentation is limited
|
||||
<LI>Command line tool has does not check wether the command line
|
||||
* 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
|
||||
parameters are completely correct
|
||||
</MENU>
|
||||
|
||||
<H3>Possible future features:</H3>
|
||||
## Possible future features
|
||||
|
||||
<UL>
|
||||
<LI>Encoding of BinHex files
|
||||
<LI>File-based interface that allows to switch between data and
|
||||
* Encoding of BinHex files
|
||||
* File-based interface that allows to switch between data and
|
||||
resource fork at any moment, instead of the predetermined order
|
||||
that the stream-based interface dictates
|
||||
</UL>
|
||||
|
||||
<H3>Command-line tool</H3>
|
||||
## Command-line tool
|
||||
|
||||
<P>The class name of the command-line tool is <CODE>org.gjt.convert.binhex.DeBinHex</CODE></P>
|
||||
The class name of the command-line tool is `org.gjt.convert.binhex.DeBinHex`
|
||||
|
||||
<P>It accepts the following command line parameters:</P>
|
||||
It accepts the following command line parameters:
|
||||
|
||||
<MENU>
|
||||
<LI>Either <CODE>-u <url></CODE> or <CODE>-f <file></CODE>
|
||||
* Either `-u <url>` or `-f <file>`
|
||||
to specify the source BinHexed file. If neither of those options
|
||||
is present, <CODE>DeBinHex</CODE> reads <CODE>stdin</CODE>.
|
||||
<LI><CODE>-d</CODE> to decode the data fork. It will be put in
|
||||
is present, `DeBinHex` reads `stdin`.
|
||||
* `-d` to decode the data fork. It will be put in
|
||||
the file with the name that came from the BinHex header.
|
||||
<LI><CODE>-df <filename></CODE> to decode the data fork
|
||||
* `-df <filename>` to decode the data fork
|
||||
to the named file instead of the name that came from the BinHex
|
||||
header.
|
||||
<LI><CODE>-r</CODE> to decode the resource fork. It will be put
|
||||
* `-r` to decode the resource fork. It will be put
|
||||
in the file with the name that came from the BinHex header, with
|
||||
the extension "<CODE>.resource</CODE>" appended to
|
||||
the extension "`.resource`" appended to
|
||||
it.
|
||||
<LI><CODE>-rf <filename></CODE> to decode the resource
|
||||
* `-rf <filename>` to decode the resource
|
||||
fork to the named file instead of the name that came from the
|
||||
BinHex header.
|
||||
<LI>Both <CODE>-d</CODE>/<CODE>-df</CODE> options and <CODE>-r</CODE>/<CODE>-rf</CODE>
|
||||
* Both `-d`/`-df` options and `-r`/`-rf`
|
||||
may be present at the same time. If none of these options is
|
||||
present, <CODE>DeBinHex</CODE> will decode the data fork as if
|
||||
the <CODE>-d</CODE> options was specified.
|
||||
<LI><CODE>-h</CODE> to only show the header of the BinHex file
|
||||
on <CODE>stdout</CODE>. The decoding options are ignored.
|
||||
</MENU>
|
||||
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.
|
||||
|
||||
<H3>Javadoc</H3>
|
||||
The <A HREF="javadoc/index.html">Javadoc of the classes</A> is included in the
|
||||
## Javadoc
|
||||
|
||||
The [Javadoc of the classes](https://www.klomp.org/JBinHex/javadoc/index.html) is included in the
|
||||
distribution and available online.
|
||||
|
||||
<H3>Download</H3>
|
||||
## Download
|
||||
|
||||
<P><A HREF="http://www.klomp.org/packages/JBinHex.tar.gz">Download the complete package</A> including source, javadoc and jarfile with classes (36 Kb).</P>
|
||||
[Download the complete package](http://www.klomp.org/packages/JBinHex.tar.gz) including source, javadoc and jarfile with classes (36 Kb).
|
||||
|
||||
<H3>License</H3>
|
||||
## License
|
||||
|
||||
<P>The package is licensed under the <B>GNU General Public License</B>,
|
||||
also known as the GPL license. See file <A HREF="COPYING">COPYING</A> for
|
||||
details.</P>
|
||||
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.
|
||||
|
||||
<H3>References</H3>
|
||||
## References
|
||||
|
||||
<UL>
|
||||
<LI>Article written by Yves Lempereur, available as Appendix A in <A HREF="http://www.rfc.net/get2.php3/rfc1741.html">rfc1741</A>
|
||||
<LI>Article titled <A HREF="http://wuarchive.wustl.edu/systems/mac/umich.edu/misc/documentation/binhex4.0specs.txt">"BinHex 4.0 Definition"</A> by Peter N Lewis
|
||||
</UL>
|
||||
* 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
|
||||
|
||||
<H3>Copyright</H3>
|
||||
## Copyright
|
||||
|
||||
<P>All files in the package and on this site Copyright 2000 by Erwin
|
||||
Bolwidt, <<A HREF="mailto:ejb@klomp.org">ejb@klomp.org</A>></P>
|
||||
All files in the package and on this site Copyright 2000 by Erwin
|
||||
Bolwidt, <[ejb@klomp.org](mailto:ejb@klomp.org)>
|
||||
|
||||
<HR ALIGN=LEFT>
|
||||
<FONT SIZE="-1">This page was last updated at april 8, 2000.</FONT>
|
||||
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
----
|
||||
This page was last updated at april 8, 2000.
|
||||
|
Loading…
Reference in New Issue
Block a user