trunk/man/gigdump.1.in

.TH "gigdump" "1" "08 May 2018" "libgig @VERSION@" "libgig tools"
.SH NAME
gigdump \- List information about a Gigasampler (.gig) file.
.SH SYNOPSIS
.B gigdump
[OPTIONS] GIGFILE
.SH DESCRIPTION
By default it prints out a list of all available samples, real-time instrument
scripts and instruments within a Gigasampler (.gig) file, along with detailed
information about their properties and settings.
.SH OPTIONS
.TP
.B \ GIGFILE
filename of the Gigasampler file
.TP
.B \ --instrument-names
Only list instrument names and their index number.
.TP
.B \ --rebuild-checksums
Rebuild checksum table for all samples. Read description of
.B \ --verify
option for more details about sample checksums in general. Usually you only
need to use
.B \ --rebuild-checksums
in case the samples' CRC checksum table itself was damaged. The
.B \ --verify
option will tell you if that is really the case and will suggest to you to use
.B \ --rebuild-checksums
to repair the table in such cases. If only individual samples were damaged, you
rather might want to replace only those damaged samples with
.BR gigedit (1)
for example. Read description of 
.B \ --verify
for reasons to do so. When using
.B \ --rebuild-checksums
all checksums of all samples will be regenerated. Hence you should manually
check all samples once after using this option. That is by using your ears,
or by exporting the samples, but not by using the
.B \ --verify
option. Because the latter cannot identifiy damaged samples that have been
damaged before the entire checksum table had been regenerated.
.TP
.B \ -v
Print version and exit.
.TP
.B \ --verify
Check raw wave data integrity of all samples and print result of this check.
For all samples of a gig file a correspondig CRC32 checksum is stored along
to its raw wave form data whenever a conscious change to the wave form data
was performed. By calling gigdump with this option all samples are scanned
and compared with their existing checksums to detect any damage to
individual samples. The individual damaged samples are listed by gigdump
in this case. Since essentially the entire file has to be read, this can
take a long time and hence this check is not by default performed i.e.
each time a gig file is loaded for regular use for example. Accordingly you
may use
.B \ --verify
from time to time to check explicitly whether your gig files have been
damaged for some reason, i.e. after modifying them with an instrument editor
like
.BR gigedit (1).
In case damaged samples were found, you may replace those damaged samples with
.BR gigedit (1).
By doing this, only the replaced samples' checksums will be
updated. All other checksums remain untouched. That's why this approach is
recommended over using 
.B \ --rebuild-checksums
in such cases.

.SH "SEE ALSO"
.BR gigextract(1),
.BR gigmerge(1),
.BR gig2mono(1),
.BR gig2stereo(1),
.BR wav2gig(1),
.BR dlsdump(1),
.BR rifftree(1),
.BR akaidump(1),
.BR sf2dump(1),
.BR korgdump(1)

.SH "BUGS"
Check and report bugs at http://bugs.linuxsampler.org
.SH "Author"
Application and manual page written by Christian Schoenebeck <cuse@users.sf.net>
1	schoenebeck	3425	.TH "gigdump" "1" "08 May 2018" "libgig @VERSION@" "libgig tools"
2	schoenebeck	518	.SH NAME
3	schoenebeck	3048	gigdump \- List information about a Gigasampler (.gig) file.
4	schoenebeck	518	.SH SYNOPSIS
5			.B gigdump
6	schoenebeck	2985	[OPTIONS] GIGFILE
7	schoenebeck	518	.SH DESCRIPTION
8	schoenebeck	2985	By default it prints out a list of all available samples, real-time instrument
9			scripts and instruments within a Gigasampler (.gig) file, along with detailed
10	schoenebeck	3048	information about their properties and settings.
11	schoenebeck	518	.SH OPTIONS
12			.TP
13			.B \ GIGFILE
14			filename of the Gigasampler file
15			.TP
16	schoenebeck	3425	.B \ --instrument-names
17			Only list instrument names and their index number.
18			.TP
19	schoenebeck	2985	.B \ --rebuild-checksums
20			Rebuild checksum table for all samples. Read description of
21	schoenebeck	3047	.B \ --verify
22	schoenebeck	2985	option for more details about sample checksums in general. Usually you only
23			need to use
24	schoenebeck	3047	.B \ --rebuild-checksums
25	schoenebeck	2985	in case the samples' CRC checksum table itself was damaged. The
26	schoenebeck	3047	.B \ --verify
27	schoenebeck	2985	option will tell you if that is really the case and will suggest to you to use
28	schoenebeck	3047	.B \ --rebuild-checksums
29	schoenebeck	2986	to repair the table in such cases. If only individual samples were damaged, you
30			rather might want to replace only those damaged samples with
31			.BR gigedit (1)
32			for example. Read description of
33	schoenebeck	3047	.B \ --verify
34	schoenebeck	2986	for reasons to do so. When using
35	schoenebeck	3047	.B \ --rebuild-checksums
36	schoenebeck	2986	all checksums of all samples will be regenerated. Hence you should manually
37			check all samples once after using this option. That is by using your ears,
38			or by exporting the samples, but not by using the
39	schoenebeck	3047	.B \ --verify
40	schoenebeck	2986	option. Because the latter cannot identifiy damaged samples that have been
41			damaged before the entire checksum table had been regenerated.
42	schoenebeck	2985	.TP
43	schoenebeck	518	.B \ -v
44	schoenebeck	2985	Print version and exit.
45			.TP
46			.B \ --verify
47			Check raw wave data integrity of all samples and print result of this check.
48			For all samples of a gig file a correspondig CRC32 checksum is stored along
49			to its raw wave form data whenever a conscious change to the wave form data
50			was performed. By calling gigdump with this option all samples are scanned
51			and compared with their existing checksums to detect any damage to
52			individual samples. The individual damaged samples are listed by gigdump
53			in this case. Since essentially the entire file has to be read, this can
54			take a long time and hence this check is not by default performed i.e.
55			each time a gig file is loaded for regular use for example. Accordingly you
56			may use
57	schoenebeck	3047	.B \ --verify
58	schoenebeck	2985	from time to time to check explicitly whether your gig files have been
59			damaged for some reason, i.e. after modifying them with an instrument editor
60			like
61			.BR gigedit (1).
62	schoenebeck	2986	In case damaged samples were found, you may replace those damaged samples with
63			.BR gigedit (1).
64			By doing this, only the replaced samples' checksums will be
65			updated. All other checksums remain untouched. That's why this approach is
66			recommended over using
67	schoenebeck	3047	.B \ --rebuild-checksums
68	schoenebeck	2986	in such cases.
69	schoenebeck	2543
70	schoenebeck	518	.SH "SEE ALSO"
71	schoenebeck	2543	.BR gigextract(1),
72			.BR gigmerge(1),
73			.BR gig2mono(1),
74	schoenebeck	2685	.BR gig2stereo(1),
75	schoenebeck	3980	.BR wav2gig(1),
76	schoenebeck	2778	.BR dlsdump(1),
77			.BR rifftree(1),
78			.BR akaidump(1),
79			.BR sf2dump(1),
80			.BR korgdump(1)
81	schoenebeck	2543
82	schoenebeck	518	.SH "BUGS"
83	schoenebeck	2778	Check and report bugs at http://bugs.linuxsampler.org
84	schoenebeck	518	.SH "Author"
85	schoenebeck	2778	Application and manual page written by Christian Schoenebeck <cuse@users.sf.net>