forked from osmocom/wireshark
af180cc7d0
Change the name of the button macro to "btn" in order to be compatible with AsciiDoctor. Change-Id: I673e0fe0ae7b343abeb1afba0b9b11402efdf0d6 Reviewed-on: https://code.wireshark.org/review/23187 Reviewed-by: Gerald Combs <gerald@wireshark.org>
81 lines
1.9 KiB
Text
81 lines
1.9 KiB
Text
[[PrefaceTypographicConventions]]
|
|
|
|
=== Typographic Conventions
|
|
|
|
The following table shows the typographic conventions that are used in this guide.
|
|
|
|
// https://github.com/oreillymedia/orm_book_samples/blob/master/asciidoc_only/preface.asciidoc
|
|
|
|
.Typographic Conventions
|
|
[options="header",cols="1,3,3"]
|
|
|===============
|
|
|Style|Description|Example
|
|
|'Italic' |File names, folder names, and extensions |'C:\Development\wireshark'.
|
|
|`Monospace` |Commands, flags, and environment variables|CMake's `-G` option.
|
|
|**`Bold Monospace`** |Commands that should be run by the user|Run **`cmake -G Ninja ..`**.
|
|
|btn:[Button] |Dialog and window buttons |Press btn:[Launch] to go to the Moon.
|
|
|kbd:[Key] |Keyboard shortcut |Press kbd:[Ctrl+Down] to move to the next packet.
|
|
|menu:Menu[] |Menu item |Select menu:Go[Next Packet] to move to the next packet.
|
|
|===============
|
|
|
|
==== 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);
|
|
}
|
|
----
|