Mercurial > hg > sidinfo
annotate README.txt @ 155:de75385f75e2
Simplify by removing few lines of duplicate code.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Thu, 26 Oct 2017 00:22:36 +0300 |
parents | e3be2ae6120e |
children | 8fc887cb56d0 |
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 |
136 | 3 (C) Copyright 2014-2017 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 |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
28 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
|
29 MinGW packages from Debian Testing (wheezy): |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
30 |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
31 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
|
32 |
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
33 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
|
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 |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
68 $ sidinfo /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid |
17 | 69 Filename : /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid |
70 Type : PSID | |
71 Version : 2.0 | |
72 Data offset : 124 | |
73 Data size : 7154 | |
74 Load address : 0 | |
75 Init address : 4017 | |
76 Play address : 4027 | |
77 Songs : 1 | |
78 Start song : 1 | |
79 Name : Anal'ogue | |
119 | 80 Author : Søren Lund (Jeff) |
17 | 81 Copyright : 1996 Jeff |
82 Hash : 6d5b7f0ff092e55abf27c37c8bc3fc64 | |
11
20bcf214b282
Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
83 |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
84 --- --- --- --- --- --- --- --- --- --- |
17 | 85 |
67 | 86 $ sidinfo /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid -p -x |
17 | 87 Filename=/misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid |
88 Type=PSID | |
89 Version=2.0 | |
90 DataOffs=$0000007c | |
91 DataSize=$00001bf2 | |
92 LoadAddr=$0000 | |
93 InitAddr=$0fb1 | |
94 PlayAddr=$0fbb | |
95 Songs=$0001 | |
96 StartSong=$0001 | |
97 Name=Anal'ogue | |
119 | 98 Author=Søren Lund (Jeff) |
17 | 99 Copyright=1996 Jeff |
100 Hash=6d5b7f0ff092e55abf27c37c8bc3fc64 | |
40 | 101 |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
102 --- --- --- --- --- --- --- --- --- --- |
40 | 103 |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
104 $ sidinfo -l \| -f type,ver,hash,name,author,copyright Anal_ogue.sid |
119 | 105 PSID|2.0|Anal'ogue|Søren Lund (Jeff)|1996 Jeff|6d5b7f0ff092e55abf27c37c8bc3fc64| |
40 | 106 |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
107 --- --- --- --- --- --- --- --- --- --- |
40 | 108 |
67 | 109 By using the format string functionality you can |
110 control the output very specifically: | |
111 | |
112 $ sidinfo Anal_ogue.sid -F 'NAME="@name@"\nHASH=@hash@\n' | |
64 | 113 NAME="Anal'ogue" |
114 HASH=6d5b7f0ff092e55abf27c37c8bc3fc64 | |
152
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
115 |
153
e3be2ae6120e
Delete trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
116 --- --- --- --- --- --- --- --- --- --- |
152
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
117 |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
118 Furthermore, you can use "printf"-style format specifiers for |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
119 formatting each @field@, see this example: |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
120 |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
121 $ 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
|
122 NAME="Anal'ogue " |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
123 HASH=" 6d5b7f0ff092e55abf27c37c8bc3fc64" |
44e1c1555d87
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
136
diff
changeset
|
124 LOAD_ADDR=$0fb0 |
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 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
|
127 integer/string formats are supported. |