Mercurial > hg > sidinfo
annotate README.txt @ 320:e315bed7d791
Minor cleanup.
| author | Matti Hamalainen <ccr@tnsp.org> |
|---|---|
| date | Sat, 11 Jan 2020 20:18:24 +0200 |
| parents | 887b67891105 |
| children | d056f284184b |
| rev | line source |
|---|---|
|
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
1 SIDInfo - PSID/RSID information displayer |
| 119 | 2 Programmed and designed by Matti 'ccr' Hämäläinen |
| 233 | 3 (C) Copyright 2014-2020 Tecnic Software productions (TNSP) |
|
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
4 |
|
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
5 See COPYING for license information. |
|
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
6 |
| 248 | 7 For contacting the author, e-mail is preferred: ccr@tnsp.org |
|
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
8 |
|
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
9 ----------------------------------------------------------------------- |
|
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
10 |
|
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
11 Requirements |
|
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
12 ============ |
|
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
13 The compilation and usage of these utilities requires following |
|
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
14 software packages or functional equivalents installed: |
|
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
15 |
| 233 | 16 - GCC or some other C99 compatible C compiler like Clang. |
|
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
17 - GNU Make |
|
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
18 |
| 43 | 19 - th-libs library (included in the tar/zip packages, |
| 20 for building from mercurial repo, see "how to build") | |
|
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
21 |
|
157
8fc887cb56d0
Implement iconv support for converting from PSID de-facto latin-1/ISO-8859-*
Matti Hamalainen <ccr@tnsp.org>
parents:
153
diff
changeset
|
22 - libiconv (optional, for converting ISO-8859/Latin-1 encoded |
|
8fc887cb56d0
Implement iconv support for converting from PSID de-facto latin-1/ISO-8859-*
Matti Hamalainen <ccr@tnsp.org>
parents:
153
diff
changeset
|
23 text used in HVSC SID files and STIL database to whatever |
|
8fc887cb56d0
Implement iconv support for converting from PSID de-facto latin-1/ISO-8859-*
Matti Hamalainen <ccr@tnsp.org>
parents:
153
diff
changeset
|
24 character set your system is using, like UTF-8.) |
|
8fc887cb56d0
Implement iconv support for converting from PSID de-facto latin-1/ISO-8859-*
Matti Hamalainen <ccr@tnsp.org>
parents:
153
diff
changeset
|
25 |
|
8fc887cb56d0
Implement iconv support for converting from PSID de-facto latin-1/ISO-8859-*
Matti Hamalainen <ccr@tnsp.org>
parents:
153
diff
changeset
|
26 |
| 233 | 27 For Linux -> Win32/64 cross-compilation I have used the MinGW packages |
| 28 from Debian Testing (wheezy), installable via "apt-get mingw-w64". | |
|
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
29 |
|
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
30 Please don't ask me for help to get cross-compilation working. |
|
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
31 |
|
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
32 ----------------------------------------------------------------------- |
|
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
33 |
|
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
34 How to build |
|
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
35 ============ |
| 30 | 36 0) If building from Mercurial repo, you need th-libs: |
| 37 | |
|
295
887b67891105
Refer to https:// URL instead of http://
Matti Hamalainen <ccr@tnsp.org>
parents:
290
diff
changeset
|
38 $ hg clone https://tnsp.org/hg/th-libs |
|
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
39 |
| 30 | 40 1) Possibly edit Makefile / Makefile.w32 |
| 41 | |
| 76 | 42 2) $ make |
| 30 | 43 |
|
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
44 or, if cross-compiling to Win32 via MinGW |
| 30 | 45 |
| 76 | 46 $ make -f Makefile.w32 |
|
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
47 |
| 30 | 48 3) ??? |
|
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
49 |
| 30 | 50 4) If it works -> Happy fun times \:D\ |
|
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
51 |
|
96
b6bf182bd37f
Add line about 'make install'.
Matti Hamalainen <ccr@tnsp.org>
parents:
76
diff
changeset
|
52 5) sudo make install |
|
b6bf182bd37f
Add line about 'make install'.
Matti Hamalainen <ccr@tnsp.org>
parents:
76
diff
changeset
|
53 |
|
284
5dfe7846e902
Document the support of "HVSC_BASE" environment variable.
Matti Hamalainen <ccr@tnsp.org>
parents:
282
diff
changeset
|
54 6) Optionally set "HVSC_BASE" environment variable |
|
5dfe7846e902
Document the support of "HVSC_BASE" environment variable.
Matti Hamalainen <ccr@tnsp.org>
parents:
282
diff
changeset
|
55 somewhere to point to your HVSC root directory |
|
5dfe7846e902
Document the support of "HVSC_BASE" environment variable.
Matti Hamalainen <ccr@tnsp.org>
parents:
282
diff
changeset
|
56 aka "/somewhere/C64Music", so you don't need to |
|
5dfe7846e902
Document the support of "HVSC_BASE" environment variable.
Matti Hamalainen <ccr@tnsp.org>
parents:
282
diff
changeset
|
57 specify it via the -H option. This way sidinfo |
|
5dfe7846e902
Document the support of "HVSC_BASE" environment variable.
Matti Hamalainen <ccr@tnsp.org>
parents:
282
diff
changeset
|
58 will use the song length database and STIL |
|
5dfe7846e902
Document the support of "HVSC_BASE" environment variable.
Matti Hamalainen <ccr@tnsp.org>
parents:
282
diff
changeset
|
59 database from HVSC. |
|
5dfe7846e902
Document the support of "HVSC_BASE" environment variable.
Matti Hamalainen <ccr@tnsp.org>
parents:
282
diff
changeset
|
60 |
|
5dfe7846e902
Document the support of "HVSC_BASE" environment variable.
Matti Hamalainen <ccr@tnsp.org>
parents:
282
diff
changeset
|
61 (This setting is also used by some other SID- |
|
5dfe7846e902
Document the support of "HVSC_BASE" environment variable.
Matti Hamalainen <ccr@tnsp.org>
parents:
282
diff
changeset
|
62 related utilities such as stilview and sidplayfp.) |
|
5dfe7846e902
Document the support of "HVSC_BASE" environment variable.
Matti Hamalainen <ccr@tnsp.org>
parents:
282
diff
changeset
|
63 |
|
96
b6bf182bd37f
Add line about 'make install'.
Matti Hamalainen <ccr@tnsp.org>
parents:
76
diff
changeset
|
64 |
|
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
65 ----------------------------------------------------------------------- |
|
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
66 |
|
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
67 Usage |
|
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
68 ===== |
| 40 | 69 For more information about options, see 'sidinfo --help'. |
| 70 | |
|
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
71 --- --- --- --- --- --- --- --- --- --- |
|
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
72 |
| 193 | 73 Display all information about one file in "entry per row" format: |
| 74 | |
|
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
75 $ sidinfo /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid |
| 17 | 76 Filename : /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid |
| 77 Type : PSID | |
| 78 Version : 2.0 | |
| 79 Data offset : 124 | |
| 80 Data size : 7154 | |
| 81 Load address : 0 | |
| 82 Init address : 4017 | |
| 83 Play address : 4027 | |
| 84 Songs : 1 | |
| 85 Start song : 1 | |
| 86 Name : Anal'ogue | |
| 119 | 87 Author : Søren Lund (Jeff) |
| 17 | 88 Copyright : 1996 Jeff |
| 89 Hash : 6d5b7f0ff092e55abf27c37c8bc3fc64 | |
|
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
90 |
|
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
91 --- --- --- --- --- --- --- --- --- --- |
| 17 | 92 |
| 193 | 93 Display in "parseable" INI-style format, with hexadecimal values: |
| 94 | |
| 67 | 95 $ sidinfo /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid -p -x |
| 17 | 96 Filename=/misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid |
| 97 Type=PSID | |
| 98 Version=2.0 | |
| 99 DataOffs=$0000007c | |
| 100 DataSize=$00001bf2 | |
| 101 LoadAddr=$0000 | |
| 102 InitAddr=$0fb1 | |
| 103 PlayAddr=$0fbb | |
| 104 Songs=$0001 | |
| 105 StartSong=$0001 | |
| 106 Name=Anal'ogue | |
| 119 | 107 Author=Søren Lund (Jeff) |
| 17 | 108 Copyright=1996 Jeff |
| 109 Hash=6d5b7f0ff092e55abf27c37c8bc3fc64 | |
| 40 | 110 |
|
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
111 --- --- --- --- --- --- --- --- --- --- |
| 40 | 112 |
| 193 | 113 One-line format with "|" as field separator, and specify |
| 114 which fields to display: | |
| 115 | |
|
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
116 $ sidinfo -l \| -f type,ver,hash,name,author,copyright Anal_ogue.sid |
|
194
05e2332070a7
Fix some typos and cleanup.
Matti Hamalainen <ccr@tnsp.org>
parents:
193
diff
changeset
|
117 |
| 119 | 118 PSID|2.0|Anal'ogue|Søren Lund (Jeff)|1996 Jeff|6d5b7f0ff092e55abf27c37c8bc3fc64| |
| 40 | 119 |
|
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
120 --- --- --- --- --- --- --- --- --- --- |
| 40 | 121 |
| 193 | 122 By using the format string functionality you can control |
| 123 the output very specifically: | |
| 67 | 124 |
| 125 $ sidinfo Anal_ogue.sid -F 'NAME="@name@"\nHASH=@hash@\n' | |
|
194
05e2332070a7
Fix some typos and cleanup.
Matti Hamalainen <ccr@tnsp.org>
parents:
193
diff
changeset
|
126 |
| 64 | 127 NAME="Anal'ogue" |
| 128 HASH=6d5b7f0ff092e55abf27c37c8bc3fc64 | |
|
152
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
129 |
|
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
130 --- --- --- --- --- --- --- --- --- --- |
|
152
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
131 |
| 193 | 132 You could, for example create SQL INSERT statements: |
| 133 | |
| 134 $ sidinfo Anal_ogue.sid -e\' -F "INSERT INTO sometable (filename,name,author) VALUES ('@filename@', '@name@', '@author@', '@copyright@')\n" | |
| 135 | |
| 136 INSERT INTO sometable (filename,name,author) VALUES ('./Anal_ogue.sid', 'Anal\'ogue', 'Søren Lund (Jeff)', '1996 Jeff') | |
| 137 | |
| 138 --- --- --- --- --- --- --- --- --- --- | |
| 139 | |
|
152
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
140 Furthermore, you can use "printf"-style format specifiers for |
|
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
141 formatting each @field@, see this example: |
|
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
142 |
|
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
143 $ sidinfo Anal_ogue.sid -F 'NAME=@name:"%-64s"@\nHASH=@hash:"%64s"@\nLOAD_ADDR=@loadaddr:$%04x@\n' |
|
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
144 NAME="Anal'ogue " |
|
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
145 HASH=" 6d5b7f0ff092e55abf27c37c8bc3fc64" |
|
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
146 LOAD_ADDR=$0fb0 |
|
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
147 |
|
194
05e2332070a7
Fix some typos and cleanup.
Matti Hamalainen <ccr@tnsp.org>
parents:
193
diff
changeset
|
148 Many of the format specifiers are supported, but not all, and obviously |
|
05e2332070a7
Fix some typos and cleanup.
Matti Hamalainen <ccr@tnsp.org>
parents:
193
diff
changeset
|
149 only integer/string formats are supported. |
| 193 | 150 |
| 151 --- --- --- --- --- --- --- --- --- --- | |
| 152 | |
| 153 Since sidinfo v0.7.6 it is also possible to automatically scan | |
| 154 and recurse directories via '-R' option, for example: | |
| 155 | |
| 156 $ sidinfo -R /misc/C64Music/*.sid | |
| 157 | |
|
194
05e2332070a7
Fix some typos and cleanup.
Matti Hamalainen <ccr@tnsp.org>
parents:
193
diff
changeset
|
158 The above will start from /misc/C64Music/ and scan any accessible |
|
05e2332070a7
Fix some typos and cleanup.
Matti Hamalainen <ccr@tnsp.org>
parents:
193
diff
changeset
|
159 subdirectories for files that match "*.sid" pattern and handle them. |
| 193 | 160 |
| 161 Using previous example about SQL inserts: | |
| 162 | |
| 163 $ sidinfo /misc/C64Music/*.sid -R -e\' -F "INSERT INTO sometable (filename,name,author) VALUES ('@filename@', '@name@', '@author@', '@copyright@')\n" | |
|
194
05e2332070a7
Fix some typos and cleanup.
Matti Hamalainen <ccr@tnsp.org>
parents:
193
diff
changeset
|
164 |
|
282
5936a3dc9755
Document the STIL related issues of -F formatting with few words.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
165 --- --- --- --- --- --- --- --- --- --- |
|
5936a3dc9755
Document the STIL related issues of -F formatting with few words.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
166 |
|
5936a3dc9755
Document the STIL related issues of -F formatting with few words.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
167 SIDInfo 0.9 adds support for STIL database. Unfortunately controlling |
|
290
4686ea0b6851
Minor typographic and grammatic improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
168 the output of STIL information in the "-"F format string option is quite |
|
282
5936a3dc9755
Document the STIL related issues of -F formatting with few words.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
169 limited, as all fields will be concatenated into one string. |
|
5936a3dc9755
Document the STIL related issues of -F formatting with few words.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
170 |
|
290
4686ea0b6851
Minor typographic and grammatic improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
171 You can change the field separator by specifying the "-l" option and |
|
4686ea0b6851
Minor typographic and grammatic improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
172 also optionally omit the STIL field names by using the "-n" option. |
|
282
5936a3dc9755
Document the STIL related issues of -F formatting with few words.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
173 |