Skip to content

Commit 7d75077

Browse files
committed
improved description
1 parent 35c1e33 commit 7d75077

File tree

2 files changed

+57
-16
lines changed

2 files changed

+57
-16
lines changed

README.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,40 @@
1010

1111
<img width="128" height="128" align="left" src="https://raw.githubusercontent.com/jonelo/jacksum/main/docs/images/jacksum_logo_128x128.png" alt="Jacksum logo" style="vertical-align:top;margin:10px 10px" />
1212

13-
**Jacksum** is a free, open source, and cross platform data integrity command line program for **recursively computing hash values** with **multiple algorithms and multiple files simultaneously**. Jacksum can perform a **verification** of hashes against a set of known hashes, and it can detect matching files, non-matching files, missing files, and new files.
13+
**Jacksum** is a free and cross-platform data integrity
14+
software for working with checksums, CRCs, and message digests
15+
(hashes).
1416

15-
Jacksum supports **471 algorithms**, including **checksums, CRCs, and message digests** (known as hash values and fingerprints). For details see the [Manpage](https://github.com/jonelo/jacksum/wiki/Manpage#algorithms) and the [Copyright](https://github.com/jonelo/jacksum/blob/main/src/main/resources/net/jacksum/legal/copyright.txt) file.
17+
Jacksum supports **471 algorithms**, including the most
18+
common cryptographic and non-cryptographic hash functions.
1619

17-
Jacksum can compute and verify hash values much faster on **multi-core processors and multi-CPU computers** if you select many files and/or many algorithms.
20+
Jacksum can **recursively compute hashes** with **multiple algorithms**
21+
**simultaneously**. Jacksum takes advantage of modern **multi-processor/
22+
multi-core** environments, and saves time by hashing multiple files
23+
in parallel.
1824

19-
Jacksum also supports **non-traditional features**. For example, it can **find an algorithm to a hash value** using brute force. For a comprehensive list of features please see also [Features](https://github.com/jonelo/jacksum#features) and the [Manpage](https://github.com/jonelo/jacksum/wiki/Manpage).
25+
Jacksum can perform a **verification of hashes** against a set of known
26+
hashes, and it can **detect matching files, non-matching files,
27+
missing files, and new files**.
28+
29+
**Output** can occur in **predefined standard formats** (BSD-, GNU/Linux-, or
30+
Solaris style, SFV or FCIV) or in a **user-defined format** which is highly
31+
customizable, including many encodings for representing hash values,
32+
including Hex, Base32, Base64, and BubbleBabble.
33+
34+
**Input data** can come from **files**, **standard input stream** (stdin), or
35+
provided directly by **command line arguments**.
36+
37+
Jacksum supports **many charsets** for reading and writing files properly,
38+
and it comes with **full support** for **all common Unicode aware
39+
charsets such as UTF-8**.
40+
41+
With Jacksum you can also **find the algorithm used to calculate a
42+
checksum/CRC/hash** or **find files that match a given hash value**.
2043

2144
Jacksum is a **command line tool**, and it can be integrated in your **file browser**, see also [Integration](https://github.com/jonelo/jacksum#integration). Jacksum can also be used as a **library** in your own projects by using its **API**. Jacksum keeps the binary small, because it bundles only what it really needs to do the job.
2245

23-
Jacksum is a synthetic word made of JAva and ChecKSUM, because Jacksum is written entirely in **Java**.
46+
Jacksum is a synthetic word made of **JAva and ChecKSUM**, because Jacksum is written entirely in Java.
2447

2548

2649
## System Requirements

src/main/resources/net/jacksum/help/help_en.txt

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
NAME
2-
jacksum - a data integrity software tool to master checksums, CRCs, and
3-
message digests (hashes)
2+
jacksum - free data integrity software for working with checksums, CRCs,
3+
and message digests (hashes)
44

55

66
VERSION
@@ -14,18 +14,36 @@ SYNOPSIS
1414
DESCRIPTION
1515
Overview:
1616
\
17-
Jacksum (JAva ChecKSUM) is a free and cross platform data integrity
18-
software tool to master checksums, CRCs, and message digests (hashes).
17+
Jacksum (JAva ChecKSUM) is a free and cross-platform data integrity
18+
software for working with checksums, CRCs, and message digests
19+
(hashes).
1920
\
20-
Jacksum supports 471 fingerprinting algorithms, and takes advantage of
21-
modern multi-processor/multi-cores environments for parallel
22-
computation and verification of hashes.
21+
Jacksum supports 471 algorithms, including the most common
22+
cryptographic and non-cryptographic hash functions.
2323
\
24-
With Jacksum you can also find the algorithm used to calculate a
25-
checksum/CRC/hash or find files that match a given hash value.
24+
Jacksum can recursively compute hashes with multiple algorithms
25+
simultaneously. Jacksum takes advantage of modern multi-processor/
26+
multi-core environments, and saves time by hashing multiple files
27+
in parallel.
28+
\
29+
Jacksum can perform a verification of hashes against a set of known
30+
hashes, and it can detect matching files, non-matching files,
31+
missing files, and new files.
2632
\
27-
Both input and output are highly customizable, including charsets,
28-
encodings, formats, and compatibility files.
33+
Output can occur in predefined standard formats (BSD-, GNU/Linux-, or
34+
Solaris style, SFV or FCIV) or in a user-defined format which is highly
35+
customizable, including many encodings for representing hash values,
36+
including Hex, Base32, Base64, and BubbleBabble.
37+
\
38+
Input data can come from files, standard input stream (stdin), or
39+
provided directly by command line arguments.
40+
\
41+
Jacksum supports many charsets for reading and writing files
42+
properly, and it comes with full support for all common Unicode aware
43+
charsets such as UTF-8.
44+
\
45+
With Jacksum you can also find the algorithm used to calculate a
46+
checksum/CRC/hash or find files that match a given hash value.
2947
\
3048
Type `jacksum -h examples` and go to https://jacksum.net to learn more
3149
about Jacksum.

0 commit comments

Comments
 (0)