Mercurial > hg > sidinfo
annotate README.txt @ 233:b634952372f1
Update README a bit.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Sat, 04 Jan 2020 12:00:02 +0200 |
parents | 98563979859b |
children | a8605886579d |
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 |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
7 ----------------------------------------------------------------------- |
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 Contact |
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 IRC : ccr @ IRCNet, sometimes also Freenode |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
12 e-mail : ccr@tnsp.org |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
13 |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
14 ----------------------------------------------------------------------- |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
15 |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
16 Requirements |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
17 ============ |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
18 The compilation and usage of these utilities requires following |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
19 software packages or functional equivalents installed: |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
20 |
233 | 21 - 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
|
22 - GNU Make |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
23 |
43 | 24 - th-libs library (included in the tar/zip packages, |
25 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
|
26 |
157
8fc887cb56d0
Implement iconv support for converting from PSID de-facto latin-1/ISO-8859-*
Matti Hamalainen <ccr@tnsp.org>
parents:
153
diff
changeset
|
27 - 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
|
28 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
|
29 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
|
30 |
8fc887cb56d0
Implement iconv support for converting from PSID de-facto latin-1/ISO-8859-*
Matti Hamalainen <ccr@tnsp.org>
parents:
153
diff
changeset
|
31 |
233 | 32 For Linux -> Win32/64 cross-compilation I have used the MinGW packages |
33 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
|
34 |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
35 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
|
36 |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
37 ----------------------------------------------------------------------- |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
38 |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
39 How to build |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
40 ============ |
30 | 41 0) If building from Mercurial repo, you need th-libs: |
42 | |
43 $ hg clone http://tnsp.org/hg/th-libs | |
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
44 |
30 | 45 1) Possibly edit Makefile / Makefile.w32 |
46 | |
76 | 47 2) $ make |
30 | 48 |
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
49 or, if cross-compiling to Win32 via MinGW |
30 | 50 |
76 | 51 $ make -f Makefile.w32 |
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
52 |
30 | 53 3) ??? |
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
54 |
30 | 55 4) If it works -> Happy fun times \:D\ |
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
56 |
96
b6bf182bd37f
Add line about 'make install'.
Matti Hamalainen <ccr@tnsp.org>
parents:
76
diff
changeset
|
57 5) sudo make install |
b6bf182bd37f
Add line about 'make install'.
Matti Hamalainen <ccr@tnsp.org>
parents:
76
diff
changeset
|
58 |
b6bf182bd37f
Add line about 'make install'.
Matti Hamalainen <ccr@tnsp.org>
parents:
76
diff
changeset
|
59 |
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
60 ----------------------------------------------------------------------- |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
61 |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
62 Usage |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
63 ===== |
40 | 64 For more information about options, see 'sidinfo --help'. |
65 | |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
66 --- --- --- --- --- --- --- --- --- --- |
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
67 |
193 | 68 Display all information about one file in "entry per row" format: |
69 | |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
70 $ sidinfo /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid |
17 | 71 Filename : /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid |
72 Type : PSID | |
73 Version : 2.0 | |
74 Data offset : 124 | |
75 Data size : 7154 | |
76 Load address : 0 | |
77 Init address : 4017 | |
78 Play address : 4027 | |
79 Songs : 1 | |
80 Start song : 1 | |
81 Name : Anal'ogue | |
119 | 82 Author : Søren Lund (Jeff) |
17 | 83 Copyright : 1996 Jeff |
84 Hash : 6d5b7f0ff092e55abf27c37c8bc3fc64 | |
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
85 |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
86 --- --- --- --- --- --- --- --- --- --- |
17 | 87 |
193 | 88 Display in "parseable" INI-style format, with hexadecimal values: |
89 | |
67 | 90 $ sidinfo /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid -p -x |
17 | 91 Filename=/misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid |
92 Type=PSID | |
93 Version=2.0 | |
94 DataOffs=$0000007c | |
95 DataSize=$00001bf2 | |
96 LoadAddr=$0000 | |
97 InitAddr=$0fb1 | |
98 PlayAddr=$0fbb | |
99 Songs=$0001 | |
100 StartSong=$0001 | |
101 Name=Anal'ogue | |
119 | 102 Author=Søren Lund (Jeff) |
17 | 103 Copyright=1996 Jeff |
104 Hash=6d5b7f0ff092e55abf27c37c8bc3fc64 | |
40 | 105 |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
106 --- --- --- --- --- --- --- --- --- --- |
40 | 107 |
193 | 108 One-line format with "|" as field separator, and specify |
109 which fields to display: | |
110 | |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
111 $ 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
|
112 |
119 | 113 PSID|2.0|Anal'ogue|Søren Lund (Jeff)|1996 Jeff|6d5b7f0ff092e55abf27c37c8bc3fc64| |
40 | 114 |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
115 --- --- --- --- --- --- --- --- --- --- |
40 | 116 |
193 | 117 By using the format string functionality you can control |
118 the output very specifically: | |
67 | 119 |
120 $ 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
|
121 |
64 | 122 NAME="Anal'ogue" |
123 HASH=6d5b7f0ff092e55abf27c37c8bc3fc64 | |
152
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
124 |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
125 --- --- --- --- --- --- --- --- --- --- |
152
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
126 |
193 | 127 You could, for example create SQL INSERT statements: |
128 | |
129 $ sidinfo Anal_ogue.sid -e\' -F "INSERT INTO sometable (filename,name,author) VALUES ('@filename@', '@name@', '@author@', '@copyright@')\n" | |
130 | |
131 INSERT INTO sometable (filename,name,author) VALUES ('./Anal_ogue.sid', 'Anal\'ogue', 'Søren Lund (Jeff)', '1996 Jeff') | |
132 | |
133 --- --- --- --- --- --- --- --- --- --- | |
134 | |
152
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
135 Furthermore, you can use "printf"-style format specifiers for |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
136 formatting each @field@, see this example: |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
137 |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
138 $ 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
|
139 NAME="Anal'ogue " |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
140 HASH=" 6d5b7f0ff092e55abf27c37c8bc3fc64" |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
141 LOAD_ADDR=$0fb0 |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
142 |
194
05e2332070a7
Fix some typos and cleanup.
Matti Hamalainen <ccr@tnsp.org>
parents:
193
diff
changeset
|
143 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
|
144 only integer/string formats are supported. |
193 | 145 |
146 --- --- --- --- --- --- --- --- --- --- | |
147 | |
148 Since sidinfo v0.7.6 it is also possible to automatically scan | |
149 and recurse directories via '-R' option, for example: | |
150 | |
151 $ sidinfo -R /misc/C64Music/*.sid | |
152 | |
194
05e2332070a7
Fix some typos and cleanup.
Matti Hamalainen <ccr@tnsp.org>
parents:
193
diff
changeset
|
153 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
|
154 subdirectories for files that match "*.sid" pattern and handle them. |
193 | 155 |
156 Using previous example about SQL inserts: | |
157 | |
158 $ 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
|
159 |