-.TH ascii 1 "" "Open Source"
-.SH NAME
-ascii -- report character aliases
-.SH SYNOPSIS
-ascii [-dxohv] [-t] [char-alias...]
-.SH OPTIONS
-Called with no options, ascii behaves like `ascii -h'. Options
-are as follows:
-.TP
-.B \-t
-Script-friendly mode, emits only ISO/decimal/hex/octal/binary
-encodings of the character.
-.TP
-.B \-s
-Parse multiple characters. Convenient way of parsing strings.
-.TP
-.B \-d
-Ascii table in decimal.
-.TP
-.B \-x
-Ascii table in hex.
-.TP
-.B \-o
-Ascii table in octal.
-.TP
-.B \-h, -?
-Show summary of options and a simple ASCII table.
-.TP
-.B \-v
-Show version of program.
-.SH DESCRIPTION
-Characters in the ASCII set can have many aliases, depending on context. A
-character's possible names include:
-.TP 3
-*
-Its bit pattern (binary representation).
-.TP 3
-*
-Its hex, decimal and octal representations.
-.TP 3
-*
-Its teletype mnemonic and caret-notation form (for control chars).
-.TP 3
-*
-Its backlash-escape form in C (for some control chars).
-.TP 3
-*
-Its printed form (for printables).
-.TP 3
-*
-Its full ISO official name in English.
-.TP 3
-*
-Its ISO/ECMA code table reference.
-.TP 3
-*
-Its name as an HTML/SGML entity.
-.TP 3
-*
-Slang and other names in wide use for it among hackers.
-.P
-This utility accepts command-line strings and tries to interpret them as
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY % ISOnum PUBLIC "ISO 8879:1986//ENTITIES Numeric and Special Graphic//EN">
+%ISOnum;
+<!ENTITY % ISOpub PUBLIC "ISO 8879:1986//ENTITIES Publishing//EN">
+%ISOpub;
+]>
+<refentry id='ascii.1'>
+<refmeta>
+<refentrytitle>ascii</refentrytitle>
+<manvolnum>1</manvolnum>
+<refmiscinfo class='source'>Open Source</refmiscinfo>
+</refmeta>
+<refnamediv id='name'>
+<refname>ascii</refname>
+<refpurpose>report character aliases</refpurpose>
+</refnamediv>
+<refsynopsisdiv id='synopsis'>
+
+<cmdsynopsis>
+ <!-- ascii [ \-dxohv ] [ \-t ] [ char\-alias ... ] -->
+ <command>ascii</command> <arg choice='opt'>-dxohv </arg>
+ <arg choice='opt'>-t </arg>
+ <arg choice='opt' rep='repeat'><replaceable>char-alias</replaceable></arg>
+</cmdsynopsis>
+
+</refsynopsisdiv>
+
+<refsect1 id='options'><title>OPTIONS</title>
+<para>Called with no options, <command>ascii</command> behaves like
+`ascii -h'. Options are as follows:</para>
+<variablelist remap='TP'>
+<varlistentry>
+<term>
+<cmdsynopsis>
+ <arg choice='plain'>-t </arg>
+</cmdsynopsis>
+</term>
+<listitem>
+<para>Script-friendly mode, emits only ISO/decimal/hex/octal/binary
+encodings of the character.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>
+<cmdsynopsis>
+ <arg choice='plain'>-s </arg>
+</cmdsynopsis>
+</term>
+<listitem>
+<para>Parse multiple characters. Convenient way of parsing strings.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>
+<cmdsynopsis>
+ <arg choice='plain'>-d </arg>
+</cmdsynopsis>
+</term>
+<listitem>
+<para>Ascii table in decimal.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>
+<cmdsynopsis>
+ <arg choice='plain'>-x </arg>
+</cmdsynopsis>
+</term>
+<listitem>
+<para>Ascii table in hex.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>
+<cmdsynopsis>
+ <arg choice='plain'>-o </arg>
+</cmdsynopsis>
+</term>
+<listitem>
+<para>Ascii table in octal.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>
+<cmdsynopsis>
+ <arg choice='plain'>-h, </arg>
+ <arg choice='plain'>-? </arg>
+</cmdsynopsis>
+</term>
+<listitem>
+<para>Show summary of options and a simple ASCII table.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>
+<cmdsynopsis>
+ <arg choice='plain'>-v </arg>
+</cmdsynopsis>
+</term>
+<listitem>
+<para>Show version of program.</para>
+</listitem>
+</varlistentry>
+</variablelist>
+
+</refsect1>
+
+<refsect1 id='description'><title>DESCRIPTION</title>
+<para>Characters in the ASCII set can have many aliases, depending on
+context. A character's possible names include:</para>
+<variablelist remap='TP'>
+<varlistentry>
+<term>*</term>
+<listitem>
+<para>Its bit pattern (binary representation).</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>*</term>
+<listitem>
+<para>Its hex, decimal and octal representations.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>*</term>
+<listitem>
+<para>Its teletype mnemonic and caret-notation form (for control chars).</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>*</term>
+<listitem>
+<para>Its backlash-escape form in C (for some control chars).</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>*</term>
+<listitem>
+<para>Its printed form (for printables).</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>*</term>
+<listitem>
+<para>Its full ISO official name in English.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>*</term>
+<listitem>
+<para>Its ISO/ECMA code table reference.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>*</term>
+<listitem>
+<para>Its name as an HTML/SGML entity.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>*</term>
+<listitem>
+<para>Slang and other names in wide use for it among hackers.</para>
+</listitem>
+</varlistentry>
+</variablelist>
+
+
+<para>This utility accepts command-line strings and tries to interpret them as
one of the above.
-When it finds a value, it prints \fIall\fR of the names
+When it finds a value, it prints <emphasis remap='I'>all</emphasis> of the names
of the character.
The constructs in the following list can be used to
specify character values.
If an argument could be interpreted in two or more
-ways, names for all the different characters it might be are dumped.
-.TP 12
-.I character
-Any character not described by one of the following conventions
-represents the character itself.
-.TP
-.BI ^ character
-A caret followed by a character.
-.TP
-.BI \e \|character
-A backslash followed by certain special characters (abfnrtv).
-.TP
-.I mnemonic
-An ASCII teletype mnemonic.
-.TP
-.I hexadecimal
-A hexadecimal (hex) sequence consists of one or two case-insensitive hex digit
+ways, names for all the different characters it might be are dumped.</para>
+<variablelist remap='TP'>
+<varlistentry>
+<term><emphasis remap='I'>character</emphasis></term>
+<listitem>
+<para>Any character not described by one of the following conventions
+represents the character itself.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term><emphasis remap='B'>^</emphasis><emphasis remap='I'>character</emphasis></term>
+<listitem>
+<para>A caret followed by a character.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term><emphasis remap='B'>\</emphasis><emphasis remap='I'>character</emphasis></term>
+<listitem>
+<para>A backslash followed by certain special characters (abfnrtv).</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term><emphasis remap='I'>mnemonic</emphasis></term>
+<listitem>
+<para>An ASCII teletype mnemonic.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term><emphasis remap='I'>hexadecimal</emphasis></term>
+<listitem>
+<para>A hexadecimal (hex) sequence consists of one or two case-insensitive hex digit
characters (01234567890abcdef).
To ensure hex interpretation use
-.IB hex h ,
-.BI 0x hex,
-.BI x hex
+<emphasis remap='I'>hex</emphasis><emphasis remap='B'>h</emphasis><emphasis remap='I'>,</emphasis>
+<emphasis remap='B'>0x</emphasis><emphasis remap='I'>hex,</emphasis>
+<emphasis remap='B'>x</emphasis><emphasis remap='I'>hex</emphasis>
or
-.BI \e\|x hex.
-.TP
-.I decimal
-A decimal sequence consists of one, two or three decimal digit
+<emphasis remap='B'>\x</emphasis><emphasis remap='I'>hex.</emphasis></para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term><emphasis remap='I'>decimal</emphasis></term>
+<listitem>
+<para>A decimal sequence consists of one, two or three decimal digit
characters (0123456789).
To ensure decimal interpretation use
-.BI \e0d decimal,
-.BI d decimal,
+<emphasis remap='B'>\0d</emphasis><emphasis remap='I'>decimal,</emphasis>
+<emphasis remap='B'>d</emphasis><emphasis remap='I'>decimal,</emphasis>
or
-.BI \e\|d decimal.
-.TP
-.I octal
-An octal sequence consists of one, two or three octal digit
+<emphasis remap='B'>\d</emphasis><emphasis remap='I'>decimal.</emphasis></para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term><emphasis remap='I'>octal</emphasis></term>
+<listitem>
+<para>An octal sequence consists of one, two or three octal digit
characters (01234567).
To ensure octal interpretation use
-.BI \e \|octal,
-.BI 0o octal,
-.BI o octal,
+<emphasis remap='B'>\</emphasis><emphasis remap='I'>octal,</emphasis>
+<emphasis remap='B'>0o</emphasis><emphasis remap='I'>octal,</emphasis>
+<emphasis remap='B'>o</emphasis><emphasis remap='I'>octal,</emphasis>
or
-.BI \e\|o octal.
-.TP
-.I bit pattern
-A bit pattern (binary) sequence consists of one to eight binary digit
+<emphasis remap='B'>\o</emphasis><emphasis remap='I'>octal.</emphasis></para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term><emphasis remap='I'>bit pattern</emphasis></term>
+<listitem>
+<para>A bit pattern (binary) sequence consists of one to eight binary digit
characters (01).
To ensure bit interpretation use
-.BI 0b bit\ pattern,
-.BI b bit\ pattern
+<emphasis remap='B'>0b</emphasis><emphasis remap='I'>bit pattern,</emphasis>
+<emphasis remap='B'>b</emphasis><emphasis remap='I'>bit pattern</emphasis>
or
-.BI \e\|b bit\ pattern.
-.TP
-.IR ISO / ECMA\ code
-A ISO/ECMA code sequence consists of one or two decimal digit characters,
-a slash, and one or two decimal digit characters.
-.TP
-.I name
-An official ASCII or slang name.
-.P
-The slang names recognized and printed out are from a rather comprehensive
-list that first appeared on USENET in early 1990 and has been
-continuously updated since.
-Mnemonics recognized and printed include the official ASCII set,
-some official ISO names (where those differ)
-and a few common-use alternatives (such as NL for LF).
-HTML/SGML entity names are also printed when applicable.
-All comparisons are
-case-insensitive, and dashes are mapped to spaces.
-Any unrecognized arguments or out of range values are silently ignored.
-Note that the -s option will not recognize 'long' names, as it cannot
-differentiate them from other parts of the string.
-.P
-For correct results, be careful to stringize or quote shell metacharacters
-in arguments (especially backslash).
-.P
-This utility is particularly handy for interpreting cc(1)'s ugly
+<emphasis remap='B'>\b</emphasis><emphasis remap='I'>bit pattern.</emphasis></para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term><emphasis remap='I'>ISO</emphasis>/<emphasis remap='I'>ECMA code</emphasis></term>
+<listitem>
+<para>A ISO/ECMA code sequence consists of one or two decimal digit characters,
+a slash, and one or two decimal digit characters.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term><emphasis remap='I'>name</emphasis></term>
+<listitem>
+<para>An official ASCII or slang name.</para>
+</listitem>
+</varlistentry>
+</variablelist>
+
+<para>The slang names recognized and printed out are from a rather
+comprehensive list that first appeared on USENET in early 1990 and has
+been continuously updated since. Mnemonics recognized and printed
+include the official ASCII set, some official ISO names (where those
+differ) and a few common-use alternatives (such as NL for LF).
+HTML/SGML entity names are also printed when applicable. All
+comparisons are case-insensitive, and dashes are mapped to spaces.
+Any unrecognized arguments or out of range values are silently
+ignored. Note that the <option>-s</option> option will not recognize
+'long' names, as it cannot differentiate them from other parts of the
+string.</para>
+
+<para>For correct results, be careful to stringize or quote shell
+metacharacters in arguments (especially backslash).</para>
+
+<para>This utility is particularly handy for interpreting cc(1)'s ugly
octal `invalid-character' messages, or when coding anything to do with serial
communications.
As a side effect it serves as a handy base-converter
-for random 8-bit values.
-.SH AUTHOR
-Eric S. Raymond <esr@snark.thyrsus.com> November 1990 (home page at
-http://www.tuxedo.org/~esr/home.html).
-Reproduce, use,
-and modify as you like as long as you don't remove this authorship notice.
-Ioannis E. Tambouras <ioannis@debian.org> added command options and minor
-enhancements.
-Brian J. Ginsbach <ginsbach@sgi.com> fixed several bugs and expanded the
-man page.
-David N. Welton <davidw@efn.org> added the -s option.
-Matej Vela corrected the ISO names.
-Dave Capella contributed the idea of listing HTML/SGML entities.
+for random 8-bit values.</para>
+</refsect1>
+
+<refsect1 id='author'><title>AUTHOR</title>
+<para>Eric S. Raymond <esr@snark.thyrsus.com> November 1990
+(home page at <ulink
+url='http://www.tuxedo.org/'>http://www.tuxedo.org/</ulink>~esr/home.html).
+Reproduce, use, and modify as you like as long as you don't remove
+this authorship notice. Ioannis E. Tambouras
+<ioannis@debian.org> added command options and minor
+enhancements. Brian J. Ginsbach <ginsbach@sgi.com> fixed
+several bugs and expanded the man page. David N. Welton
+<davidw@efn.org> added the <option>-s</option> option. Matej
+Vela corrected the ISO names. Dave Capella contributed the idea of
+listing HTML/SGML entities.</para>
+</refsect1>
+</refentry>
+G
projects / ascii.git / commitdiff