Mercurial > hg > sidinfo

comparison README.txt @ 325:d056f284184b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improvements to the README.
author Matti Hamalainen <ccr@tnsp.org>
date Sun, 12 Jan 2020 00:11:34 +0200
parents 887b67891105
children 0e818307e90b
comparison
equal deleted inserted replaced
324:4b99dff0958d 325:d056f284184b
4 4
5 See COPYING for license information. 5 See COPYING for license information.
6 6
7 For contacting the author, e-mail is preferred: ccr@tnsp.org 7 For contacting the author, e-mail is preferred: ccr@tnsp.org
8 8
9 ----------------------------------------------------------------------- 9 =======================================================================
10 10
11 Requirements 11 Requirements
12 ============ 12 ============
13 The compilation and usage of these utilities requires following 13 The compilation and usage of these utilities requires following
14 software packages or functional equivalents installed: 14 software packages or functional equivalents installed:
27 For Linux -> Win32/64 cross-compilation I have used the MinGW packages 27 For Linux -> Win32/64 cross-compilation I have used the MinGW packages
28 from Debian Testing (wheezy), installable via "apt-get mingw-w64". 28 from Debian Testing (wheezy), installable via "apt-get mingw-w64".
29 29
30 Please don't ask me for help to get cross-compilation working. 30 Please don't ask me for help to get cross-compilation working.
31 31
32 ----------------------------------------------------------------------- 32 =======================================================================
33 33
34 How to build 34 How to build
35 ============ 35 ============
36 0) If building from Mercurial repo, you need th-libs: 36 0) If building from Mercurial repo, you need th-libs:
37 37
60 60
61 (This setting is also used by some other SID- 61 (This setting is also used by some other SID-
62 related utilities such as stilview and sidplayfp.) 62 related utilities such as stilview and sidplayfp.)
63 63
64 64
65 ----------------------------------------------------------------------- 65 =======================================================================
66 66
67 Usage 67 Usage
68 ===== 68 =====
69 For more information about options, see 'sidinfo --help'. 69 For more information about options, see 'sidinfo --help'.
70 70
71 --- --- --- --- --- --- --- --- --- --- 71 --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
72
72 73
73 Display all information about one file in "entry per row" format: 74 Display all information about one file in "entry per row" format:
74 75
75 $ sidinfo /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid 76 $ sidinfo /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid
76 Filename : /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid 77 Filename : /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid
86 Name : Anal'ogue 87 Name : Anal'ogue
87 Author : Søren Lund (Jeff) 88 Author : Søren Lund (Jeff)
88 Copyright : 1996 Jeff 89 Copyright : 1996 Jeff
89 Hash : 6d5b7f0ff092e55abf27c37c8bc3fc64 90 Hash : 6d5b7f0ff092e55abf27c37c8bc3fc64
90 91
91 --- --- --- --- --- --- --- --- --- --- 92 --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
92 93
93 Display in "parseable" INI-style format, with hexadecimal values: 94 Display in "parseable" INI-style format, with hexadecimal values:
94 95
95 $ sidinfo /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid -p -x 96 $ sidinfo /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid -p -x
96 Filename=/misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid 97 Filename=/misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid
106 Name=Anal'ogue 107 Name=Anal'ogue
107 Author=Søren Lund (Jeff) 108 Author=Søren Lund (Jeff)
108 Copyright=1996 Jeff 109 Copyright=1996 Jeff
109 Hash=6d5b7f0ff092e55abf27c37c8bc3fc64 110 Hash=6d5b7f0ff092e55abf27c37c8bc3fc64
110 111
111 --- --- --- --- --- --- --- --- --- --- 112 --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
112 113
113 One-line format with "|" as field separator, and specify 114 One-line format with "|" (pipe character) as a field separator, and
114 which fields to display: 115 also specify which fields are to be included:
115 116
116 $ sidinfo -l \| -f type,ver,hash,name,author,copyright Anal_ogue.sid 117 $ sidinfo -l \| -f type,ver,hash,name,author,copyright Anal_ogue.sid
117 118
118 PSID|2.0|Anal'ogue|Søren Lund (Jeff)|1996 Jeff|6d5b7f0ff092e55abf27c37c8bc3fc64| 119 PSID|2.0|Anal'ogue|Søren Lund (Jeff)|1996 Jeff|6d5b7f0ff092e55abf27c37c8bc3fc64|
119 120
120 --- --- --- --- --- --- --- --- --- --- 121 --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
121 122
122 By using the format string functionality you can control 123 By using the format string functionality you can control the output
123 the output very specifically: 124 format very specifically:
124 125
125 $ sidinfo Anal_ogue.sid -F 'NAME="@name@"\nHASH=@hash@\n' 126 $ sidinfo Anal_ogue.sid -F 'NAME="@name@"\nHASH=@hash@\n'
126 127
127 NAME="Anal'ogue" 128 NAME="Anal'ogue"
128 HASH=6d5b7f0ff092e55abf27c37c8bc3fc64 129 HASH=6d5b7f0ff092e55abf27c37c8bc3fc64
129 130
130 --- --- --- --- --- --- --- --- --- --- 131 --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
131 132
132 You could, for example create SQL INSERT statements: 133 You could, for example create SQL INSERT statements:
133 134
134 $ sidinfo Anal_ogue.sid -e\' -F "INSERT INTO sometable (filename,name,author) VALUES ('@filename@', '@name@', '@author@', '@copyright@')\n" 135 $ sidinfo Anal_ogue.sid -e\' -F "INSERT INTO sometable (filename,name,author) VALUES ('@filename@', '@name@', '@author@', '@copyright@')\n"
135 136
136 INSERT INTO sometable (filename,name,author) VALUES ('./Anal_ogue.sid', 'Anal\'ogue', 'Søren Lund (Jeff)', '1996 Jeff') 137 INSERT INTO sometable (filename,name,author) VALUES ('./Anal_ogue.sid', 'Anal\'ogue', 'Søren Lund (Jeff)', '1996 Jeff')
137 138
138 --- --- --- --- --- --- --- --- --- --- 139 --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
139 140
140 Furthermore, you can use "printf"-style format specifiers for 141 Furthermore, you can use "printf"-style format specifiers for
141 formatting each @field@, see this example: 142 formatting each @field@, see this example:
142 143
143 $ sidinfo Anal_ogue.sid -F 'NAME=@name:"%-64s"@\nHASH=@hash:"%64s"@\nLOAD_ADDR=@loadaddr:$%04x@\n' 144 $ sidinfo Anal_ogue.sid -F 'NAME=@name:"%-64s"@\nHASH=@hash:"%64s"@\nLOAD_ADDR=@loadaddr:$%04x@\n'
144 NAME="Anal'ogue " 145 NAME="Anal'ogue "
145 HASH=" 6d5b7f0ff092e55abf27c37c8bc3fc64" 146 HASH=" 6d5b7f0ff092e55abf27c37c8bc3fc64"
146 LOAD_ADDR=$0fb0 147 LOAD_ADDR=$0fb0
147 148
148 Many of the format specifiers are supported, but not all, and obviously 149 Many of the standard C-style printf() format specifiers are supported,
149 only integer/string formats are supported. 150 but not all, and obviously only integer/string formats are supported.
150 151
151 --- --- --- --- --- --- --- --- --- --- 152 --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
152 153
153 Since sidinfo v0.7.6 it is also possible to automatically scan 154 Since sidinfo v0.7.6 it is also possible to automatically scan and
154 and recurse directories via '-R' option, for example: 155 recurse directories via '-R' option, for example:
155 156
156 $ sidinfo -R /misc/C64Music/*.sid 157 $ sidinfo -R "/misc/C64Music/*.sid"
157 158
158 The above will start from /misc/C64Music/ and scan any accessible 159 The above will start from /misc/C64Music/ and scan any accessible
159 subdirectories for files that match "*.sid" pattern and handle them. 160 subdirectories for files that match "*.sid" pattern and handle them.
160 161
161 Using previous example about SQL inserts: 162 Using previous example about SQL inserts:
162 163
163 $ sidinfo /misc/C64Music/*.sid -R -e\' -F "INSERT INTO sometable (filename,name,author) VALUES ('@filename@', '@name@', '@author@', '@copyright@')\n" 164 $ sidinfo -R "/misc/C64Music/*.sid" -e\' -F "INSERT INTO sometable (filename,name,author) VALUES ('@filename@', '@name@', '@author@', '@copyright@')\n"
164 165
165 --- --- --- --- --- --- --- --- --- --- 166 --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
166 167
167 SIDInfo 0.9 adds support for STIL database. Unfortunately controlling 168 SIDInfo 0.9 adds support for the HVSC STIL database. Unfortunately
168 the output of STIL information in the "-"F format string option is quite 169 controlling the output of STIL information in the "-F" format string
169 limited, as all fields will be concatenated into one string. 170 option is quite limited, as all fields will be concatenated into
171 one long string field.
170 172
171 You can change the field separator by specifying the "-l" option and 173 You can change the field separator by specifying the "-l" option and
172 also optionally omit the STIL field names by using the "-n" option. 174 also optionally omit the STIL field names by using the "-n" option.
173 175