Menu
Amazon Web Services
General Reference (Version 1.0)

Document Conventions

This section lists the common typographical conventions for AWS technical publications.

Typographical Conventions

This section describes common typographical conventions.

Convention Description/Example

A callout is a number in the body text to give you a visual reference. The reference point is for further discussion elsewhere

java -version

Inline code (including commands, constants, XML elements, logical values, operations, parameters, and regular expressions)

Copy
# ls -l /var/www/html/index.html -rw-rw-r-- 1 root root 1872 Jun 21 09:33 /var/www/html/index.html # date Wed Jun 21 09:33:42 EDT 2006

Blocks of sample code

Copy
(start | stride | edge)

Mutually exclusive options separated by vertical bars

Copy
[-n, -quiet]

Copy
<CustomerId>[ID]</CustomerId>

Optional parameters

-or-

XML replaceable text

Amazon Machine Image (AMI)

Amazon EC2 User Guide for Linux Instances

Important words or phrases

-or-

Technical publications

MyPassword

Text that the user types

On the File menu, choose Properties.

Console pages, menus, sections, or fields

For more information, see Document Conventions.

Link to other content

your-s3-bucket

Copy
% ec2-register <your-s3-bucket>/image.manifest

<your-S3-bucket>

Placeholder text for a required value

CTRL + ENTER

Key names and key sequences