Browse Source

README: rework into a Ronn manpage

master
Matteo Cypriani 1 year ago
parent
commit
9f741a4bd0
2 changed files with 78 additions and 23 deletions
  1. 8
    0
      Makefile
  2. 70
    23
      README.md

+ 8
- 0
Makefile View File

@@ -0,0 +1,8 @@
1
+# This Makefile is meant to generate the documentation.
2
+# To build the project, use Cargo directly!
3
+
4
+RONN = ronn
5
+MANPAGE = nrgrip.1
6
+
7
+$(MANPAGE): README.md
8
+	$(RONN) <$< >$@

+ 70
- 23
README.md View File

@@ -1,50 +1,68 @@
1
-NRGrip - extract audio data and cue sheet from an NRG audio CD image
2
-====================================================================
1
+nrgrip(1) - rip Nero Burning ROM audio NRG images
2
+=================================================
3 3
 
4
-This program works on a Nero Burning ROM's NRG image of an audio CD and is able
5
-to:
4
+SYNOPSIS
5
+--------
6 6
 
7
-- read and display its metadata;
7
+`nrgrip` [-icrx] [options] <image.nrg>
8 8
 
9
-- extract the cue sheet;
9
+`nrgrip` [-h | -V]
10 10
 
11
-- extract the raw audio tracks as one single file, which can then be encoded by
11
+DESCRIPTION
12
+-----------
13
+
14
+NRGrip works on a Nero Burning ROM's NRG image of an audio CD and is able to:
15
+
16
+* read and display its metadata;
17
+
18
+* extract the cue sheet;
19
+
20
+* extract the raw audio tracks as one single file, which can then be encoded by
12 21
   the user to a more convenient audio format such as FLAC, and possibly split
13 22
   according to the cue sheet.
14 23
 
15 24
 For now, only NRG v2 is handled (not NRG v1), and not all of the metadata chunks
16 25
 are decoded. If you have interest in adding support for additional chunks or
17
-formats and have a test image handy, please contact the author or open a
18
-ticket. In particular, it would be interesting to support ISRC/CD-Text; handling
26
+formats and have a test image handy, please contact the author or open an
27
+issue. In particular, it would be interesting to support ISRC/CD-Text; handling
19 28
 of multisession and hybrid (audio and data) discs would also be a nice feature.
20 29
 
21
-NRGrip is licensed under the terms of the Expat (MIT) license. See the `COPYING`
22
-file.
30
+OPTIONS
31
+-------
23 32
 
33
+At least one action switch must be provided, along with any number of option
34
+switches.
24 35
 
25
-Installing
26
-----------
36
+### Actions
27 37
 
28
-NRGrip is written in Rust. Make sure [Cargo](http://doc.crates.io/) is installed
29
-on your system, then:
38
+* `-i`, `--info`:
39
+  display the NRG image metadata (default action)
30 40
 
31
-    cargo build --release
32
-    cargo install
41
+* `-c`, `--extract-cue`:
42
+  extract cue sheet from the NRG metadata
43
+
44
+* `-r`, `--extract-raw`:
45
+  extract the raw audio tracks
33 46
 
47
+* `-x`, `--extract`:
48
+  same as `-cr`
34 49
 
35
-Usage
36
------
50
+### Additional options
37 51
 
38
-To see the full usage, run:
52
+* `-S`, `--no-strip-subchannel`:
53
+  don't strip the 96-bit subchannel from the extracted audio data (this option
54
+  has no effect if the input image has standard 2352-byte sector size)
39 55
 
40
-    nrgrip --help
56
+EXAMPLE
57
+-------
41 58
 
42
-Basically, you can display the metadata and extract the data with:
59
+The following command will display the metadata and extract both the cue sheet
60
+and the audio data:
43 61
 
44 62
     nrgrip -ix image.nrg
45 63
 
46 64
 The cue sheet will be extracted as `image.cue`, and the audio data as
47
-`image.raw`.
65
+`image.raw` in the current directory.
48 66
 
49 67
 The raw audio data from a CD is 16 bit, little endian, 44100 Hz, stereo. To
50 68
 play it, you may use, for instance, `aplay` from the ALSA utils, or `ffplay`
@@ -70,3 +88,32 @@ To split the FLAC file according to the cue sheet, you may use,
70 88
 Or [mp3splt](http://mp3splt.sourceforge.net/):
71 89
 
72 90
     mp3splt -c image.cue image.flac
91
+
92
+INSTALLATION
93
+------------
94
+
95
+NRGrip is written in Rust. Make sure [Cargo](http://doc.crates.io/) is installed
96
+on your system, then you can install directly from the Git repository with:
97
+
98
+    cargo install --git https://code.lm7.fr/mcy/nrgrip.git
99
+
100
+Or if you cloned the repository already:
101
+
102
+    cargo build --release
103
+    cargo install
104
+
105
+You may also generate the manpage with:
106
+
107
+    make
108
+
109
+COPYRIGHT
110
+---------
111
+
112
+NRGrip was written by Matteo Cypriani <<mcy@lm7.fr>> and is licensed under the
113
+terms of the Expat (MIT) license. See the [COPYING](COPYING) file.
114
+
115
+SEE ALSO
116
+--------
117
+
118
+Additional information can be found on
119
+[NRGrip's wiki](https://code.lm7.fr/mcy/nrgrip/wiki).

Loading…
Cancel
Save