Skip to content

Commit 2e573ad

Browse files
committed
README: fix title levels
1 parent a716a6a commit 2e573ad

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# This is my version of brkirch's afsctool
1+
# afcstool
22

33
> AFSC (Apple File System Compression) tool is a utility that can be used
44
to apply HFS+ compression to file(s), decompress HFS+ compressed file(s), or
55
get information about existing HFS+ compressed file(s).
66
Mac OS 10.6 or later is required. See: https://brkirch.wordpress.com/afsctool/
77

8-
I have made several modifications, mostly concerning the compression feature:
8+
I (RJVB) have made several modifications, mostly concerning the compression feature:
99
- improved error reporting
1010
- an attempt to reduce memory pressure compressing large files
1111
- support for multiple files/folders specified on the commandline
@@ -15,7 +15,6 @@ I have made several modifications, mostly concerning the compression feature:
1515
temporarily. No error checking is done for this feature; failure will lead to
1616
errors that are already caught.
1717

18-
1918
The main new feature that justifies the version bump, however, is the parallel
2019
processing feature, allowing the user to specify an arbitray (though positive :))
2120
number of threads that will compress the specified files in parallel.
@@ -27,6 +26,7 @@ This feature has two modes that each perform best in specific conditions:
2726
state disks, file collections that reside on different disks or collections with
2827
files of different sizes (including notably very large files). This mode is
2928
selected with the -J option.
29+
3030
The performance difference is never enormous in my testing, but YMMV.
3131

3232
Interestingly, the optimum performance (on large collections) is not necessarily
@@ -53,27 +53,27 @@ and later. Currently only LZVN support is fully implemented (though decompressio
5353
should work if the OS supports it). Note that LZVN support requires a headerfile not
5454
currently installed by the original author's LZVN repo; use my fork instead and build it
5555
with cmake. --> https://github.com/RJVB/LZVN
56+
5657
This version also makes the current ZLIB compression mode optional, that uses a compression
5758
buffer that is allocated all at once (and is thus almost always too large. The new default
5859
mode adopts the approach also used for LZVN compression, where the memory buffer is grown
5960
as needed and thus only gets as large as needed (typically 4-5x smaller than in the singleshot
6061
mode). Singleshot mode might be marginally faster when enough RAM is available.
6162

62-
63-
### Installation
63+
## Installation
6464

6565
afsctool depends on zlib (v1.2.8 or newer) and Google's sparsehash library and on CMake
6666
and pkgconfig for building. The OS zlib copy may be recent enough (it is on 10.12 and later) but to be
6767
certain to obtain the latest versions of both, use a package manager like MacPorts, Fink
6868
or HomeBrew. Be sure to follow the general installation and usage instructions for those
6969
projects, in particular how to update your PATH.
7070

71-
# using MacPorts:
71+
### Using MacPorts:
7272
```shell
7373
port install sparsehash zlib cmake pkgconfig
7474
```
7575

76-
# using HomeBrew:
76+
### Using HomeBrew:
7777
```shell
7878
brew install google-sparsehash zlib cmake pkgconfig
7979
PKG_CONFIG_PATH=/usr/local/opt/zlib/lib/pkgconfig
@@ -98,12 +98,9 @@ cd afsctool/build
9898
sudo make install/fast V=1 VERBOSE=1
9999
```
100100

101-
# A word about the other executable (zfsctool)
102-
101+
## zfcstool
103102
This repository also builds another utility, `zfsctool`.
104103

105-
## zfsctool
106-
107104
This is a stripped-down and adapted version of `afsctool`, aiming to provide a comparable
108105
offline/post-hoc *re*compression of selected files and folders on ZFS as `afsctool` does
109106
on HFS+ and APFS.

0 commit comments

Comments
 (0)