diff --git a/docs/scripting.xml b/docs/scripting.xml index d8a234aa1..7aa6d59a9 100644 --- a/docs/scripting.xml +++ b/docs/scripting.xml @@ -2287,6 +2287,44 @@ PORT STATE SERVICE |_ users: root, foo, bar + + + + There are conventions regarding the formatting of certain kinds + of data in structured output. Users of NSE output benefit by + being able to assume that some kinds of data, for instance dates + and times, are formatted the same way, even in different + scripts. + + + Network addresses, for example IPv4, IPv6, and MAC, are + represented as strings. + + + Dates and times are formatted according to + RFC + 3339RFC 3339. + If the time zone offset is known, they should appear like these + examples: + +2012-09-07T23:37:42+00:00 +2012-09-07T23:37:42+02:00 + + If the time zone offset is not known (representing some + unspecified local time), leave off the offset part: + +2012-09-07T23:37:42 + + The standard library function + stdnse.format_timestamp code exists to format times + for structured output. It takes an optional time zone offset in + seconds and automatically shifts the date to be correct within + that offset. + +stdnse.format_timestamp(os.time(), 0) --> "2012-09-07T23:37:42+00:00" + + +