aboutsummaryrefslogtreecommitdiff
path: root/src/alfsum.rst
blob: d02f24d051e14b9775e07290775595a971e42072 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
.. RST source for alfsum(1) man page. Convert with:
..   rst2man.py alfsum.rst > alfsum.1

.. include:: ver.rst

.. |date| date::

======
alfsum
======

-----------------------
calculate ALF checksums
-----------------------

:Manual section: 1
:Manual group: Urchlay's Atari 8-bit Tools
:Date: |date|
:Version: |version|

SYNOPSIS
========

alfsum **file** [**file** ...] | [**--help** | **-h**] | [**--version** | **-V**] 

DESCRIPTION
===========

**alfsum** calculates the checksums used by the **ALF** compression
utility on the Atari 8-bit platform.

To read from standard input, use **-** as a filename.

Output lines have a tab separating the checksum and filename, for ease
of scripting (e.g. with **cut**\(1) or **awk**\(1)).

**alfsum**'s primary use is to check files extracted from **ALF**
archives against the checksums stored in the archive. The **unalf**
program already does this, but **alfsum** is a separate (much simpler)
program. It serves as a second opinion, in case you suspect a bug in
**unalf**.

OPTIONS
=======

-h, --help
   Show built-in help message.

-V, --version
  Show **alfsum** version number and exit.

NOTES
=====

The checksum algorithm is very simple: all the bytes in the file are
added together, and the low 16 bits of the result are the checksum.

EXIT STATUS
===========

0
  Success.

1 to 254
  File I/O error count. If there are more than 254 I/O errors, 254 is returned.

255
  Error in command-line arguments: no filenames given.

COPYRIGHT
=========

**alfsum** is released under the WTPFL: Do WTF you want with this.

AUTHORS
=======

B. Watson <urchlay@slackware.uk>

SEE ALSO
========

**unalf**\(1)

.. include:: manftr.rst