# HG changeset patch # User Matti Hamalainen # Date 1578780694 -7200 # Node ID d056f284184b44f8e5fc0c72d37535caead3b6d5 # Parent 4b99dff0958d991c93d1bd1fe159a78b0490295c Improvements to the README. diff -r 4b99dff0958d -r d056f284184b README.txt --- a/README.txt Sat Jan 11 22:50:04 2020 +0200 +++ b/README.txt Sun Jan 12 00:11:34 2020 +0200 @@ -6,7 +6,7 @@ For contacting the author, e-mail is preferred: ccr@tnsp.org ------------------------------------------------------------------------ +======================================================================= Requirements ============ @@ -29,7 +29,7 @@ Please don't ask me for help to get cross-compilation working. ------------------------------------------------------------------------ +======================================================================= How to build ============ @@ -62,13 +62,14 @@ related utilities such as stilview and sidplayfp.) ------------------------------------------------------------------------ +======================================================================= Usage ===== For more information about options, see 'sidinfo --help'. ---- --- --- --- --- --- --- --- --- --- +--- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- + Display all information about one file in "entry per row" format: @@ -88,7 +89,7 @@ Copyright : 1996 Jeff Hash : 6d5b7f0ff092e55abf27c37c8bc3fc64 ---- --- --- --- --- --- --- --- --- --- +--- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- Display in "parseable" INI-style format, with hexadecimal values: @@ -108,26 +109,26 @@ Copyright=1996 Jeff Hash=6d5b7f0ff092e55abf27c37c8bc3fc64 ---- --- --- --- --- --- --- --- --- --- +--- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- -One-line format with "|" as field separator, and specify -which fields to display: +One-line format with "|" (pipe character) as a field separator, and +also specify which fields are to be included: $ sidinfo -l \| -f type,ver,hash,name,author,copyright Anal_ogue.sid PSID|2.0|Anal'ogue|Søren Lund (Jeff)|1996 Jeff|6d5b7f0ff092e55abf27c37c8bc3fc64| ---- --- --- --- --- --- --- --- --- --- +--- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- -By using the format string functionality you can control -the output very specifically: +By using the format string functionality you can control the output +format very specifically: $ sidinfo Anal_ogue.sid -F 'NAME="@name@"\nHASH=@hash@\n' NAME="Anal'ogue" HASH=6d5b7f0ff092e55abf27c37c8bc3fc64 ---- --- --- --- --- --- --- --- --- --- +--- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- You could, for example create SQL INSERT statements: @@ -135,7 +136,7 @@ INSERT INTO sometable (filename,name,author) VALUES ('./Anal_ogue.sid', 'Anal\'ogue', 'Søren Lund (Jeff)', '1996 Jeff') ---- --- --- --- --- --- --- --- --- --- +--- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- Furthermore, you can use "printf"-style format specifiers for formatting each @field@, see this example: @@ -145,28 +146,29 @@ HASH=" 6d5b7f0ff092e55abf27c37c8bc3fc64" LOAD_ADDR=$0fb0 -Many of the format specifiers are supported, but not all, and obviously -only integer/string formats are supported. +Many of the standard C-style printf() format specifiers are supported, +but not all, and obviously only integer/string formats are supported. ---- --- --- --- --- --- --- --- --- --- +--- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- -Since sidinfo v0.7.6 it is also possible to automatically scan -and recurse directories via '-R' option, for example: +Since sidinfo v0.7.6 it is also possible to automatically scan and +recurse directories via '-R' option, for example: -$ sidinfo -R /misc/C64Music/*.sid +$ sidinfo -R "/misc/C64Music/*.sid" The above will start from /misc/C64Music/ and scan any accessible subdirectories for files that match "*.sid" pattern and handle them. Using previous example about SQL inserts: -$ sidinfo /misc/C64Music/*.sid -R -e\' -F "INSERT INTO sometable (filename,name,author) VALUES ('@filename@', '@name@', '@author@', '@copyright@')\n" +$ sidinfo -R "/misc/C64Music/*.sid" -e\' -F "INSERT INTO sometable (filename,name,author) VALUES ('@filename@', '@name@', '@author@', '@copyright@')\n" ---- --- --- --- --- --- --- --- --- --- +--- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- -SIDInfo 0.9 adds support for STIL database. Unfortunately controlling -the output of STIL information in the "-"F format string option is quite -limited, as all fields will be concatenated into one string. +SIDInfo 0.9 adds support for the HVSC STIL database. Unfortunately +controlling the output of STIL information in the "-F" format string +option is quite limited, as all fields will be concatenated into +one long string field. You can change the field separator by specifying the "-l" option and also optionally omit the STIL field names by using the "-n" option.