2017-08-18 19:32:17 +00:00
|
|
|
|
[[PrefaceTypographicConventions]]
|
|
|
|
|
|
|
|
|
|
=== Typographic Conventions
|
|
|
|
|
|
|
|
|
|
The following table shows the typographic conventions that are used in this guide.
|
|
|
|
|
|
2019-02-14 23:23:05 +00:00
|
|
|
|
// https://github.com/oreillymedia/orm_book_samples/blob/master/asciidoc_only/preface.adoc
|
2017-08-18 19:32:17 +00:00
|
|
|
|
|
2018-02-04 19:39:56 +00:00
|
|
|
|
// AsciiDoc allows alternative markup for some styles, specifially
|
|
|
|
|
// 'single quotes' and _underlines_ for italics and +plus signs+ and
|
|
|
|
|
// `backticks` for monospaces.
|
2018-02-04 23:15:02 +00:00
|
|
|
|
// Asciidoctor’s modern mode is more strict, and only allows _underline_
|
2018-02-04 19:39:56 +00:00
|
|
|
|
// italics and `backtick` monospaces.
|
2019-07-20 15:13:59 +00:00
|
|
|
|
// https://asciidoctor.org/docs/migration/
|
2018-02-04 19:39:56 +00:00
|
|
|
|
|
2017-08-18 19:32:17 +00:00
|
|
|
|
.Typographic Conventions
|
|
|
|
|
[options="header",cols="1,3,3"]
|
2019-09-16 17:27:45 +00:00
|
|
|
|
|===
|
2017-08-18 19:32:17 +00:00
|
|
|
|
|Style|Description|Example
|
2018-02-04 19:39:56 +00:00
|
|
|
|
|_Italic_ |File names, folder names, and extensions |_C:\Development\wireshark_.
|
2018-02-04 23:15:02 +00:00
|
|
|
|
|`Monospace` |Commands, flags, and environment variables|CMake’s `-G` option.
|
2017-08-18 19:32:17 +00:00
|
|
|
|
|**`Bold Monospace`** |Commands that should be run by the user|Run **`cmake -G Ninja ..`**.
|
2017-08-23 21:46:24 +00:00
|
|
|
|
|btn:[Button] |Dialog and window buttons |Press btn:[Launch] to go to the Moon.
|
2017-08-18 19:32:17 +00:00
|
|
|
|
|kbd:[Key] |Keyboard shortcut |Press kbd:[Ctrl+Down] to move to the next packet.
|
2017-08-22 17:33:49 +00:00
|
|
|
|
|menu:Menu[] |Menu item |Select menu:Go[Next Packet] to move to the next packet.
|
2019-09-16 17:27:45 +00:00
|
|
|
|
|===
|
2017-08-18 19:32:17 +00:00
|
|
|
|
|
|
|
|
|
==== Admonitions
|
|
|
|
|
|
|
|
|
|
Important and notable items are marked as follows:
|
|
|
|
|
|
|
|
|
|
[WARNING]
|
|
|
|
|
.This is a warning
|
|
|
|
|
====
|
|
|
|
|
You should pay attention to a warning, otherwise data loss might occur.
|
|
|
|
|
====
|
|
|
|
|
|
|
|
|
|
[NOTE]
|
|
|
|
|
.This is a note
|
|
|
|
|
====
|
|
|
|
|
A note will point you to common mistakes and things that might not be obvious.
|
|
|
|
|
====
|
|
|
|
|
|
|
|
|
|
[TIP]
|
|
|
|
|
.This is a tip
|
|
|
|
|
====
|
|
|
|
|
Tips are helpful for your everyday work using Wireshark.
|
|
|
|
|
====
|
|
|
|
|
|
|
|
|
|
==== Shell Prompt and Source Code Examples
|
|
|
|
|
|
|
|
|
|
.Bourne shell, normal user
|
|
|
|
|
----
|
|
|
|
|
$ # This is a comment
|
|
|
|
|
$ git config --global log.abbrevcommit true
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
.Bourne shell, root user
|
|
|
|
|
----
|
|
|
|
|
# # This is a comment
|
|
|
|
|
# ninja install
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
.Command Prompt (cmd.exe)
|
|
|
|
|
----
|
|
|
|
|
>rem This is a comment
|
|
|
|
|
>cd C:\Development
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
.PowerShell
|
|
|
|
|
----
|
|
|
|
|
PS$># This is a comment
|
|
|
|
|
PS$>choco list -l
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
.C Source Code
|
|
|
|
|
----
|
|
|
|
|
#include "config.h"
|
|
|
|
|
|
|
|
|
|
/* This method dissects foos */
|
|
|
|
|
static int
|
|
|
|
|
dissect_foo_message(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree _U_, void *data _U_)
|
|
|
|
|
{
|
|
|
|
|
/* TODO: implement your dissecting code */
|
|
|
|
|
return tvb_captured_length(tvb);
|
|
|
|
|
}
|
|
|
|
|
----
|