From 73acb7b1fb50c699fe8b21f5cb9189871f383feb Mon Sep 17 00:00:00 2001 From: umjammer Date: Sun, 9 Jun 2019 09:58:09 +0900 Subject: [PATCH] update readme --- README.md | 110 ++++++++++++++++++++++-------------------------------- 1 file changed, 44 insertions(+), 66 deletions(-) diff --git a/README.md b/README.md index f655e5f..ee019e7 100644 --- a/README.md +++ b/README.md @@ -1,103 +1,81 @@ - - - JBinHex - - +# JBinHex -

JBinHex

- -

JBinHex is both a library and a command-line tool to decode files in the Apple Macintosh BinHex 4.0 format. -

-

Current version: 0.5

+## Current version: 0.5 -

Version history:

+## Version history -
-
0.5 -
First released version -
+ * 0.5 First released version -

Limitations in this version:

+## Limitations in this version - -
  • 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 + * 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 -
    •  -

    Possible future features:

    +## Possible future features - -

    Command-line tool

    +## Command-line tool -

    The class name of the command-line tool is org.gjt.convert.binhex.DeBinHex

    +The class name of the command-line tool is `org.gjt.convert.binhex.DeBinHex` -

    It accepts the following command line parameters:

    +It accepts the following command line parameters: - -
  • Either -u <url> or -f <file> + * Either `-u <url>` or `-f <file>` to specify the source BinHexed file. If neither of those options - is present, DeBinHex reads stdin. -
  • -d 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. -
  • -df <filename> 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. -
  • -r 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 ".resource" appended to + the extension "`.resource`" appended to it. -
  • -rf <filename> 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. -
  • Both -d/-df options and -r/-rf + * Both `-d`/`-df` options and `-r`/`-rf` may be present at the same time. If none of these options is - 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. -
    •  + 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. -

    Javadoc

    -The Javadoc of the classes 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. -

    Download

    +## Download -

    Download the complete package including source, javadoc and jarfile with classes (36 Kb).

    +[Download the complete package](http://www.klomp.org/packages/JBinHex.tar.gz) including source, javadoc and jarfile with classes (36 Kb). -

    License

    +## License -

    The package is licensed under the GNU General Public License, -also known as the GPL license. See file COPYING for -details.

    +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. -

    References

    +## References - + * Article written by Yves Lempereur, available as Appendix A in [rfc1741](http://www.rfc.net/get2.php3/rfc1741.html) + * Article titled [BinHex 4.0 Definition](http://wuarchive.wustl.edu/systems/mac/umich.edu/misc/documentation/binhex4.0specs.txt) by Peter N Lewis -

    Copyright

    +## Copyright -

    All files in the package and on this site Copyright 2000 by Erwin -Bolwidt, <ejb@klomp.org>

    +All files in the package and on this site Copyright 2000 by Erwin +Bolwidt, <[ejb@klomp.org](mailto:ejb@klomp.org)> -
    -This page was last updated at april 8, 2000. - - - - +---- +This page was last updated at april 8, 2000.