Informational/Trace

The following urlcp settings control various informational and trace behaviors. Note that increasing these settings may cause sensitive information to be printed and/or sent to vortex.log, e.g. authentication or password data.

• badhdrmsgs or badheadermsgs (boolean) Whether to issue a putmsg for malformed response headers. Added (and defaults to on) in version 5.01.1102538511 20041208. Returns previous setting.

• charsetmsgs (boolean) Whether to issue a putmsg for charset conversion problems. The default is on. Added in version 5.00.1089408135 20040709. Returns previous value.

• cookiemsgs (boolean) If true, additional messages are printed when invalid cookies are received and discarded, via the putmsg mechanism (here). If false (default), invalid cookies are silently discarded. Returns previous setting. Added in version 4.01.1022000000 20020521. See also the Cookies section (here).

• fetchmeter (boolean or string) Whether to print a progress meter during fetches. If true, a hash-mark progress meter is printed for uploads and downloads, where possible. The setting can also be a meter type: one of "simple", "percent" or "none". A true value enables a meter of type "simple". Returns previous value. Added in version 6.

• offsitefetchmsgsanderr (boolean) Whether to issue putmsgs (and return OffsiteRef error) for off-site components, redirects, etc. that are not fetched due to offsiteok (here) being off. Default on; added in version 7.07.1605645000 20201117. Returns previous value.

• pacmsgs (boolean)

  Whether to print PAC (proxy auto-config) error messages, e.g. from JavaScript and/or parsing. The default is on. Added in version 7.05.

• putmsg pass|save|all|clear [on|off [on|off ...]] (boolean) Controls the disposition of putmsgs from fetches. The first argument is a boolean action, which is set to the corresponding boolean value from the second (or later) value argument:

  • pass: Whether to pass fetch-related messages through to the normal putmsg mechanisms, i.e. printing, logging and/or <putmsg> function (if enabled). Since messages can also be saved for later return via <urlinfo>, this is often turned off to prevent the need for duplicate handlers. Non-fetch messages (<sql>, etc) are unaffected by this. On by default.

  • save: Whether to save messages in a buffer for later retrieval with <urlinfo putmsgs>. Calling <urlinfo putmsgs> inside a <fetch parallel> loop will return only the messages for the just-completed fetch, making disambiguation of messages easier than with the normal script <putmsg> function callback mechanism. On by default.

  • all: Set pass and save (in that order) according to the next value argument values.

  • clear: Clear the current fetch putmsg buffer. No arguments.

  Returns the previous setting(s) (two values if all used). The putmsg setting was added in version 6.

• redirmsgs (boolean) If true, info messages about redirects will be printed (via the putmsg mechanism). If false (default), such messages are suppressed.

• scriptmsgs (boolean or int) If true, JavaScript errors are printed/logged via the putmsg mechanism (here). If false (default), such errors are suppressed. Many JavaScript pages generate errors due to script bugs, or varying execution environments, so this setting is off by default. Turning it on can help isolate JavaScript-related issues on a page. Note that this applies to syntax-type errors from the engine; certain external fatal errors are still reported regardless, such as exceeding resource limits (time/memory/page size). Returns previous setting. Added in version 4.01.1023500000 20020607.

  In version 7.01.1385154000 20131122 and later, an integer value is interpreted as a set of bit flags controlling which types of errors to report: flag 0x1 for ordinary script errors, flag 0x2 for assert() failures (which were unreported prior to version 7.00.1372360000 20130627). String boolean values now set all flags on or off.

• traceauth (integer) Set trace message level for client/server authentication calls. Value is a bitwise OR of any of the following flag values; the default is 0 (i.e. no tracing):

  • 0x0001: Protection spaces made (added, expanded, deleted etc.)

  • 0x0002: Protection spaces used (attached, detached)

  • 0x0004: Authentication objects used (stop, start, handle, connection closed, headers etc.)

  • 0x0008: Authentication protocol-specific messages

  • 0x0010: Keep-Alive (persistent connections) messages

  • 0x0020: WWW-Authenticate parsing

  • 0x0040: Connection open/close/idlde/re-use

  • 0x0080: Socket/descriptor/handle open/close
  Note: Setting a non-zero value may also print sensitive data such as authentication or password strings. Flag values may be added to or change in future releases. Added in version 5.1. Note that traceauth values changed in version 7.06.1465245000 20160606.

• tracecalls (integer) Set trace message level for fetch-related function calls. This is a bitwise OR of integer values indicating which calls to issue messages for; the default is 0 (i.e. no tracing):

  • 0x0001: <urlcp> calls

  • 0x0002: <fetch> calls

  • 0x0100: Print full arguments (do not truncate)
  Note that these values may change in future releases, as this is a debug setting. Added in version 5.01.1200000000 20080110.

• tracedns (integer)

  Set trace message level for DNS (IP address parsing and hostname lookup) calls. In version 7.07.1553195000 20190321 and later, the value is a bitwise OR of integer values:

  • 0x0001: Config, hosts files opened; environment variables examined

  • 0x000002: Config and hosts files lines/entries parsed

  • 0x000004: Texis and internal API calls

  • 0x000008: After getaddrinfo(), getnameinfo() system calls

  • 0x000010: DNS query messages sent and received

  • 0x000020: DNS cache entries and management

  • 0x080000: Before getaddrinfo(), getnameinfo() system calls
  Values may change or be added to in future releases.

  In versions prior to 7.07.1553195000 20190321, the value was an incrementing integer, i.e. each level provides messages at its level and all preceding levels; the default is 0 (i.e. no tracing):

  • 0 No tracing

  • 1 gethostbyname(), gethostbyaddr() calls; miscellaneous warnings

  • 2 Service calls (hosts/BIND/NIS); nsswitch.conf and host.conf parse

  • 3 Packets sent/received

  • 4 Individual config entries, /etc/hosts entities, reply RR entries

  • 5 All socket calls
  Values may change or be added to in future releases. Added in version 3.0.948765000 20000124; changed to bit flags in version 7.07.1553195000 20190321.

• traceencoding (integer) Sets trace message level for content and transfer encoding calls. Value is a bitwise OR of any of the following flags; the default is 0 (i.e. no tracing):

  • 0x0001: Open/close objects

  • 0x0002: ...TranslateEncoding filter calls

  • 0x0004: Decoder object state changes etc.

  • 0x0040: Data read

  • 0x0080: Data written
  Values may change or be added to in future releases. Added in version 5.01.1249039000 20090731.

• tracefetch (integer) Set trace message level for fetch library calls. Value is a bitwise OR of any of the following flags; the default is 0 (i.e. no tracing):

  • 0x0001: Top-level (user-initiated) fetch

  • 0x0002: Component (script/frame) fetch

  • 0x0004: Component fetch from cache

  • 0x0008: Static (HTML) links added while formatting

  • 0x0010: Script links added

  • 0x0020: Static images/frames/etc. added

  • 0x0040: Script images/frames/etc. added

  • 0x0080: Top-level fetch from user-provided source

  • 0x0100: Proxy cache activity (except script fetches)

  • 0x0200: Redirect fetch

  • 0x0400: Authorization fetch

  • 0x0800: Proxy retry fetch (attempt with 2nd+ proxy)

  • 0x1000: Empty-response retry fetch

  • 0x2000: PAC script fetch

  Added in version 5.01.1147127000 20060508. Bit 0x0080 added in version 6.00.1308203000 20110616. Bit 0x0100 added in version 7.04.1446832000 20151106. Bits 0x200 - 0x2000 added in version 7.06.1471876000 20160822. Setting 0x3e03 should trace all network activity. Values may change or be added to in future releases.

• tracescript (integer) Set trace message level for JavaScript calls. Value is a bitwise OR of any of the following flags; the default is 0 (i.e. no tracing):

  • 0x0001: Inline scripts run

  • 0x0002: Remote scripts run

  • 0x0004: javascript:-protocol links run

  • 0x0008: Timers run

  • 0x0010: Objects checked for events

  • 0x0020: Modify-and-call-event-handler objects run

  • 0x0040: Event handlers run (normal or modify)

  • 0x0080: Check-string-for-URL called

  • 0x0100: Check-string-for-URL link added

  • 0x0200: Script output inserted (into raw HTML parse buffer)

  • 0x0400: Event handlers added

  • 0x0800: Memory allocated

  • 0x1000: Memory freed
  Added in version 4.04.1082500000 20040420. Values may change or be added to in future releases.

• traceskt (integer) Set trace message level for socket (i.e. over-the-wire network traffic) calls. Value is a bitwise OR of any of the following flag values; the default is 0 (i.e. no tracing):

  • 0x0000001: After open(), close(), accept() etc.

  • 0x0000002: After select()

  • 0x0000004: After reads

  • 0x0000008: After writes

  • 0x0000010: After ioctl(), getsockopt()

  • 0x0000020: Currently unused

  • 0x0000040: The data read

  • 0x0000080: The data written, or sent with ioctl()

  • 0x0000100: Details of SSL verification of peer certificate

  • 0x0010000: Before open(), close(), accept() etc.

  • 0x0020000: Before select()

  • 0x0040000: Before reads

  • 0x0080000: Before writes

  • 0x0100000: Before ioctl(), getsockopt()

  • 0x0200000: Currently unused

  • 0x0400000: The data buffer before reads

  • 0x0800000: The data buffer before writes or ioctl()

  • 0x1000000: Request SSL peer certificate (if not already requested)
  Note: Setting a non-zero value may also print sensitive data such as authentication or password strings. Added in version 5.01.1103682324 20041221. Values may be added to or change in future releases.

• verbose (integer) Sets the verbosity level; used for debugging. This is a bitwise OR of integer values indicating what high-level protocol information to print:

  • 0x000001: Response connection protocol, IP and tunnel

  • 0x000002: Request connection protocol, IP and tunnel

  • 0x000004: Response lines

  • 0x000008: Request lines

  • 0x000010: Response headers

  • 0x000020: Request headers

  • 0x000040: Do response binary-MIME flags also, if text-like MIME

  • 0x000080: Do request binary-MIME flags also, if text-like MIME

  • 0x000100: (Small) response raw document in hex, if binary MIME

  • 0x000200: (Small) response raw document, if text-like MIME

  • 0x000400: (Small) response formatted text, if text-like MIME

  • 0x000800: Unused

  • 0x001000: (Medium) response raw document in hex, if binary MIME

  • 0x002000: (Medium) response raw document, if text-like MIME

  • 0x004000: (Medium) response formatted text, if text-like MIME

  • 0x008000: Unused

  • 0x010000: (Small) request raw document in hex

  • 0x020000: (Small) request raw document, if text-like MIME

  • 0x040000: (Small) request formatted text, if text-like MIME

  • 0x080000: Unused

  • 0x100000: (Medium) request raw document in hex

  • 0x200000: (Medium) request raw document, if text-like MIME

  • 0x400000: (Medium) request formatted text, if text-like MIME

  • 0x800000: Unused

  A "small" flag prints only up to 16 lines of the content; a "medium" flag only up to 128 lines; both together print the entire document. Note that the raw document is the "payload" document as returned by <urlinfo rawdoc>, i.e. after transfer/content encodings have been removed.

  Previous to version 5.01.1093600000 20040826 the verbose setting was an incrementing integer, 0 to 2. Previous to version 7.07.1545428000 20181221 only the request/response lines/headers flags existed, and were 4x (2 bit positions) smaller. Some flags unsupported in some conditions, e.g. document flags are generally unsupported when the document is coming from or going to a file or pipe.

  Note: Setting a non-zero verbosity level may also print sensitive data such as authentication or password strings.

• userdatafetchmsgsanderr (boolean)

  Whether to issue putmsgs (and return UserDataFetchNeedsMoreData err) for components, redirects, etc. that are not fetched due to top-level fetch being from user-data and not network (e.g. <fetch> with a given downloaddoc). Default on; added in version 7.07.1605645000 20201117. Returns previous value.