Mercurial > hg > sidinfo
annotate README.txt @ 169:da2fbfe18c60
Bump copyright years.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Fri, 16 Feb 2018 22:38:10 +0200 |
parents | 8fc887cb56d0 |
children | ef646bacfa99 |
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 |
169 | 3 (C) Copyright 2014-2018 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 |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
21 - GCC (4.x, older ones might work as well) |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
22 - GNU binutils |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
23 - GNU Make |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
24 |
43 | 25 - th-libs library (included in the tar/zip packages, |
26 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
|
27 |
157
8fc887cb56d0
Implement iconv support for converting from PSID de-facto latin-1/ISO-8859-*
Matti Hamalainen <ccr@tnsp.org>
parents:
153
diff
changeset
|
28 - 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
|
29 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
|
30 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
|
31 |
8fc887cb56d0
Implement iconv support for converting from PSID de-facto latin-1/ISO-8859-*
Matti Hamalainen <ccr@tnsp.org>
parents:
153
diff
changeset
|
32 |
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
33 For Linux -> Win32/64 cross-compilation I have used the standard |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
34 MinGW packages from Debian Testing (wheezy): |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
35 |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
36 gcc-mingw-w64 mingw-w64-i686-dev mingw-w64-x86-64-dev |
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 Some of those require a bit of poking to get working properly, YMMV. |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
39 |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
40 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
|
41 |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
42 ----------------------------------------------------------------------- |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
43 |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
44 How to build |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
45 ============ |
30 | 46 0) If building from Mercurial repo, you need th-libs: |
47 | |
48 $ hg clone http://tnsp.org/hg/th-libs | |
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
49 |
30 | 50 1) Possibly edit Makefile / Makefile.w32 |
51 | |
76 | 52 2) $ make |
30 | 53 |
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
54 or, if cross-compiling to Win32 via MinGW |
30 | 55 |
76 | 56 $ make -f Makefile.w32 |
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
57 |
30 | 58 3) ??? |
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
59 |
30 | 60 4) If it works -> Happy fun times \:D\ |
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
61 |
96
b6bf182bd37f
Add line about 'make install'.
Matti Hamalainen <ccr@tnsp.org>
parents:
76
diff
changeset
|
62 5) sudo make install |
b6bf182bd37f
Add line about 'make install'.
Matti Hamalainen <ccr@tnsp.org>
parents:
76
diff
changeset
|
63 |
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 |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
73 $ sidinfo /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid |
17 | 74 Filename : /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid |
75 Type : PSID | |
76 Version : 2.0 | |
77 Data offset : 124 | |
78 Data size : 7154 | |
79 Load address : 0 | |
80 Init address : 4017 | |
81 Play address : 4027 | |
82 Songs : 1 | |
83 Start song : 1 | |
84 Name : Anal'ogue | |
119 | 85 Author : Søren Lund (Jeff) |
17 | 86 Copyright : 1996 Jeff |
87 Hash : 6d5b7f0ff092e55abf27c37c8bc3fc64 | |
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
88 |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
89 --- --- --- --- --- --- --- --- --- --- |
17 | 90 |
67 | 91 $ sidinfo /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid -p -x |
17 | 92 Filename=/misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid |
93 Type=PSID | |
94 Version=2.0 | |
95 DataOffs=$0000007c | |
96 DataSize=$00001bf2 | |
97 LoadAddr=$0000 | |
98 InitAddr=$0fb1 | |
99 PlayAddr=$0fbb | |
100 Songs=$0001 | |
101 StartSong=$0001 | |
102 Name=Anal'ogue | |
119 | 103 Author=Søren Lund (Jeff) |
17 | 104 Copyright=1996 Jeff |
105 Hash=6d5b7f0ff092e55abf27c37c8bc3fc64 | |
40 | 106 |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
107 --- --- --- --- --- --- --- --- --- --- |
40 | 108 |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
109 $ sidinfo -l \| -f type,ver,hash,name,author,copyright Anal_ogue.sid |
119 | 110 PSID|2.0|Anal'ogue|Søren Lund (Jeff)|1996 Jeff|6d5b7f0ff092e55abf27c37c8bc3fc64| |
40 | 111 |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
112 --- --- --- --- --- --- --- --- --- --- |
40 | 113 |
67 | 114 By using the format string functionality you can |
115 control the output very specifically: | |
116 | |
117 $ sidinfo Anal_ogue.sid -F 'NAME="@name@"\nHASH=@hash@\n' | |
64 | 118 NAME="Anal'ogue" |
119 HASH=6d5b7f0ff092e55abf27c37c8bc3fc64 | |
152
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
120 |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
121 --- --- --- --- --- --- --- --- --- --- |
152
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
122 |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
123 Furthermore, you can use "printf"-style format specifiers for |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
124 formatting each @field@, see this example: |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
125 |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
126 $ 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
|
127 NAME="Anal'ogue " |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
128 HASH=" 6d5b7f0ff092e55abf27c37c8bc3fc64" |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
129 LOAD_ADDR=$0fb0 |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
130 |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
131 Many of the format specifiers are supported, but not all, and obviously only |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
132 integer/string formats are supported. |