Mercurial > hg > sidinfo

annotate README.txt @ 64:2bf85a700e23

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update documentation a bit.
author Matti Hamalainen <ccr@tnsp.org>
date Sun, 27 Dec 2015 19:32:24 +0200
parents b9b56b4b0592
children f0eca0f9256a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
2 Programmed and designed by Matti 'ccr' Hämäläinen
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
3 (C) Copyright 2014 Tecnic Software productions (TNSP)
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
43
b9b56b4b0592 Update instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 40
diff changeset
24 - th-libs library (included in the tar/zip packages,
b9b56b4b0592 Update instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 40
diff changeset
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
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
27 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
28 MinGW packages from Debian Testing (wheezy):
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 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
31
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
32 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
33
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
34 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
35
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 How to build
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
39 ============
30
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
40 0) If building from Mercurial repo, you need th-libs:
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
41
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
42 $ hg clone http://tnsp.org/hg/th-libs
11
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
43
30
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
44 1) Possibly edit Makefile / Makefile.w32
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
45
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
46 2) $ gmake
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
47
11
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
48 or, if cross-compiling to Win32 via MinGW
30
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
49
11
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
50 $ gmake -f Makefile.w32
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
51
30
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
52 3) ???
11
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
53
30
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
54 4) If it works -> Happy fun times \:D\
11
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
55
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
56 -----------------------------------------------------------------------
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
57
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
58 Usage
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
59 =====
40
eabee1428b0a Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 30
diff changeset
60 For more information about options, see 'sidinfo --help'.
eabee1428b0a Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 30
diff changeset
61
11
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
62
17
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
63 $ ./sidinfo /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
64 Filename : /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
65 Type : PSID
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
66 Version : 2.0
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
67 Data offset : 124
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
68 Data size : 7154
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
69 Load address : 0
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
70 Init address : 4017
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
71 Play address : 4027
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
72 Songs : 1
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
73 Start song : 1
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
74 Name : Anal'ogue
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
75 Author : Søren Lund (Jeff)
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
76 Copyright : 1996 Jeff
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
77 Hash : 6d5b7f0ff092e55abf27c37c8bc3fc64
11
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
78
17
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
79
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
80 $ ./sidinfo /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid -p -x
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
81 Filename=/misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
82 Type=PSID
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
83 Version=2.0
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
84 DataOffs=$0000007c
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
85 DataSize=$00001bf2
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
86 LoadAddr=$0000
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
87 InitAddr=$0fb1
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
88 PlayAddr=$0fbb
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
89 Songs=$0001
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
90 StartSong=$0001
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
91 Name=Anal'ogue
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
92 Author=Søren Lund (Jeff)
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
93 Copyright=1996 Jeff
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
94 Hash=6d5b7f0ff092e55abf27c37c8bc3fc64
40
eabee1428b0a Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 30
diff changeset
95
eabee1428b0a Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 30
diff changeset
96
eabee1428b0a Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 30
diff changeset
97 $ ./sidinfo -l \| -f type,ver,hash,name,author,copyright Anal_ogue.sid
eabee1428b0a Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 30
diff changeset
98 PSID|2.0|Anal'ogue|Søren Lund (Jeff)|1996 Jeff|6d5b7f0ff092e55abf27c37c8bc3fc64|
eabee1428b0a Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 30
diff changeset
99
eabee1428b0a Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 30
diff changeset
100
64
2bf85a700e23 Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 43
diff changeset
101 By using the format string functionality:
2bf85a700e23 Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 43
diff changeset
102 $ ./sidinfo Anal_ogue.sid -F 'NAME="@name@"\nHASH=@hash@\n'
2bf85a700e23 Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 43
diff changeset
103 NAME="Anal'ogue"
2bf85a700e23 Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 43
diff changeset
104 HASH=6d5b7f0ff092e55abf27c37c8bc3fc64