Skip to content

Commit 364fa71

Browse files
committed
Clean up AsciiDoc formating, prefer prefix headings
1 parent 57d5ae2 commit 364fa71

File tree

3 files changed

+21
-43
lines changed

3 files changed

+21
-43
lines changed

NEWS.adoc

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,42 @@
1-
1.5 (2017-08-16)
2-
----------------
1+
== 1.5 (2017-08-16)
32

43
* reflac has learned to preserve an embedded image in FLAC files.
54
Limited to just one image for now, but should cover the most
65
common case.
76

8-
9-
1.4 (2016-12-16)
10-
----------------
7+
== 1.4 (2016-12-16)
118

129
* Add an option to preserve the file modification time.
1310

14-
1.3 (2016-09-25)
15-
----------------
11+
== 1.3 (2016-09-25)
1612

1713
* Use the rf64 format during processing, eliminating the 4GiB
1814
uncompressed file size limit. This is primarily useful for FLACs
1915
with lots of channels (eg, surround sound) and high sample sizes
2016
and rates, as the 4GiB limit isn’t otherwise likely to be hit.
2117

22-
1.2.3 (2016-07-10)
23-
------------------
18+
== 1.2.3 (2016-07-10)
2419

2520
* Actually bump the script’s own version identifier.
2621

27-
1.2.2 (2016-07-10)
28-
------------------
22+
== 1.2.2 (2016-07-10)
2923

3024
* The first bash in the $PATH is used instead of /bin/bash
3125
* Shift temporary directory creation after getopt. reflac won’t
3226
leave one around anymore after ambiguous options (such as “--v”
3327
expanding to both “--verbose” and “--version”).
3428

35-
1.2.1 (2016-04-28)
36-
------------------
29+
== 1.2.1 (2016-04-28)
3730

3831
* Remove the temporary directory also after using `--version`
3932

40-
1.2 (2016-04-28)
41-
----------------
33+
== 1.2 (2016-04-28)
4234

4335
* Sync data by default, add `--no-sync` to disable. The new
4436
versions of FLACs files are written out to prevent
4537
missing/incomplete files in the face of a crash.
4638

47-
1.1 (2016-04-25)
48-
----------------
39+
== 1.1 (2016-04-25)
4940

5041
* Add `--no-action`, enabling the view of files that would be
5142
processed.
@@ -56,20 +47,17 @@
5647
* Use a temporary staging directory, avoiding the possibility of
5748
losing all existing tag data in the face of errors.
5849

59-
1.0 (2016-04-17):
60-
-----------------
50+
== 1.0 (2016-04-17)
6151

6252
* Use the so-called “bash strict mode” and enable better processing
6353
of special file names.
6454

65-
0.2 (2015-05-18):
66-
-----------------
55+
== 0.2 (2015-05-18)
6756

6857
* Added a recursive option, allowing a whole tree to be
6958
recompressed.
7059

71-
0.1 (2014-02-26):
72-
-----------------
60+
== 0.1 (2014-02-26)
7361

7462
* Initial release, expanded from a ~7 line script the author
7563
initially wrote around 2003.

README.adoc

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
reflac
2-
======
1+
= reflac
32

43
This is a script that allows you to recompress FLAC files while
54
preserving their tags, intended for whole directories and for safety
@@ -19,8 +18,7 @@ black/white display iPod, and found that `flac -3` was the maximum he
1918
could compress FLACs while maintaining uninterrupted playback on the
2019
device.
2120

22-
Requirements
23-
------------
21+
== Requirements
2422

2523
Both `flac` and `metaflac` need to be in your $PATH. These programs
2624
are normally packaged together as “flac” by distributions.
@@ -33,8 +31,7 @@ compatibility with the same switches found in the GNU versions.
3331
reflac has only been developed on tested on GNU+Linux, but should work
3432
on any other operating system with the appropriate tools.
3533

36-
Safety
37-
------
34+
== Safety
3835

3936
By default, reflac performs a sync on files after two points of its
4037
process: after moving the recompressed file from the temporary
@@ -52,8 +49,7 @@ scenarios should arise in the worst case:
5249
processed, which may or may not be a complete FLAC file, the status
5350
of which can be tested with `flac -t`.
5451

55-
Running
56-
-------
52+
== Running
5753

5854
....
5955
Usage: reflac [OPTION]... [--] DIRECTORY...
@@ -79,8 +75,7 @@ files. Optionally terminate the argument list with -- so that any
7975
possible directory names don’t get misinterpreted as arguments.
8076
....
8177

82-
Bugs
83-
----
78+
== Bugs
8479

8580
What, bugs? This program is flawless! Joking aside, although the
8681
author tries to resolve in reflac itself, it is at the mercy of bugs

reflac.adoc

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
1-
reflac(1)
2-
=========
1+
= reflac(1)
32
:doctype: manpage
43

54

6-
NAME
7-
----
5+
== NAME
86
reflac - recompress FLAC files
97

10-
SYNOPSIS
11-
--------
8+
== SYNOPSIS
129
*reflac* ['OPTIONS'...] ['--'] 'DIRECTORY'...
1310

14-
DESCRIPTION
15-
-----------
11+
== DESCRIPTION
1612
reflac recompresses FLAC files while preserving all of their tags, and
1713
one embedded image. It should always be safe to run, it handles cases
1814
of special file names well, allowing odd characters such as *, ?, |,
@@ -69,7 +65,6 @@ encoding and decoding. Real-time playback may not be possible on some
6965
embedded-type systems, such as Blu-ray players or portable music
7066
players.
7167

72-
COPYRIGHT
73-
---------
68+
== COPYRIGHT
7469
reflac is licensed under a very permissive ISC license, the same
7570
prefered by OpenBSD. See *COPYING* in the distribution for details.

0 commit comments

Comments
 (0)