Macintosh-Tools/JBinHex
1
0
Fork 0
mirror of https://github.com/umjammer/JBinHex.git synced 2024-11-21 14:32:46 +00:00
Code Issues Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
umjammer 2019-06-09 09:58:09 +09:00
parent 30a46ddfba
commit 73acb7b1fb
1 changed files with 44 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
README.md
View File

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