» WIT: Wiimms ISO Tools » Guides » Logging options

# Logging options

## 1. Introduction

This page describes the options to controll the logging of the tools.

Use the following table as table of content of this page:

Options
Option | Param | Description
--- | --- | ---
`-q` | `--quiet` |  | Be quiet and print only error messages.
`-v` | `--verbose` |  | Be verbose and print more progress information. Multiple usage is possible: Progress counter is enabled if set at least two times. Extended logging is enabled if set at least four times. The impact of the other verbose levels are command dependent.
`-L` | `--logging` |  | This debug option enables the logging of internal memory maps. If set twice second level memory maps are printed too.
| `--sections` |  | Print in machine readable sections and parameter lines.
| `--limit` | num | Limit the output to NUM messages.

## 2. -q | --quiet

Be quiet and print only error messages.
This options tells the tool to be quiet and print only error messages. If this option is set twice some commands suppress the error messages too and report only by using the exit status (see commands »wit ERROR« or »wwt ERROR«).

If this option is set, all previous seetings of --verbose are ignored.

### Command reference

»wdf cmp«, »wit analyze«, »wit convert«, »wit copy«, »wit diff«, »wit dolpatch«, »wit edit«, »wit extract«, »wit fdiff«, »wit features«, »wit imgfiles«, »wit move«, »wit remove«, »wit rename«, »wit settitle«, »wit skeleton«, »wit verify«, »wwt add«, »wwt check«, »wwt dup«, »wwt extract«, »wwt features«, »wwt find«, »wwt new«, »wwt phantom«, »wwt remove«, »wwt rename«, »wwt repair«, »wwt scrub«, »wwt settitle«, »wwt skeleton«, »wwt sync«, »wwt truncate«, »wwt update«, »wwt verify«.

## 3. -v | --verbose

Be verbose and print more progress information. Multiple usage is possible: Progress counter is enabled if set at least two times. Extended logging is enabled if set at least four times. The impact of the other verbose levels are command dependent.
Each occurrence of this option makes the tool more verbose. If this option is set, all previous seetings of --quiet are ignored.

### Command reference

»wdf cmp«, »wit cert«, »wit compr«, »wit convert«, »wit copy«, »wit diff«, »wit dolpatch«, »wit edit«, »wit extract«, »wit fdiff«, »wit features«, »wit fragments«, »wit rename«, »wit settitle«, »wit verify«, »wwt add«, »wwt check«, »wwt compr«, »wwt extract«, »wwt features«, »wwt format«, »wwt new«, »wwt phantom«, »wwt remove«, »wwt repair«, »wwt scrub«, »wwt sync«, »wwt update«, »wwt verify«.

## 4. -L | --logging

This debug option enables the logging of internal memory maps. If set twice second level memory maps are printed too.
If this option is set, then the disc layout of patching or composing objects is printed. If this option is set twice, then the partition layout is printed too.

Example

    Memory layout of virtual disc:

           offset .. offset end     size  comment
      ------------------------------------------------------------------------------
    	    0 ..       100       100  disc header [RTYP01]
    	40000 ..     40028        28  partition tables
    	4e000 ..     4e020        20  region settings, region=2
    	4fffc ..     50000         4  magic c3-f8-1a-8e
          f800000 ..   f820000     20000  DATA partition, header
          f820000 ..  11018000   17f8000  DATA partition, data

    Memory layout of virtual DATA partition:

           offset .. offset end     size  comment
      ------------------------------------------------------------------------------
    	    0 ..      2440      2440  boot.bin [RTYP01] + bi2.bin
    	 2440 ..     3dc7c     3b83c  apploader.img
    	3dd00 ..    2d4f20    297220  main.dol
           2d5000 ..    2d6070      1070  fst.bin
           2d6080 ..   17323d0   145c350  157 files + directories

### Command reference

»wit convert«, »wit copy«, »wit diff«, »wit dump«, »wit extract«, »wit fdiff«, »wit files«, »wit files-l«, »wit files-ll«, »wit fragments«, »wit id6«, »wit id8«, »wit list«, »wit list-l«, »wit list-ll«, »wit list-lll«, »wit skeleton«, »wit verify«, »wwt add«, »wwt dup«, »wwt new«, »wwt skeleton«, »wwt sync«, »wwt update«, »wwt verify«.

## 5. --sections

Print in machine readable sections and parameter lines.
This options enables the output in sections. These sections are machine readable and good for scripts and GUIs. Example:

       # wit version --section
       [version]
       prog=wit
       name=Wiimms ISO Tool
       version=1.26a.beta3
       beta=3
       revision=2161
       system=x86_64
       endian=1234 little
       date=2011-01-12
       url=https://wit.wiimm.de/wit

The human readable output is a bad source to scan because it will sometimes change it's layout. It's better to use the section output: It is very stable and generally only new parameter lines will be added.

The syntax is very easy:

- Each section starts with a heade line in the format '[name]'. The name consists of alphanumeric characters, the colon (':') and then minus sign ('-'). Lower case leters are used for the name, except for starting a job like COPY or EXTRACT.
- Each following line is a paramater line with format 'key=parameter'. The key consists of alphanumeric characters and the minus sign ('-').
- A sections ends with an empty line. Empty lines will never used before the section end.
- Error messages will break the section output. All error message lines begin with an exclamation mark ('!') in the first column.

### Command reference

»wit compr«, »wit convert«, »wit copy«, »wit diff«, »wit edit«, »wit error«, »wit extract«, »wit fdiff«, »wit imgfiles«, »wit info«, »wit list«, »wit list-l«, »wit list-ll«, »wit list-lll«, »wit move«, »wit remove«, »wit version«, »wwt add«, »wwt check«, »wwt compr«, »wwt error«, »wwt extract«, »wwt find«, »wwt info«, »wwt list«, »wwt list-a«, »wwt list-f«, »wwt list-l«, »wwt list-ll«, »wwt list-lll«, »wwt list-m«, »wwt list-u«, »wwt new«, »wwt remove«, »wwt repair«, »wwt scrub«, »wwt sync«, »wwt update«, »wwt version«.

## 6. --limit num

Limit the output to NUM messages.
This options limits the number of warning and error messages for some commands.

### Command reference

»wdf cmp«, »wit diff«, »wit fdiff«, »wit verify«, »wwt verify«.