trunk/man/gigdump.1.in

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