Update --help and readme a bit

This commit is contained in:
Alcaro
2017-05-18 12:06:31 +02:00
parent c7848c0ac4
commit 094a48b850
2 changed files with 17 additions and 22 deletions

View File

@@ -934,34 +934,29 @@ void usage()
" "
#ifndef FLIPS_CLI
"flips\n"
"or flips patch.ips\n"
"or flips patch.bps\n"
"or "
#endif
"flips [--apply] [--exact] patch.bps rom.smc [outrom.smc]\n"
"or flips [--create] [--exact] [--bps | --bps-linear | --ips] clean.smc\n"
" hack.smc [patch.bps]\n"
#ifndef FLIPS_CLI
"(for scripting, only the latter two are sensible)\n"
#endif
"(patch.ips is valid in all cases patch.bps is)\n"
"or flips [--create] [--exact] [--bps | etc] clean.smc hack.smc [patch.bps]\n"
"\n"
// 12345678901234567890123456789012345678901234567890123456789012345678901234567890
"options:\n"
"-a --apply: apply patch (default if given two arguments)\n"
"-c --create: create patch (default if given three arguments)\n"
"-I --info: BPSes contain information about input and output roms, print it\n"
"-a --apply: apply IPS, BPS or UPS patch (default if given two arguments)\n"
"-c --create: create IPS or BPS patch (default if given three arguments)\n"
"-I --info: BPS files contain information about input and output roms, print it\n"
//" also estimates how much of the source file is retained\n"
//" anything under 400 is fine, anything over 600 should be treated with suspicion\n"
//(TODO: --info --verbose)
"-i --ips, -b -B --bps --bps-delta, --bps-linear, --bps-delta-moremem:\n"
"-i --ips, -b -B --bps --bps-delta, --bps-delta-moremem, --bps-linear:\n"
" create this patch format instead of guessing based on file extension\n"
" ignored when applying\n"
" bps formats:\n"
" delta is the recommended one; it's a good balance between creation time and\n"
" patch size\n"
" -b and -B both refer to this, for backwards compatibility reasons\n"
" delta-moremem is usually slightly faster than delta, but uses about twice\n"
" as much memory; it gives identical patches to delta\n"
" the shorter forms all refer to this, for backwards compatibility reasons\n"
" delta-moremem is usually slightly (~3%) faster than delta, but uses about\n"
" twice as much memory; it gives identical patches to delta\n"
" linear is the fastest, but tends to give pretty big patches\n"
"--exact: do not remove SMC headers when applying or creating a BPS patch\n"
" (ignored for IPS)\n"