GROFF_MDOC
Section: Environments, Tables, and Troff Macros (7)Index Return to Main Contents
BSD mandoc
NAME
groff_mdoc - reference for groff's mdoc implementationSYNOPSIS
groff -m doc file ...DESCRIPTION
A complete reference for writing UNIX manual pages with the -mdoc macro package; a content -based and domain -based formatting package for GNU troff(1). Its predecessor, the -man7 package, addressed page layout leaving the manipulation of fonts and other typesetting details to the individual author. In -mdoc page layout macros make up the page structure domain which consists of macros for titles, section headers, displays and lists - essentially items which affect the physical position of text on a formatted page. In addition to the page structure domain, there are two more domains, the manual domain and the general text domain. The general text domain is defined as macros which perform tasks such as quoting or emphasizing pieces of text. The manual domain is defined as macros that are a subset of the day to day informal language used to describe commands, routines and related UNIX files. Macros in the manual domain handle command names, command line arguments and options, function names, function parameters, pathnames, variables, cross references to other manual pages, and so on. These domain items have value for both the author and the future user of the manual page. Hopefully, the consistency gained across the manual set will provide easier translation to future documentation tools.Throughout the UNIX manual pages, a manual entry is simply referred to as a man page, regardless of actual length and without sexist intention.
GETTING STARTED
The material presented in the remainder of this document is outlined as follows:-
TROFF IDIOSYNCRASIES
- "Macro Usage"
- "Passing Space Characters in an Argument"
- "Trailing Blank Space Characters"
- "Escaping Special Characters"
- "Other Possible Pitfalls"
- A MANUAL PAGE TEMPLATE
- CONVENTIONS
- TITLE MACROS
-
INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS
- "What's in a Name" ...
- "General Syntax"
-
MANUAL DOMAIN
- "Addresses"
- "Author Name"
- "Arguments"
- "Configuration Declarations (Section Four Only)"
- "Command Modifiers"
- "Defined Variables"
- "Errno's"
- "Environment Variables"
- "Flags"
- "Function Declarations"
- "Function Types"
- "Functions (Library Routines)"
- "Function Arguments"
- "Return Values"
- "Exit Status"
- "Interactive Commands"
- "Library Names"
- "Literals"
- "Names"
- "Options"
- "Pathnames"
- "Standards"
- "Variable Types"
- "Variables"
- "Manual Page Cross References"
-
GENERAL TEXT DOMAIN
- "AT&T Macro"
- "BSD Macro"
- "NetBSD Macro"
- "FreeBSD Macro"
- "OpenBSD Macro"
- "BSD/OS Macro"
- "UNIX Macro"
- "Emphasis Macro"
- "Font Mode"
- "Enclosure and Quoting Macros"
- "No-[or Normal Text Macro]
- "No-Space Macro"
- "Section Cross References"
- "Symbolics"
- "Mathematical Symbols"
- "References and Citations"
- "Trade Names (or Acronyms and Type Names)"
- "Extended Arguments"
-
PAGE STRUCTURE DOMAIN
- "Section Headers"
- "Subsection Headers"
- "Paragraphs and Line Spacing"
- "Keeps"
- "Examples and Displays"
- "Lists and Columns"
- MISCELLANEOUS MACROS
- PREDEFINED STRINGS
- DIAGNOSTICS
- FORMATTING WITH GROFF, TROFF, AND NROFF
- FILES
- SEE ALSO
- BUGS
TROFF IDIOSYNCRASIES
The -mdoc package attempts to simplify the process of writing a man page. Theoretically, one should not have to learn the tricky details of GNU troff(1) to use -mdoc however, there are a few limitations which are unavoidable and best gotten out of the way. And, too, be forewarned, this package is not fast.Macro Usage
As in GNU troff(1), a macro is called by placing a `.' (dot character) at the beginning of a line followed by the two-character (or three-character) name for the macro. There can be space or tab characters between the dot and the macro name. Arguments may follow the macro separated by spaces (but no tabs). It is the dot character at the beginning of the line which causes GNU troff(1) to interpret the next two (or more) characters as a macro name. A single starting dot followed by nothing is ignored. To place a `.' (dot character) at the beginning of an input line in some context other than a macro invocation, precede the `.' (dot) with the `\&' escape sequence which translates literally to a zero-width space, and is never displayed in the output.In general, GNU troff(1) macros accept an unlimited number of arguments (contrary to other versions of troff which can't handle more than nine arguments). In limited cases, arguments may be continued or extended on the next line (See Sx Extended Arguments below). Almost all macros handle quoted arguments (see Sx Passing Space Characters in an Argument below).
Most of the -mdoc general text domain and manual domain macros are special in that their argument lists are parsed for callable macro names. This means an argument on the argument list which matches a general text or manual domain macro name (and which is defined to be callable) will be executed or called when it is processed. In this case the argument, although the name of a macro, is not preceded by a `.' (dot). This makes it possible to nest macros; for example the option macro, `.[,] ' may call the flag and argument macros, `- ' and `file ... ' to specify an optional flag with an argument:
- [-s bytes ]
- is produced by `.[-s ] ' Ar bytes
To prevent a string from being interpreted as a macro name, precede the string with the escape sequence `\&' :
- [-s bytes ]
- is produced by `.[\&-s ] ' \&Ar bytes
Here the strings `- ' and `file ... ' are not interpreted as macros. Macros whose argument lists are parsed for callable arguments are referred to as parsed and macros which may be called from an argument list are referred to as callable throughout this document. This is a technical faux pas as almost all of the macros in -mdoc are parsed, but as it was cumbersome to constantly refer to macros as being callable and being able to call other macros, the term parsed has been used.
In the following, we call an -mdoc macro which starts a line (with a leading dot) a command if this distinction is necessary.
Passing Space Characters in an Argument
Sometimes it is desirable to give as an argument a string containing one or more blank space characters, say, to specify arguments to commands which expect particular arrangement of items in the argument list. Additionally, it makes -mdoc working faster. For example, the function command `.Fn expects ' the first argument to be the name of a function and any remaining arguments to be function parameters. As ANSI~C stipulates the declaration of function parameters in the parenthesized parameter list, each parameter is guaranteed to be at minimum a two word string. For example, Fa int foo .
There are two possible ways to pass an argument which contains
an embedded space.
One way of passing a string containing blank spaces is to use the hard or
unpaddable space character
`\
,'
that is, a blank space preceded by the escape character
`\'
This method may be used with any macro but has the side effect of
interfering with the adjustment of text over the length of a line.
Troff
sees the hard space as if it were any other printable character and cannot
split the string into blank or newline separated pieces as one would expect.
This method is useful for strings which are not expected to overlap a line
boundary.
An alternative is to use
`\~'
,
a paddable (i.e. stretchable), unbreakable space (this is a
GNU
troff(1)
extension).
The second method is to enclose the string with double quotes.
For example:
- Fn fetch char *str
- is created by `.Fn fetch ' char\ *str
- Fn fetch char *str
- can also be created by `.Fn fetch ' q]char *strq]
If the `\' before the space in the first example or double quotes in the second example were omitted, `.Fn would ' see three arguments, and the result would be:
Fn fetch char *str
Trailing Blank Space Characters
Troff can be confused by blank space characters at the end of a line. It is a wise preventive measure to globally remove all blank spaces from Ao blank-space Ac Ns Ao end-of-line Ac character sequences. Should the need arise to use a blank character at the end of a line, it may be forced with an unpaddable space and the `\&' escape character. For example, `string\\& .'Escaping Special Characters
Special characters like the newline character `\n' are handled by replacing the `\' with `\e' (e.g. `\en' ) to preserve the backslash.Other Possible Pitfalls
A warning is emitted when an empty input line is found outside of displays (see below). Use `.sp' instead. (Well, it is even better to use -mdoc macros to avoid the usage of low-level commands.)Leading spaces will cause a break and are output directly. Avoid this behaviour if possible. Similarly, do not use more than one space character between words in an ordinary text line; contrary to other text formatters, they are not replaced with a single space.
You can't pass `q]' directly as an argument. Use `\*[q]' (or `\*q' ) instead.
By default, troff(1) inserts two space characters after a punctuation mark closing a sentence; characters like `)' or `'' are treated transparently, not influencing the sentence-ending behaviour. To change this, insert `\&' before or after the dot:
The .Ql . character. .Pp The .Ql \&. character. .Pp .No test . test .Pp .No test. test
gives
The `.' characterThe `.' character.
test test
test. test
As can be seen in the first and third line, -mdoc handles punctuation characters specially in macro arguments. This will be explained in section Sx General Syntax below. In the same way, you have to protect trailing full stops of abbreviations with a trailing zero-width space: `e.g.\&'
A comment in the source file of a man page can be either started with `.\' on a single line, `\' after some input, or `\#' anywhere (the latter is a GNU troff(1) extension); the rest of such a line is ignored.
A MANUAL PAGE TEMPLATE
The body of a man page is easily constructed from a basic template:.\" The following commands are required for all man pages. .Dd Month day, year .Os [OPERATING_SYSTEM] [version/release] .Dt DOCUMENT_TITLE [section number] [architecture/volume] .Sh NAME .Nm name .Nd one line description of name .\" This next command is for sections 2 and 3 only. .\" .Sh LIBRARY .Sh SYNOPSIS .Sh DESCRIPTION .\" The following commands should be uncommented and .\" used where appropriate. .\" .Sh IMPLEMENTATION NOTES .\" This next command is for sections 2, 3 and 9 function .\" return values only. .\" .Sh RETURN VALUES .\" This next command is for sections 1, 6, 7 and 8 only. .\" .Sh ENVIRONMENT .\" .Sh FILES .\" .Sh EXAMPLES .\" This next command is for sections 1, 6, 7, 8 and 9 only .\" (command return values (to shell) and .\" fprintf/stderr type diagnostics). .\" .Sh DIAGNOSTICS .\" .Sh COMPATIBILITY .\" This next command is for sections 2, 3 and 9 error .\" and signal handling only. .\" .Sh ERRORS .\" .Sh SEE ALSO .\" .Sh STANDARDS .\" .Sh HISTORY .\" .Sh AUTHORS .\" .Sh BUGS
The first items in the template are the commands `., ' `., ' and `. ' the document date, the operating system the man page or subject source is developed or modified for, and the man page title (in upper case along with the section of the manual the page belongs in. These commands identify the page and are discussed below in Sx TITLE MACROS .
The remaining items in the template are section headers ( .
)
of which Sx NAME , Sx SYNOPSIS , and Sx DESCRIPTION are mandatory. The headers are discussed in Sx PAGE STRUCTURE DOMAIN , after presentation of Sx MANUAL DOMAIN . Several content macros are used to demonstrate page layout macros; reading about content macros before page layout macros is recommended.CONVENTIONS
In the description of all macros below, optional arguments are put into brackets. An ellipsis ( `...' represents zero or more additional arguments. Alternative values for a parameter are separated with `|' If there are alternative values for a mandatory parameter, braces are used (together with `|' ) to enclose the value set. Meta-variables are specified within angles.Example:
- .Xx Aq foo Br q bar1 | bar2 [-test1 [-test2 | -test3] ] ...
Note that a macro takes effect up to the next nested macro. For example, `.foo ' Aq bar doesn't produce `foo <bar> ' but `foo Aq bar ' Consequently, a warning message is emitted for most commands if the first argument is a macro itself since it cancels the effect of the calling command completely. Another consequence is that quoting macros never insert literal quotes; `foo <bar> ' has been produced by `.q]foo ' <bar>q] .
Most macros have a default width value which can be used to specify a label width ( -width or offset ( -offset for the `.
' and `. ' macros. It is recommended not to use this rather obscure feature to avoid dependencies on local modifications of the -mdoc package.
TITLE MACROS
The title macros are part of the page structure domain but are presented first and separately for someone who wishes to start writing a man page yesterday. Three header macros designate the document title or manual page title, the operating system, and the date of authorship. These macros are called once at the very beginning of the document and are used to construct headers and footers only.- .
-
[Aq document title
]
[Aq section number
]
[Aq volume
]
The document title is the subject of the man page and must be in
CAPITALS
due to troff limitations.
If omitted,
`UNTITLED
'
is used.
The section number may be a number in the range
1,~ ... ,~9
or
`unass'
,
`draft'
,
or
`paper'
If it is specified, and no volume name is given, a default volume name is
used.
Under operating-system] the following sections are defined:
- 1 Ta volume-operating-system] volume-ds-1]
- 2 Ta volume-operating-system] volume-ds-2]
- 3 Ta volume-operating-system] volume-ds-3]
- 4 Ta volume-operating-system] volume-ds-4]
- 5 Ta volume-operating-system] volume-ds-5]
- 6 Ta volume-operating-system] volume-ds-6]
- 7 Ta volume-operating-system] volume-ds-7]
- 8 Ta volume-operating-system] volume-ds-8]
- 9 Ta volume-operating-system] volume-ds-9]
A volume name may be arbitrary or one of the following:
- USD Ta volume-ds-USD]
- PS1 Ta volume-ds-PS1]
- AMD Ta volume-ds-AMD]
- SMM Ta volume-ds-SMM]
- URM Ta volume-ds-URM]
- PRM Ta volume-ds-PRM]
- KM Ta volume-ds-KM]
- IND Ta volume-ds-IND]
- LOCAL Ta volume-ds-LOCAL]
- CON Ta volume-ds-CON]
For compatibility, `MMI' can be used for `IND' , and `LOC' for `LOCAL' Values from the previous table will specify a new volume name. If the third parameter is a keyword designating a computer architecture, its value is prepended to the default volume name as specified by the second parameter. By default, the following architecture keywords are defined: # we use `No' to avoid hyphenation
alpha , amiga , arc , arm26 , arm32 , atari , bebox , cobalt , evbsh3 hp300 , hpcmips , i386 , luna68k , m68k , mac68k , macppc , mips mmeye , mvme68k , news68k , newsmips , next68k , ofppc , pc532 , pmax powerpc , prep , sgimips , sh3 , sparc , sparc64 , sun3 , tahoe , vax x68k
In the following examples, the left (which is identical to the right) and the middle part of the manual page header strings are shown.
- .
- `FOO(7)' `volume-operating-system]' volume-ds-7]
- .
- `FOO(2)' `volume-operating-system]/volume-as-i386]' volume-ds-2]
- .
- `FOO' `bar'
Local, OS-specific additions might be found in the file mdoc.local look for strings named `volume-ds-XXX' (for the former type) and `volume-as-XXX' (for the latter type); `XXX' then denotes the keyword to be used with the `. ' macro.
This macro is neither callable nor parsed.
- . [Aq operating system ] [Aq release ]
-
- If the first parameter is empty, the default `operating-system] ' is used. This may be overridden in the local configuration file, mdoc.local In general, the name of the operating system should be the common acronym, e.g. BSD or ATT The release should be the standard release nomenclature for the system specified. In the following table, the possible second arguments for some predefined operating systems are listed. Similar to `. ' local additions might be defined in mdoc.local look for strings named `operating-system-XXX-YYY' , where `XXX' is the acronym for the operating system and `YYY' the release ID.
- ATT
- 7th, 7, III, 3, V, V.2, V.3, V.4
- BSD
- 3, 4, 4.1, 4.2, 4.3, 4.3t, 4.3T, 4.3r, 4.3R, 4.4
- NetBSD
- 0.8, 0.8a, 0.9, 0.9a, 1.0, 1.0a, 1.1, 1.2, 1.2a, 1.2b, 1.2c, 1.2d, 1.2e, 1.3, 1.3a, 1.4, 1.5, 1.6
- FreeBSD
- 1.0, 1.1, 1.1.5, <IP_ADDRESS>, 2.0, 2.0.5, 2.1, 2.1.5, 2.1.6, 2.1.7, 2.2, 2.2.1, 2.2.2, 2.2.5, 2.2.6, 2.2.7, 2.2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0
For ATT an unknown second parameter will be replaced with the string UNIX for the other predefined acronyms it will be ignored and a warning message emitted. Unrecognized arguments are displayed as given in the page footer. For instance, a typical footer might be:
.BSD 4.3
giving `4.3~Berkeley' Distribution , or for a locally produced set
.CS Department
which will produce `CS~Department'
If the `.macro ' is not present, the bottom left corner of the manual page will be ugly.
This macro is neither callable nor parsed.
- If the first parameter is empty, the default `operating-system] ' is used. This may be overridden in the local configuration file, mdoc.local In general, the name of the operating system should be the common acronym, e.g. BSD or ATT The release should be the standard release nomenclature for the system specified. In the following table, the possible second arguments for some predefined operating systems are listed. Similar to `. ' local additions might be defined in mdoc.local look for strings named `operating-system-XXX-YYY' , where `XXX' is the acronym for the operating system and `YYY' the release ID.
- .[Aq month
-
Aq day ,
Aq year
]
If
`has
'
no arguments,
`Epoch'
is used for the date string.
If it has exactly three arguments, they are concatenated, separated with
unbreakable space:
.January 25, 2001
Otherwise, the current date is used, ignoring the parameters.
This macro is neither callable nor parsed.
INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS
What's in a Name ...
The manual domain macro names are derived from the day to day informal language used to describe commands, subroutines and related files. Slightly different variations of this language are used to describe the three different aspects of writing a man page. First, there is the description of -mdoc macro command usage. Second is the description of a UNIX command with -mdoc macros, and third, the description of a command to a user in the verbal sense; that is, discussion of a command in the text of a man page.In the first case, troff(1) macros are themselves a type of command; the general syntax for a troff command is:
.Xx argument1 argument2 ...
`.Xx is ' a macro command, and anything following it are arguments to be processed. In the second case, the description of a UNIX command using the content macros is a bit more involved; a typical Sx SYNOPSIS command line might be displayed as:
filter [-flag ] Ao Ar infile Ac Ao Ar outfile Ac
Here, filter is the command name and the bracketed string -flag is a flag argument designated as optional by the option brackets. In -mdoc terms, Ao Ar infile Ac and Ao Ar outfile Ac are called meta arguments in this example, the user has to replace the meta expressions given in angle brackets with real file names. Note that in this document meta arguments are used to describe -mdoc commands; in most man pages, meta variables are not specifically written with angle brackets. The macros which formatted the above example:
.Nm filter .Op Fl flag .Ao Ar infile Ac Ao Ar outfile Ac
In the third case, discussion of commands and command syntax includes both examples above, but may add more detail. The arguments Ao Ar infile Ac and Ao Ar outfile Ac from the example above might be referred to as operands or file arguments Some command line argument lists are quite long:
- make
- [-eiknqrstv ] [-D variable ] [-d flags ] [-f makefile ] [-I directory ] [-j max_jobs ] [variable = value ] [target ... ]
Here one might talk about the command make and qualify the argument, makefile as an argument to the flag, -f or discuss the optional file operand target In the verbal context, such detail can prevent confusion, however the -mdoc package does not have a macro for an argument to a flag. Instead the `file ... ' argument macro is used for an operand or file argument like target as well as an argument to a flag like variable The make command line was produced from:
.Nm make .Op Fl eiknqrstv .Op Fl D Ar variable .Op Fl d Ar flags .Op Fl f Ar makefile .Op Fl I Ar directory .Op Fl j Ar max_jobs .Op Ar variable Ns = Ns Ar value .Bk .Op Ar target ... .Ek
The `.and ' `.macros ' are explained in Sx Keeps .
General Syntax
The manual domain and general text domain macros share a similar syntax with a few minor deviations; most notably, `.file ... ' `.- ' `.groff Fl m Ns Cm doc Ar ' and `.differ ' only when called without arguments; and `.Fn and ' `.impose ' an order on their argument lists. All content macros are capable of recognizing and properly handling punctuation, provided each punctuation character is separated by a leading space. If a command is given:
.sptr, ptr),
The result is:
sptr, ptr),
The punctuation is not recognized and all is output in the font used by `.file ... ' If the punctuation is separated by a leading white space:
.sptr , ptr ) ,
The result is:
sptr , ptr
The punctuation is now recognized and output in the default font distinguishing it from the argument strings. To remove the special meaning from a punctuation character escape it with `\&'
Troff is limited as a macro language, and has difficulty when presented with a string containing a member of the mathematical, logical or quotation set:
{+,-,/,*,%,<,>,<=,>=,=,==,&,`,',"}
The problem is that troff may assume it is supposed to actually perform the operation or evaluation suggested by the characters. To prevent the accidental evaluation of these characters, escape them with `\&' Typical syntax is shown in the first content macro displayed below, `. '
MANUAL DOMAIN
Addresses
The address macro identifies an address construct.
Usage: .Ao address Ac ...
- .addr1
- addr1
- .addr1 .
- addr1
- .addr1 , file2
- addr1 , file2
- .f1 , f2 , f3 :
- f1 , f2 , f3
- .addr ) ) ,
- addr ) )
Author Name
The `.An macro ' is used to specify the name of the author of the item being documented, or the name of the author of the actual manual page.
Usage: .An Ao author name Ac ...
- .An q]Joe Authorq]
- An Joe Author
- .An q]Joe Authorq] ,
- An Joe Author ,
- .An q]Joe Authorq] Aq<EMAIL_ADDRESS>- An Joe Author Aq<EMAIL_ADDRESS>- .An q]Joe Authorq] ) ) ,
- An Joe Author ) ) ,
The default width is 12n.
In the Sx AUTHORS section, the `.An command ' causes a line break allowing each new name to appear on its own line. If this is not desirable,
.An -nosplit
call will turn this off. To turn splitting back on, write
.An -split
Arguments
The .file ... argument macro may be used whenever an argument is referenced. If called without arguments, the `file ... ' string is output.
Usage: .[Ao argument Ac ...]
- .file ...
- file ...
- .file1
- file1
- .file1 .
- file1
- .file1 file2
- file1 file2
- .f1 f2 f3 :
- f1 f2 f3
- .file ) ) ,
- file ) )
Configuration Declaration (Section Four Only)
The `.macro ' is used to demonstrate a config(8) declaration for a device interface in a section four manual.
Usage: .Ao argument Ac ...
- .q]device le0 at scode?q]
- device le0 at scode?
In the Sx SYNOPSIS section a `.command ' causes a line break before and after its arguments are printed.
Command Modifiers
The command modifier is identical to the `.- ' (flag) command with the exception that the `.macro ' does not assert a dash in front of every argument. Traditionally flags are marked by the preceding dash, however, some commands or subsets of commands do not use them. Command modifiers may also be specified in conjunction with interactive commands such as editor commands. See Sx Flags .Defined Variables
A variable (or constant) which is defined in an include file is specified by the macro `. '
Usage: .Ao defined variable Ac ...
- .MAXHOSTNAMELEN
- MAXHOSTNAMELEN
- .TIOCGPGRP )
- TIOCGPGRP
Errno's
The `.Er errno ' macro specifies the error return value for section 2, 3, and~9 library routines. The second example below shows `.Er used ' with the `.Bq general ' text domain macro, as it would be used in a section two manual page.
Usage: .Er Ao errno type Ac ...
- .Er ENOENT
- Er ENOENT
- .Er ENOENT ) ;
- Er ENOENT ) ;
- .Bq Er ENOTDIR
- Bq Er ENOTDIR
Environment Variables
The `.macro ' specifies an environment variable.
Usage: .Ao argument Ac ...
- .DISPLAY
- DISPLAY
- .PATH .
- PATH
- .PRINTER ) ) ,
- PRINTER ) )
Flags
The `.- ' macro handles command line flags. It prepends a dash, `-' , to the flag. For interactive command flags, which are not prepended with a dash, the `.(command ' modifier) macro is identical, but without the dash.
Usage: .-Ao argument Ac ...
- .-
- -
- .-cfv
- -cfv
- .-cfv .
- -cfv
- .cfv .
- cfv
- .-s v t
- -s v t
- .-- ,
- --
- .-xyz ) ,
- -xyz )
- .-|
- -|
The `.- ' macro without any arguments results in a dash representing stdin/stdout. Note that giving `.- ' a single dash will result in two dashes.
Function Declarations
The `.Fd macro ' is used in the Sx SYNOPSIS section with section two or three functions. It is neither callable nor parsed.
Usage: .Fd Ao argument Ac ...
- .Fd q]#include <sys/types.h>q]
- Fd #include <sys/types.h>
In the Sx SYNOPSIS section a `.Fd command ' causes a line break if a function has already been presented and a break has not occurred. This leaves a nice vertical space in between the previous function call and the declaration for the next function.
The `.In ( ' #include statement) macro is the short form of the above example. It specifies the C~header file as being included in a C~program. It also causes a line break, and is neither callable nor parsed.
Usage: .In Ao header file Ac
- .In stdio.h
- In stdio.h
Function Types
This macro is intended for the Sx SYNOPSIS section. It may be used anywhere else in the man page without problems, but its main purpose is to present the function type in kernel normal form for the Sx SYNOPSIS of sections two and three (it causes a line break, allowing the function name to appear on the next line).
Usage: .Ft Ao type Ac ...
- .Ft struct stat
- Ft struct stat
Functions (Library Routines)
The `.Fn macro ' is modeled on ANSI~C conventions.
Usage: .Fn Ao function Ac [Ao parameter Ac ...]
- .Fn getchar
- Fn getchar
- .Fn strlen ) ,
- Fn strlen ) ,
- .Fn align q]char *ptrq] ,
- Fn align char *ptr ,
Note that any call to another macro signals the end of the `.Fn call ' (it will insert a closing parenthesis at that point).
For functions with many parameters (which is rare), the macros `.Fo (function ' open) and `.Fc (function ' close) may be used with `.Fa (function ' argument).
Example:
.Ft int .Fo res_mkquery .Fa "int op" .Fa "char *dname" .Fa "int class" .Fa "int type" .Fa "char *data" .Fa "int datalen" .Fa "struct rrec *newrr" .Fa "char *buf" .Fa "int buflen" .Fc
Produces:
Ft int Fo res_mkquery Fa int op Fa char *dname Fa int class Fa int type Fa char *data Fa int datalen Fa struct rrec *newrr Fa char *buf Fa int buflen Fc
In the Sx SYNOPSIS section, the function will always begin at the beginning of line. If there is more than one function presented in the Sx SYNOPSIS section and a function type has not been given, a line break will occur, leaving a nice vertical space between the current function name and the one prior.
The default width values of `.Fn and ' `.Fo are ' 12n and 16n, respectively.
Function Arguments
The `.Fa macro ' is used to refer to function arguments (parameters) outside of the Sx SYNOPSIS section of the manual or inside the Sx SYNOPSIS section if the enclosure macros `.Fo and ' `.Fc instead ' of `.Fn are ' used. `.Fa may ' also be used to refer to structure members.
Usage: .Fa Ao function argument Ac ...
- .Fa d_namlen ) ) ,
- Fa d_namlen ) ) ,
- .Fa iov_len
- Fa iov_len
Return Values
The `.Rv macro ' generates text for use in the Sx RETURN VALUES section.
Usage: .Rv [-std [Ao function Ac ... ] ]
For example, `.Rv -std ' atexit produces: # a small hack to suppress a warning message Rv -std atexit
The -std option is valid only for manual page sections~2 and~3. Currently, this macro does nothing if used without the -std flag.
Exit Status
The `.Ex macro ' generates text for use in the Sx DIAGNOSTICS section.
Usage: .Ex [-std [Ao utility Ac ... ] ]
For example, `.Ex -std ' cat produces: # a small hack to suppress a warning message Ex -std cat
The -std option is valid only for manual page sections 1, 6 and~8. Currently, this macro does nothing if used without the -std flag.
Interactive Commands
The `.macro ' designates an interactive or internal command.
Usage: .Ao argument Ac ...
- .:wq
- :wq
- .q]do while {...}q]
- do while {...}
- .setenv , unsetenv
- setenv , unsetenv
Library Names
The `.Lb macro ' is used to specify the library where a particular function is compiled in.
Usage: .Lb Ao argument Ac ...
Available arguments to `.Lb and ' their results are:
- libarm32
- Lb libarm32
- libc
- Lb libc
- libcompat
- Lb libcompat
- libcrypt
- Lb libcrypt
- libcurses
- Lb libcurses
- libedit
- Lb libedit
- libi386
- Lb libi386
- libipsec
- Lb libipsec
- libkvm
- Lb libkvm
- libm
- Lb libm
- libmenu
- Lb libmenu
- libossaudio
- Lb libossaudio
- libposix
- Lb libposix
- libresolv
- Lb libresolv
- libtermcap
- Lb libtermcap
- libutil
- Lb libutil
- libz
- Lb libz
Local, OS-specific additions might be found in the file mdoc.local look for strings named `str-Lb-XXX' `XXX' then denotes the keyword to be used with the `.Lb macro. '
Literals
The `.literal ' macro may be used for special characters, variable constants, etc. -- anything which should be displayed as it would be typed.
Usage: .Ao argument Ac ...
- .\en
- \n
- .M1 M2 M3 ;
- M1 M2 M3
- .cntrl-D ) ,
- cntrl-D )
- .1024 ...
- 1024 ...
Names
The `.groff Fl m Ns Cm doc Ar ' macro is used for the document title or subject name. It has the peculiarity of remembering the first argument it was called with, which should always be the subject name of the page. When called without arguments, `.groff Fl m Ns Cm doc Ar ' regurgitates this initial name for the sole purpose of making less work for the author. Note: A section two or three document function name is addressed with the `.groff Fl m Ns Cm doc Ar ' in the Sx NAME section, and with `.Fn in ' the Sx SYNOPSIS and remaining sections. For interactive commands, such as the `while' command keyword in csh(1), the `.macro ' should be used. While `.is ' nearly identical to `.groff Fl m Ns Cm doc Ar ' it can not recall the first argument it was invoked with.
Usage: .[Ao argument Ac ...]
- .groff_mdoc
- groff_mdoc
- .\-mdoc
- -mdoc
- .foo ) ) ,
- foo ) )
- .:
- :
Options
The `.[macro] ' places option brackets around any remaining arguments on the command line, and places any trailing punctuation outside the brackets. The macros `.[and ' `.] ' (which produce an opening and a closing option bracket respectively) may be used across one or more lines or to specify the exact position of the closing parenthesis.
Usage: .[[Ao option Ac ...] ]
- .[[
- .[-k ]
-
]
]
- [-k ]
- .[-k ) . ]
- [-k ]
- .[-k kookfile ]
- [-k kookfile ]
- .[-k kookfile , ]
- [-k kookfile ]
- .[objfil [corfil ] ]
- [objfil [corfil ] ]
- .[-c objfil [corfil , ] ]
- [-c objfil [corfil ] ]
- .[word1 word2]
- [word1 word2]
- ..[[Ao option Ac ...] ]
- .[[Ao options Ac ...] ]
Here a typical example of the `.[and ' `.] ' macros:
.Oo .Op Fl k Ar kilobytes .Op Fl i Ar interval .Op Fl c Ar count .Oc
Produces:
[[-k kilobytes ] [-i interval ] [-c count ] ]
The default width values of `.[and] ' `.[are ' 14n and 10n, respectively.
Pathnames
The `.macro ' formats path or file names. If called without arguments, the `string is output, which represents the current user's home directory. '
Usage: .[Ao pathname Ac ...]
- .
- ./usr/share
-
- /usr/share
- ./tmp/fooXXXXX ) .
- /tmp/fooXXXXX )
Standards
The `.St macro ' replaces standard abbreviations with their formal names.
Usage: .St Ao abbreviation Ac ...
Available pairs for ``Abbreviation/Formal Name'' are:
ANSI/ISO C
- -ansiC
- St -ansiC
- -ansiC-89
- St -ansiC-89
- -isoC
- St -isoC
- -isoC-99
- St -isoC-99
POSIX Part 1: System API
- -iso9945-1-90
- St -iso9945-1-90
- -iso9945-1-96
- St -iso9945-1-96
- -p1003.1
- St -p1003.1
- -p1003.1-88
- St -p1003.1-88
- -p1003.1-90
- St -p1003.1-90
- -p1003.1-96
- St -p1003.1-96
- -p1003.1b-93
- St -p1003.1b-93
- -p1003.1c-95
- St -p1003.1c-95
- -p1003.1g-2000
- St -p1003.1g-2000
- -p1003.1i-95
- St -p1003.1i-95
POSIX Part 2: Shell and Utilities
- -iso9945-2-93
- St -iso9945-2-93
- -p1003.2
- St -p1003.2
- -p1003.2-92
- St -p1003.2-92
- -p1003.2a-92
- St -p1003.2a-92
X/Open
- -susv2
- St -susv2
- -svid4
- St -svid4
- -xbd5
- St -xbd5
- -xcu5
- St -xcu5
- -xcurses4.2
- St -xcurses4.2
- -xns5
- St -xns5
- -xns5.2
- St -xns5.2
- -xpg3
- St -xpg3
- -xpg4
- St -xpg4
- -xpg4.2
- St -xpg4.2
- -xsh5
- St -xsh5
Miscellaneous
- -ieee754
- St -ieee754
- -iso8802-3
- St -iso8802-3
Variable Types
The `.Vt macro ' may be used whenever a type is referenced. In the Sx SYNOPSIS section, it causes a line break (useful for old style variable declarations).
Usage: .Vt Ao type Ac ...
- .Vt extern char *optarg ;
- Vt extern char *optarg ;
- .Vt FILE *
- Vt FILE *
Variables
Generic variable reference.
Usage: .Ao variable Ac ...
- .count
- count
- .settimer ,
- settimer
- .q]int *prtq] ) :
- int *prt )
- .q]char sq] ] ) ) ,
- char s ] ) )
Manual Page Cross References
The `.macro ' expects the first argument to be a manual page name. The optional second argument, if a string (defining the manual section), is put into parentheses.
Usage: .AomanpagenameAcOoAosectionAcOc...
GENERAL TEXT DOMAIN
AT&T Macro
Usage: .AT&T System [Ao version Ac ...]
- .AT&T System
- AT&T System
- .AT&T System v6 .
- AT&T System v6 .
The following values for Ao version Ac are possible:
32v, v1, v2, v3, v4, v5, v6, v7, V, V.1, V.2, V.3, V.4
BSD Macro
"Usage: .Bx" Bro -alpha | -beta | -devel Brc ...
" .Bx" [Ao version Ac [Ao release Ac ...] ]
- .BSD BSD
- .BSD 4.3 .
-
- BSD 4.3
- .BSD -devel
- BSD -devel
Ao version Ac will be prepended to the string `BSD ' The following values for Ao release Ac are possible:
Reno, reno, Tahoe, tahoe, Lite, lite, Lite2, lite2
NetBSD Macro
Usage: .Nx [Ao version Ac ...]
- .Nx Nx
- .Nx 1.4 .
-
- Nx 1.4 .
For possible values of Ao version Ac see the description of the `.command ' above in section Sx TITLE MACROS .
FreeBSD Macro
Usage: .Fx [Ao version Ac ...]
- .Fx Fx
- .Fx 2.2 .
-
- Fx 2.2 .
For possible values of Ao version Ac see the description of the `.command ' above in section Sx TITLE MACROS .
OpenBSD Macro
Usage: .Ox [Ao version Ac ...]
- .Ox 1.0
- Ox 1.0
BSD/OS Macro
Usage: .Bsx [Ao version Ac ...]
- .Bsx 1.0
- Bs x 1.0
UNIX Macro
Usage: .UNIX
- .UNIX
- UNIX
Emphasis Macro
Text may be stressed or emphasized with the `.macro. ' The usual font for emphasis is italic.
Usage: .Ao argument Ac ...
- .does not
- does not
- .exceed 1024 .
- exceed 1024
- .vide infra ) ) ,
- vide infra ) )
Font Mode
The `.Bf font ' mode must be ended with the `.Ef macro ' (the latter takes no arguments). Font modes may be nested within other font modes.`.Bf has ' the following syntax:
.Bf Ao font mode AcAo font mode Ac must be one of the following three types:
- | -emphasis
- Same as if the `.macro ' was used for the entire block of text.
- | -literal
- Same as if the `.macro ' was used for the entire block of text.
- | -symbolic
- Same as if the `.macro ' was used for the entire block of text.
Both macros are neither callable nor parsed.
Enclosure and Quoting Macros
The concept of enclosure is similar to quoting. The object being to enclose one or more strings between a pair of characters like quotes or parentheses. The terms quoting and enclosure are used interchangeably throughout this document. Most of the one-line enclosure macros end in small letter `q' to give a hint of quoting, but there are a few irregularities. For each enclosure macro there is also a pair of open and close macros which end in small letters `o' and `c' respectively.# XXX
Quote Ta Open Ta Close Ta Function Ta Result .Aq Ta .Ao Ta .Ac Ta Angle Bracket Enclosure Ta Ao string Ac .Bq Ta .Bo Ta .Bc Ta Bracket Enclosure Ta Bo string Bc .Brq Ta .Bro Ta .Brc Ta Brace Enclosure Ta Bro string Brc .``Ta .Do Ta .Dc Ta Double Quote Ta Do string Dc .Eq Ta .Eo Ta .Ec Ta Enclose String (in XX) Ta XXstringXX '' .(Ta .Po Ta .Pc Ta Parenthesis Enclosure Ta Po string Pc .`Ta Ta Ta Quoted ' ) Literal Ta So string Sc or Li string .Qq Ta .Qo Ta .Qc Ta Straight Double Quote Ta Qo string Qc .`Ta .So Ta .Sc Ta Single Quote Ta So string Sc
'
All macros ending with `q' and `o' have a default width value of 12n.
- .Eo , .Ec These macros expect the first argument to be the opening and closing strings
- respectively.
- .Es , .En Due to the nine-argument limit in the original troff program two other
- macros have been implemented which are now rather obsolete: `.Es takes ' the first and second parameter as the left and right enclosure string, which are then used to enclose the arguments of `.En ' The default width value is 12n for both macros.
- .Eq The first and second arguments of this macro are the opening and
- closing strings respectively, followed by the arguments to be enclosed.
- .`The'
-
quoted literal macro behaves differently in troff and nroff mode.
If formatted with
nroff,
a quoted literal is always quoted.
If formatted with troff, an item is only quoted if the width of the item is
less than three constant width characters.
This is to make short strings more visible where the font change to literal
(constant width) is less noticeable.
The default width is 16n.
- .The prefix macro suppresses the whitespace between its first and second
-
argument:
- .( Fa name2
- ( Fa name2
The default width is 12n.
The `.macro ' (see below) performs the analogous suffix function.
- .Ap The
- `.Ap macro ' inserts an apostrophe and exits any special text modes, continuing in `.mode. '
Examples of quoting:
- .Aq Aq
- .Aq ctype.h ) ,
-
- Aq Pa ctype.h ) ,
- .Bq Bq
- .Bq Greek , French .
-
- Bq Em Greek , French .
- .````
- .``string abc .''
-
''
''
- ``string abc''
- .``'^[A-Z]'''
- ``'^[A-Z]'''
- .`man'
- mdoc `man' mdoc
- .Qq Qq
- .Qq string ) ,
-
- Qq string ) ,
- .Qq string ),
- Qq string Ns ),
- .``
- .`string'
-
'
'
- `string'
- .or Ap ing
- or Ap ing
For a good example of nested enclosure macros, see the `.[option] ' macro. It was created from the same underlying enclosure macros as those presented in the list above. The `. ' and `. ' extended argument list macros are discussed below.
No-[or Normal Text Macro]
The `.macro ' can be used in a macro command line for parameters which should not be formatted. Be careful to add `\&' to the word `if ' you really want that English word (and not the macro) as a parameter.
Usage: .Ao argument Ac ...
- .test Ta with Ta tabs
- test Ta with Ta tabs
No-Space Macro
The `.macro ' suppresses insertion of a space between the current position and its first parameter. For example, it is useful for old style argument lists where there is no space between the flag and argument:
"Usage:" ... Ao argument Ac [Ao argument Ac ...]
" " .Ao argument Ac ...
- .[-I directory ]
- [-I directory ]
Note: The `.macro ' always invokes the `.macro ' after eliminating the space unless another macro name follows it. If used as a command (i.e., the second form above in the `Usage' line), `.is ' identical to `. '
Section Cross References
The `.Sx macro ' designates a reference to a section header within the same document.
Usage: .Sx Ao section reference Ac ...
- .Sx FILES
- Sx FILES
Symbolics
The symbolic emphasis macro is generally a boldface macro in either the symbolic sense or the traditional English usage.
Usage: .Ao symbol Ac ...
- .Important Notice
- Important Notice
Mathematical Symbols
Use this macro for mathematical symbols and similar things.
Usage: .Ao math symbol Ac ...
- .sigma
- sigma
References and Citations
The following macros make a modest attempt to handle references. At best, the macros make it convenient to manually drop in a subset of refer(1) style references.
- .
-
Reference start (does not take arguments).
Causes a line break in the
Sx SEE ALSO
section and begins collection of reference information until the reference
end macro is read.
Li .Re
Reference end (does not take arguments).
The reference is printed.
Li .%A
Reference author name; one name per invocation.
Li .%B
Book title.
Li .%C
City/place (not implemented yet).
Li .%D
Date.
Li .%I
Issuer/publisher name.
Li .%J
Journal name.
Li .%N
Issue number.
Li .%O
Optional information.
Li .%P
Page number.
Li .%Q
Corporate or foreign author.
Li .%R
Report name.
Li .%T
Title of article.
Li .%V
Volume.
Macros beginning with `%' are not callable but accept multiple arguments in the usual way. Only the `.macro ' is handled properly as a parameter; other macros will cause strange output. `.%B' and `.%T' can be used outside of the `.Rs/.
Example:
.Rs .%A "Matthew Bar" .%A "John Foo" .%T "Implementation Notes on foobar(1)" .%R "Technical Report ABC-DE-12-345" .%Q "Drofnats College, Nowhere" .%D "April 1991" .Re
produces
- "Matthew Bar" "John Foo" "Implementation Notes on foobar(1)" "Technical Report ABC-DE-12-345" "Drofnats College, Nowhere" "April 1991"
Trade Names (or Acronyms and Type Names)
The trade name macro prints its arguments in a smaller font. Its intended use is to imitate a small caps fonts for uppercase acronyms.
Usage: .Ao symbol Ac ...
- .DEC
- DEC
- .ASCII
- ASCII
Extended Arguments
The . and . macros allow one to extend an argument list on a macro boundary for the `. ' macro (see below). Note that . and . are implemented similarly to all other macros opening and closing an enclosure (without inserting characters, of course). This means that the following is true for those macros also.Here is an example of `. ' using the space mode macro to turn spacing off:
.Sm off .It Xo Sy I Ar operation .No \en Ar count No \en .Xc .Sm on
produces
- I operation \n count \n
.Sm off .It Cm S No / Ar old_pattern Xo .No / Ar new_pattern .No / Op Cm g .Xc .Sm on
produces
- S / old_pattern / new_pattern / [g ]
.It Xo .Ic .ifndef .Oo \&! Oc Ns Ar variable Oo .Ar operator variable ... .Oc Xc
produces
- .ifndef [! variable [operator variable ... ]
- ]
PAGE STRUCTURE DOMAIN
Section Headers
section
' header macros are required in every man page. The remaining section headers are recommended at the discretion of the author writing the manual page. The `.macro
' is parsed but not generally callable. It can be used as an argument in a call to `.only;
' it then reactivates the default font for `. 'The default width is 8n.
- .
NAME
NAME
' macro is mandatory. If not specified, headers, footers and page layout defaults will not be set and things will be rather unpleasant. The Sx NAME section consists of at least three items. The first is the `.groff Fl m Ns Cm doc Ar ' name macro naming the subject of the man page. The second is the name description macro, `. - , ' which separates the subject name from the third item, which is the description. The description should be the most terse and lucid possible, as the space available is small.`. - first ' prints `-' , then all its arguments. Li ".Sh LIBRARY" This section is for section two and three function calls. It should consist of a single `.Lb macro ' call; see Sx Library Names . Li ".Sh SYNOPSIS" The Sx SYNOPSIS section describes the typical usage of the subject of a man page. The macros required are either `.groff Fl m Ns Cm doc Ar ' `., ' or `.Fn (and ' possibly `.Fo , ' `.Fc , ' `.Fd , ' and `.Ft ) ' The function name macro `.Fn is ' required for manual page sections~2 and~3; the command and general name macro `.groff Fl m Ns Cm doc Ar ' is required for sections 1, 5, 6, 7, and~8. Section~4 manuals require a `.groff Fl m Ns Cm doc Ar ' `.Fd or ' a `.configuration ' device usage macro. Several other macros may be necessary to produce the synopsis line as shown below:
cat [-benstuv ] [- ] file ...
The following macros were used:
".cat
".[-benstuv ]
".[Fl]
.file ...Li ".Sh DESCRIPTION" In most cases the first text in the Sx DESCRIPTION section is a brief paragraph on the command, function or file, followed by a lexical list of options and respective explanations. To create such a list, the `.
- (list
- ' item) and `.
' (begin list), `.
' (end list) macros are used (see Sx Lists and Columns below). Li ".Sh IMPLEMENTATION NOTES" Implementation specific information should be placed here. Li ".Sh RETURN VALUES" Sections 2, 3 and~9 function return values should go here. The `.Rv macro ' may be used to generate text for use in the Sx RETURN VALUES section for most section 2 and 3 library functions; see Sx Return Values .
section
' headers are part of the preferred manual page layout and must be used appropriately to maintain consistency. They are listed in the order in which they would be used.- .
ENVIRONMENT
It is recommended that the cross references are sorted on the section number, then alphabetically on the names within a section, and placed in that order and comma separated. Example:
ls(1), ps(1), group(5), passwd(5) Li ".Sh STANDARDS" If the command, library function or file adheres to a specific implementation such as St -p1003.2 or St -ansiC this should be noted here. If the command does not adhere to any standard, its history should be noted in the Sx HISTORY section. Li ".Sh HISTORY" Any command which does not adhere to any specific standards should be outlined historically in this section. Li ".Sh AUTHORS" Credits should be placed here. The `.An macro ' should be used to specify the name(s) of the person(s). Li ".Sh BUGS" Blatant problems with the topic go here.
sections
' may be added; for example, this section was set with:.Sh "PAGE STRUCTURE DOMAIN"
Subsection Headers
Subsection headers have exactly the same syntax as section headers: `.is
' parsed but not generally callable. It can be used as an argument in a call to `.only;
' it then reactivates the default font for `. 'Paragraphs and Line Spacing
- .
-
The
`.
' paragraph command may be used to specify a line space where necessary. The macro is not necessary after a `.
or
' `.macro
' or before a `.' or `. ' macro (which both assert a vertical distance unless the -compact flag is given).
The macro is neither callable nor parsed and takes no arguments; an alternative name is `.Lp '
Keeps
The only keep that is implemented at this time is for words. The macros are `.(begin ' keep) and `.(end ' keep). The only option that `.accepts ' currently is -words (this is also the default if no option is given) which is useful for preventing line breaks in the middle of options. In the example for the make command line arguments (see Sx What's in a Name ) , the keep prevented nroff from placing up the flag and the argument on separate lines.Both macros are neither callable nor parsed.
More work needs to be done with the keep macros; specifically, a -line option should be added.
Examples and Displays
There are seven types of displays.
- .D1
-
(This is D-one.)
Display one line of indented text.
This macro is parsed but not callable.
The above was produced by: .D1 -ldghfstru
- . (This is D-ell.)
-
Display one line of indented
literal
text.
The
`.
example
' macro has been used throughout this file. It allows the indentation (display) of one line of text. Its default font is set to constant width (literal). `.is
' parsed but not callable.% ls -ldg /usr/local/bin
The above was produced by: . % ls -ldg /usr/local/bin
- .
-
Begin display.
The
`.
'
display
must be ended with the
`.
'
macro.
It has the following syntax:
- .
- Br o -literal | -filled | -unfilled | -ragged | -centered Brc [-offset Ao string Ac [-file Ao file name Ac [-compact ] ] ]
- -ragged
- Fill, but do not adjust the right margin (only left-justify).
- -centered
- Center lines between the current left and right margin. Note that each single line is centered.
- -unfilled
- Do not fill; display a block of text as typed, using line breaks as specified by the user. This can produce overlong lines without warning messages.
- -filled
- Display a filled block. The block of text is formatted (i.e., the text is justified on both the left and right side).
- -literal
- Display block with literal font (usually fixed-width). Useful for source code or simple tabbed or spaced text.
- -file Ao file name Ac The file whose name follows the
- -file flag is read and displayed before any data enclosed with `. ' and `. ' using the selected display type. Any troff/NsNm-mdoc commands in the file will be processed.
- -offset Ao string Ac If -offset
-
is specified with one of the following strings, the string is interpreted to
indicate the level of indentation for the forthcoming block of text:
- left
- Align block on the current left margin; this is the default mode of `. '
- center
- Supposedly center the block. At this time unfortunately, the block merely gets left aligned about an imaginary center margin.
- indent
-
Indent by one default indent value or tab.
The default indent value is also used for the
`.D1'
and
`.
macros,
' so one is guaranteed the two types of displays will line up. The indentation value is normally set to~6n or about two thirds of an inch (six constant width characters). - indent-two
- Indent two times the default indent value.
- right
- This left aligns the block about two inches from the right side of the page. This macro needs work and perhaps may never do the right thing within troff.
If Ao string Ac is a valid numeric expression instead ( with a scale indicator other than `u ' use that value for indentation. The most useful scale indicators are `m' and `n' specifying the so-called and En square This is approximately the width of the letters `m' and `n' respectively of the current font (for nroff output, both scale indicators give the same values). If Ao string Ac isn't a numeric expression, it is tested whether it is an -mdoc macro name, and the default offset value associated with this macro is used. Finally, if all tests fail, the width of Ao string Ac (typeset with a fixed-width font) is taken as the offset.
- -compact
- Suppress insertion of vertical space before begin of display.
- .
- End display (takes no arguments).
Lists and Columns
There are several types of lists which may be initiated with the `.- item
- ' macro, and each list must end with the `.
' begin-list macro. Items within the list are specified with the `.
' macro. Lists may be nested within themselves and within displays. The use of columns inside of lists or lists inside of columns is unproven.
In addition, several list attributes may be specified such as the width of a tag, the list offset, and compactness (blank lines between items allowed or disallowed). Most of this document has been formatted with a tag style list ( -tag
It has the following syntax forms:
- .
- Br o -hang | -ohang | -tag | -diag | -inset Brc [-width Ao string Ac ] [-offset Ao string Ac [-compact ] ]
- .
- -column [-offset Ao string Ac ] Ao string1 Ac Ao string2 Ac ... Xc
- .
- Br o -item | -enum Oo -nested Oc | -bullet | -hyphen | -dash Brc [-offset Ao string Ac [-compact ] ]
And now a detailed description of the list types.
- -bullet
-
A bullet list.
.Bl -bullet -offset indent -compact .It Bullet one goes here. .It Bullet two here. .El
Produces:
- Bullet one goes here.
- Bullet two here.
- -dash ( or -hyphen
-
A dash list.
.Bl -dash -offset indent -compact .It Dash one goes here. .It Dash two here. .El
Produces:
- Dash one goes here.
- Dash two here.
- -enum
-
An enumerated list.
.Bl -enum -offset indent -compact .It Item one goes here. .It And item two here. .El
The result:
- Item one goes here.
- And item two here.
If you want to nest enumerated lists, use the -nested flag (starting with the second-level list):
.Bl -enum -offset indent -compact .It Item one goes here .Bl -enum -nested -compact .It Item two goes here. .It And item three here. .El .It And item four here. .El
Result:
-
Item one goes here.
- Item two goes here.
- And item three here.
- And item four here.
- -item
-
A list of type
-item
without list markers.
.Bl -item -offset indent .It Item one goes here. Item one goes here. Item one goes here. .It Item two here. Item two here. Item two here. .El
Produces:
- Item one goes here.
- Item one goes here. Item one goes here.
- Item two here.
- Item two here. Item two here.
- -tag
-
A list with tags.
Use
-width
to specify the tag width.
- SL
- sleep time of the process (seconds blocked)
- PAGEIN
- number of disk I/O 's resulting from references by the process to pages not loaded in core.
- UID
- numerical user-id of process owner
- PPID
- numerical id of parent of process priority (non-positive when in non-interruptible wait)
The raw text:
.Bl -tag -width "PPID" -compact -offset indent .It SL sleep time of the process (seconds blocked) .It PAGEIN number of disk .Tn I/O Ns 's resulting from references by the process to pages not loaded in core. .It UID numerical user-id of process owner .It PPID numerical id of parent of process priority (non-positive when in non-interruptible wait) .El
- -diag
-
Diag lists create section four diagnostic lists and are similar to inset
lists except callable macros are ignored.
The
-width
flag is not meaningful in this context.
Example:
.Bl -diag .It You can't use Sy here. The message says all. .El
produces
- You can't use here.
- The message says all.
- -hang
-
A list with hanging tags.
- Hanged
- labels appear similar to tagged lists when the label is smaller than the label width.
- Longer hanged list labels
- blend into the paragraph unlike tagged paragraph labels.
And the unformatted text which created it:
.Bl -hang -offset indent .It Em Hanged labels appear similar to tagged lists when the label is smaller than the label width. .It Em Longer hanged list labels blend into the paragraph unlike tagged paragraph labels. .El
- -ohang
-
Lists with overhanging tags do not use indentation for the items; tags are
written to a separate line.
- SL
- sleep time of the process (seconds blocked)
- PAGEIN
- number of disk I/O 's resulting from references by the process to pages not loaded in core.
- UID
- numerical user-id of process owner
- PPID
- numerical id of parent of process priority (non-positive when in non-interruptible wait)
The raw text:
.Bl -ohang -offset indent .It Sy SL sleep time of the process (seconds blocked) .It Sy PAGEIN number of disk .Tn I/O Ns 's resulting from references by the process to pages not loaded in core. .It Sy UID numerical user-id of process owner .It Sy PPID numerical id of parent of process priority (non-positive when in non-interruptible wait) .El
- -inset
-
Here is an example of inset labels:
- Tag
- The tagged list (also called a tagged paragraph) is the most common type of list used in the Berkeley manuals. Use a -width attribute as described below.
- Diag
- Diag lists create section four diagnostic lists and are similar to inset lists except callable macros are ignored.
- Hang
- Hanged labels are a matter of taste.
- Ohang
- Overhanging labels are nice when space is constrained.
- Inset
- Inset labels are useful for controlling blocks of paragraphs and are valuable for converting -mdoc manuals to other formats.
Here is the source text which produced the above example:
.Bl -inset -offset indent .It Em Tag The tagged list (also called a tagged paragraph) is the most common type of list used in the Berkeley manuals. .It Em Diag Diag lists create section four diagnostic lists and are similar to inset lists except callable macros are ignored. .It Em Hang Hanged labels are a matter of taste. .It Em Ohang Overhanging labels are nice when space is constrained. .It Em Inset Inset labels are useful for controlling blocks of paragraphs and are valuable for converting .Nm -mdoc manuals to other formats. .El
- -column
-
This list type generates multiple columns.
The number of columns and the width of each column is determined by the
arguments to the
-column
list,
Aq Ar string1 ,
Aq Ar string2 ,
etc.
If
Aq Ar stringN
starts with a
`.'
(dot) immediately followed by a valid
-mdoc
macro name, interpret
Aq Ar stringN
and use the width of the result.
Otherwise, the width of
Aq Ar stringN
(typeset with a fixed-width font) is taken as the
N th
column width.
Each `.
- argument
-
'
is parsed to make a row, each column within the row is a separate
argument separated by a tab or the
`.Ta macro.
'
The table:
- String Ta Nroff Ta Troff
- <= Ta <= Ta
- >= Ta >= Ta
was produced by:
.Bl -column -offset indent ".Sy String" ".Sy Nroff" ".Sy Troff" .It Sy String Ta Sy Nroff Ta Sy Troff .It Li <= Ta <= Ta \*(<= .It Li >= Ta >= Ta \*(>= .El
Other keywords:
- -width Ao string Ac If Aq string
-
starts with a
`.'
(dot) immediately followed by a valid
-mdoc
macro name, interpret
Aq Ar string
and use the width of the result.
Almost all lists in this document use this option.
Example:
.Bl -tag -width ".Fl test Ao Ar string Ac" .It Fl test Ao Ar string Ac This is a longer sentence to show how the .Fl width flag works in combination with a tag list. .El
gives:
- -test Ao string Ac This is a longer sentence to show how the
- -width flag works in combination with a tag list.
(Note that the current state of -mdoc is saved before Aq Ar string is interpreted; afterwards, all variables are restored again. However, boxes (used for enclosures) can't be saved in GNU troff(1); as a consequence, arguments must always be balanced to avoid nasty errors. For example, do not write `.Ao string ' but `.Ao string ' Xc instead if you really need only an opening angle bracket.)
Otherwise, if Aq Ar string is a valid numeric expression ( with a scale indicator other than `u ' use that value for indentation. The most useful scale indicators are `m' and `n' specifying the so-called and En square This is approximately the width of the letters `m' and `n' respectively of the current font (for nroff output, both scale indicators give the same values). If Aq Ar string isn't a numeric expression, it is tested whether it is an -mdoc macro name, and the default width value associated with this macro is used. Finally, if all tests fail, the width of Aq Ar string (typeset with a fixed-width font) is taken as the width.
If a width is not specified for the tag list type, every time `.
- is
- ' invoked, an attempt is made to determine an appropriate width. If the first argument to `.
- is
- ' a callable macro, the default width for that macro will be used; otherwise, the default width of `.is ' used.
- -offset Ao string Ac If Aq string
-
is
indent
a default indent value (normally set to~6n, similar to the value used in
`.
or
' `. ' is used. If Aq Ar string is a valid numeric expression instead ( with a scale indicator other than `u ' use that value for indentation. The most useful scale indicators are `m' and `n' specifying the so-called and En square This is approximately the width of the letters `m' and `n' respectively of the current font (for nroff output, both scale indicators give the same values). If Aq Ar string isn't a numeric expression, it is tested whether it is an -mdoc macro name, and the default offset value associated with this macro is used. Finally, if all tests fail, the width of Aq Ar string (typeset with a fixed-width font) is taken as the offset. - -compact
- Suppress insertion of vertical space before the list and between list items.
MISCELLANEOUS MACROS
Here a list of the remaining macros which do not fit well into one of the above sections. We couldn't find real examples for the following macros: `.Me and ' `.Ot ' They are documented here for completeness - if you know how to use them properly please send a mail to Mt<EMAIL_ADDRESS>(including an example).- . is currently in beta test.
-
prints
is currently in beta test.
It is neither callable nor parsed and takes no arguments.
- .
-
Usage: .Ao function return value Ac ...
Don't use this macro. It allows a break right before the return value (usually a single digit) which is bad typographical behaviour. Use `\~' to tie the return value to the previous word.
- .Hf Use this macro to include a (header) file literally.
-
It first prints
`File:'
followed by the file name, then the contents of
Ao file Ac .
Usage: .Hf Ao file Ac
It is neither callable nor parsed. - .Lk To be written.
- .Me Exact usage unknown.
-
The documentation in the
-mdoc
source file describes it as a macro for
``menu entries''
Its default width is 6n.
- .Mt To be written.
- .Ot Exact usage unknown.
- The documentation in the -mdoc source file describes it as ``old function type (fortran)''
- .
-
Activate (toggle) space mode.
Usage: .
If space mode is off, no spaces between macro arguments are inserted. If called without a parameter (or if the next parameter is neither `on' nor `off' , `. ' toggles space mode.
- .Ud prints
-
Ud
It is neither callable nor parsed and takes no arguments.
PREDEFINED STRINGS
The following strings are predefined:
- String Ta Nroff Ta Troff Ta Meaning
- <= Ta <= Ta <=] Ta less equal
- >= Ta >= Ta >=] Ta greater equal
- Rq Ta '' Ta Rq] Ta right double quote
- Lq Ta `` Ta Lq] Ta left double quote
- ua Ta ^ Ta ua] Ta upwards arrow
- aa Ta ' Ta aa] Ta acute accent
- ga Ta ` Ta ga] Ta grave accent
- q Ta Ta q] Ta straight double quote
- Pi Ta pi Ta Pi] Ta greek pi
- Ne Ta != Ta Ne] Ta not equal
- Le Ta <= Ta Le] Ta less equal
- Ge Ta >= Ta Ge] Ta greater equal
- Lt Ta < Ta Lt] Ta less than
- Gt Ta > Ta Gt] Ta greater than
- Pm Ta +- Ta Pm] Ta plus minus
- If Ta infinity Ta If] Ta infinity
- Am Ta Am] Ta Am] Ta ampersand
- Na Ta Na] Ta Na] Ta not a number
- Ba Ta Ba] Ta Ba] Ta vertical bar
The names of the columns Nroff and Troff are a bit misleading; Nroff shows the ASCII representation, while Troff gives the best glyph form available. For example, a Unicode enabled TTY - device will have proper glyph representations for all strings, whereas the enhancement for a Latin1 TTY - device is only the plus-minus sign.
String names which consist of two characters can be written as `\*(xx' ; string names which consist of one character can be written as `\*x' A generic syntax for a string name of any length is `\*[xxx]' (this is a GNU troff(1) extension). # #===================================================================== #
DIAGNOSTICS
The debugging macro `.Db available ' in previous versions of -mdoc has been removed since GNU troff(1) provides better facilities to check parameters; additionally, many error and warning messages have been added to this macro package, making it both more robust and verbose.The only remaining debugging macro is `.Rd which ' yields a register dump of all global registers and strings. A normal user will never need it.
FORMATTING WITH GROFF, TROFF, AND NROFF
By default, the package inhibits page breaks, headers, and footers if displayed with a TTY device like `latin1' or `unicode' to make the manual more efficient for viewing on-line. This behaviour can be changed (e.g. to create a hardcopy of the TTY output) by setting the register `cR' to zero while calling groff:
groff -Tlatin1 -rcR=0 -mdoc foo.man > foo.txt
For double-sided printing, set register `D' to~1:
groff -Tps -rD1 -mdoc foo.man > foo.ps
To change the document font size to 11pt or 12pt, set register `S' accordingly:
groff -Tdvi -rS11 -mdoc foo.man > foo.dvi
Register `S' is ignored for TTY devices.
The line and title length can be changed by setting the registers `LL' and `LT' , respectively:
groff -Tutf8 -rLL=100n -rLT=100n -mdoc foo.man | less
If not set, both registers default to 78n for TTY devices and 6.5i otherwise.
FILES
- doc.tmac
- The main manual macro package.
- mdoc.tmac
- A wrapper file to call doc.tmac
- mdoc/doc-common
- Common strings, definitions, stuff related typographic output.
- mdoc/doc-nroff
- Definitions used for a TTY output device.
- mdoc/doc-ditroff
- Definitions used for all other devices.
- mdoc.local
- Local additions and customizations.
- andoc.tmac
- This file checks whether the -mdoc or the -man package should be used.
SEE ALSO
groff(1), man(1), troff(1), groff_man7BUGS
Section 3f has not been added to the header routines.`.groff Fl m Ns Cm doc Ar ' font should be changed in Sx NAME section.
`.Fn needs ' to have a check to prevent splitting up if the line length is too short. Occasionally it separates the last parenthesis, and sometimes looks ridiculous if a line is in fill mode.
The list and display macros do not do any keeps and certainly should be able to.
Index
- NAME
- SYNOPSIS
- DESCRIPTION
- GETTING STARTED
- TROFF IDIOSYNCRASIES
- A MANUAL PAGE TEMPLATE
- )
- CONVENTIONS
- TITLE MACROS
- INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS
- MANUAL DOMAIN
-
- Addresses
- Author Name
- Arguments
- Configuration Declaration (Section Four Only)
- Command Modifiers
- Defined Variables
- Errno's
- Environment Variables
- Flags
- Function Declarations
- Function Types
- Functions (Library Routines)
- Function Arguments
- Return Values
- Exit Status
- Interactive Commands
- Library Names
- Literals
- Names
- Options
- Pathnames
- Standards
- Variable Types
- Variables
- Manual Page Cross References
- GENERAL TEXT DOMAIN
-
- AT&T Macro
- BSD Macro
- NetBSD Macro
- FreeBSD Macro
- OpenBSD Macro
- BSD/OS Macro
- UNIX Macro
- Emphasis Macro
- Font Mode
- Enclosure and Quoting Macros
- No-Op or Normal Text Macro
- No-Space Macro
- Section Cross References
- Symbolics
- Mathematical Symbols
- References and Citations
- Trade Names (or Acronyms and Type Names)
- Extended Arguments
- PAGE STRUCTURE DOMAIN
- section
- macro
- only;
- NAME
- NAME
- section
- ENVIRONMENT
- sections
- or
- MISCELLANEOUS MACROS
- PREDEFINED STRINGS
- DIAGNOSTICS
- FORMATTING WITH GROFF, TROFF, AND NROFF
- FILES
- SEE ALSO
- BUGS
This document was created by man2html, using the manual pages.
Time: 05:34:15 GMT, December 24, 2015


Class: Mcir::Action
- Inherits:
-
Object
- Object
- Mcir::Action
- Defined in:
- lib/mcir/action.rb
Overview
The main part of the whole thing. Actions are the actual tasks.
Instance Attribute Summary (collapse)
-
- (Object) config
readonly
Returns the value of attribute config.
-
- (Object) desc
(also: #description)
readonly
Returns the value of attribute desc.
-
- (Object) mcir
readonly
Returns the value of attribute mcir.
Class Method Summary (collapse)
-
+ (Object) descendants
Tracks descendants for automatic action registration.
-
+ (Object) inherited(descendant)
Descendant tracking for inherited classes.
Instance Method Summary (collapse)
-
- (Object) call(*a) {|instance, args| ... }
Calls the execution block.
-
- (Object) execute(&block)
Sets an execution block.
-
- (Action) initialize(mcir, name, desc = nil, &block)
constructor
Initializes a new action object.
-
- (Object) name
Return the action's name as string.
-
- (String) prefix
Returns the prefix for the action.
-
- (Object) prepare(&block)
Sets an preparation block.
-
- (Object) setup {|action| ... }
Executes the given block which receives the action as argument.
-
- (Object) setup!
Calls the preparation block.
Constructor Details
Instance Attribute Details
- (Object) config (readonly)
Returns the value of attribute config
4 5 6 |
# File 'lib/mcir/action.rb', line 4 def config @config end |
- (Object) desc (readonly) Also known as: description
Returns the value of attribute desc
4 5 6 |
# File 'lib/mcir/action.rb', line 4 def desc @desc end |
- (Object) mcir (readonly)
Returns the value of attribute mcir
4 5 6 |
# File 'lib/mcir/action.rb', line 4 def mcir @mcir end |
Class Method Details
+ (Object) descendants
This method is considered private API, do not use it.
Tracks descendants for automatic action registration.
59 60 61 |
# File 'lib/mcir/action.rb', line 59 def self.descendants @descendants ||= [] end |
+ (Object) inherited(descendant)
This method is considered private API, do not use it.
Descendant tracking for inherited classes.
66 67 68 |
# File 'lib/mcir/action.rb', line 66 def self.inherited(descendant) descendants << descendant end |
Instance Method Details
- (Object) call(*a) {|instance, args| ... }
Calls the execution block.
83 84 85 |
# File 'lib/mcir/action.rb', line 83 def call *a @executor.try(:call, *a) end |
- (Object) execute(&block)
Sets an execution block.
48 49 50 |
# File 'lib/mcir/action.rb', line 48 def execute &block @executor = block end |
- (Object) name
Return the action's name as string
8 9 10 |
# File 'lib/mcir/action.rb', line 8 def name @name.to_s end |
- (String) prefix
Returns the prefix for the action.
89 90 91 92 93 94 |
# File 'lib/mcir/action.rb', line 89 def prefix "".tap do |o| o << " " if @mcir.logger.debug? o << "[#{name}] ".purple end end |
- (Object) prepare(&block)
Sets an preparation block.
41 42 43 |
# File 'lib/mcir/action.rb', line 41 def prepare &block @preparator = block end |
- (Object) setup {|action| ... }
Executes the given block which receives the action as argument.
34 35 36 |
# File 'lib/mcir/action.rb', line 34 def setup &block block.try(:call, self) end |
- (Object) setup!
Calls the preparation block.
75 76 77 |
# File 'lib/mcir/action.rb', line 75 def setup! @preparator.try(:call) end |


BLACKPINK's dance practice video for 'Kill This Love' hits 200M views on YouTube
by olmalBLACKPINK's dance practice video for 'Kill This Love' has hit 200M views on YouTube. The dance practice video was released on April 8. The group's M/V for the song has over 658M views.
Check out the video below. Congratulations to BLACKPINK and BLINKs!


Ravee Malla
About Me
Academics
Projects
Technical Skills
Misc
About This Page
Contact
Design Practises in Software: CSP301
Here you can find some resources for the course.


How to Boost Your Credit Score
What’s A Credit Score Good For Anyways?
A credit score is a number used by lenders to determine how “dependable” you are. Banks, credit card companies, and dealerships are all examples of lenders we work with on a daily basis. If you have a good credit score you get can offers to improved loans, interest rates, and an easier time getting approved. When shopping for a mortgages, purchasing a car, or applying for a credit card, your credit score is a key part of the picture. A strong credit score could be the difference between thousands to ten thousands of dollars in savings!
Credit Score Factors
There are different factors used to calculate credit score depending on the company, the most common model is FICO (Fair, Issac and Company) so it’s a logical place to start. Interestingly enough, FICO essentially has a monopoly on the credit score market. While other metrics do exist a small margin of credit reporting agencies use them.
The factors behind a FICO credit score are as follows:
- Payment history - (35%)
- Amounts owed (Credit utilization) - (30%)
- Length of credit history (15%)
- Amount of New Credit/Inquiries (10%)
- Credit mix (10%)
Notice that paying your bills on time has the largest impact to your credit score! There’s no true quick fix to credit scores except for responsibility and time. Forgetting to foot the bill is a double whammy of additional fees and credit damage. If you have enough in an account to use automatic payments, it can go a long way in ensuring timely payment.
Credit Utilization
The second largest influence to credit rating is the total amounts owed, also known as credit utilization. Utilization is calculated by the the total debt owed divided by the current credit limit. For example, lets say we have a total debt of $2,000 and a credit limit of $8,000. Division tells us our credit utilization is 25%. Source: comparecards
In general creditors like to see a credit utilization less then 35%, since anymore could indicate there’s heavy debt.
Gaming the System
Luckily for us there’s a trick we can use to tip this calculation process in our favor. We can either pay off more of our total debt, or increase our credit ceiling to lower utilization. When requesting credit increases the trick is to understand the proper timing:
-
Apply for new cards if you haven’t had any hard pulls within the past year. Having too many hard inquiries can be a red flag to creditors, because there is a proven correlation between hard pulls and credit risk.
-
Report annual increases to your salary. Income increases are a key indicator of a higher spending capacity and can go a long way to ensuring a successful request.
-
If you’ve had a credit card for a year or more, simply apply for a credit limit increase. Companies are generally willing to increase limits once you’ve developed a solid history with them.
By owning several credit cards we gain traction for a good credit mix (which coincidentally, is one of the factors we came across earlier). Having a mix of cards, loans, and mortgages tells lenders we’re responsible creditors. We want to avoid too many hard pulls because it can indicate shopping around for credit.  And in case you were wondering, soft inquiries (soft pulls) don’t affect your credit score at all! Finally, credit increases are good because it can serve as a buffer for credit utilization.
The Caveats to Keep In Mind
Keeping aggressive with credit applications early on especially helps because positive credit history directly translates to a higher score. We also know that applying to too many cards will bring your score down. The general rule of thumb is to limit hard pulls to two within a one year period.
Note that credit limits can be drawn back if they go unused for too long. Generally I try to use each credit card at least once a year.
Having a solid grasp on credit important, but it’s also important to budget existing money as well. I’ve noticed that in a way the two go hand in hand. Credit is all about leveraging future spending, while budgeting is what controls current spending.
Per usual, thanks for taking the time to read BrunchBucks. If you find a typo just contact me via email! Feel free to leave a comment below or share this with friends.
Subscribe via RSS


| Total Weight | 12% | ||
| Sub-Weightages | |||
| Labor Proximity | 6.150% | 50% | |
| (0.3 million inhabitants in KMs) | |||
| within 2 | 100% | 6.150% | |
| 2-5 | 75% | 4.61250% | |
| 5-8 | 50% | 3.0750% | |
| 8-10 | 25% | 1.53750% | |
| above 10 | 0% | 0.0000% | |
| Total | |||
| Labor Literacy level | 1.230% | 10% | |
| Literacy rate | |||
| Above average | 100% | 1.230% | |
| average | 75% | 0.92250% | |
| below average | 50% | 0.6150% | |
| low | 25% | 0.30750% | |
| very low | 0% | 0.0000% | |
| Total | |||
| Skilled Labor | 3.075% | 25% | |
| (Technical Institutes Turnover as % of Pop) | |||
| Above average | 100% | 3.0750% | |
| average | 75% | 2.306250% | |
| below average | 50% | 1.53750% | |
| low | 25% | 0.768750% | |
| very low | 0% | 0.000% | |
| Total | |||
| Labor Cost | 1.85% | 15% | |
| (Wages data/LFS) | |||
| Highly available at MWR | 100% | 1.8450% | |
| Available at MWR | 75% | 1.383750% | |
| Medium available @ MW | 50% | 0.92250% | |
| Low available at MWR | 25% | 0.461250% | |
| Very Low available @ M | 0% | 0.000% | |
| Total | |||
| Total | 100% |


Super Productivity V1 Data found
Do you want to migrate it? Please note that only projects and tasks are migrated, but not your project configuration.
Please also note that the migration process might not be working as you would expect. There is probably a lot you need to tweak afterwards and it might even happen that the process fails completely, so making a backup of your data is highly recommended.


Home
News
Art
Games!
Project 7
Videos
Games
Welcome to the games page! If you're bored, come here!
Raining Cats And Dogs- No, Just Dogs!
Walking with the polar bears!
If you have an idea for a game for us to make, or have a scratch game that you have made that you want to be featured, tell us here!


Included in:
Notification
Files
Tracking
Title
Type
Asset
Delete?
Delete?
Delete?
Delete?
Delete?
Delete?
Add File
From new Asset
From exisiting Asset
Folders
Title
Sub Folder No.
Folder
Delete?
New Folder


25mg 2CB, orally, about 3 hrs prior. Feeling high and good, tho' not especially 'tripping'. Put on Spacetime Continuum's 'Sea Biscuit', and loaded a medium-sized hit of dried Salvia.
First hit: I'm amazed at the way this stuff hits me: there's no transition. I just fill a bowl and try to put myself in a receptive state of mind, but at the same time wonder if it'll really work. Even as I smoke it,I'm trying to remember how I should think, as if I needed to try to be in the right frame of mind. Exhale, thinking 'how do I get there from here?....', then WHAMMO, I'm somewhere, someone, something else.
Infinitely long street, fenceposts and mailboxes stretch out forever. Green,sunny,suburban. Alien different physics and dimensionality. There is a strong force- a gravitational pull that is the center of my local universe. I realize that this point, strong as a black hole, is actually the connection to my jaw (of my 'real' body, sitting back home on the couch).  The thought crosses my mind that I could come out of this with a dislocated jaw, but it hurts so good!
Feeling of a lucid dream. I know my eyes are lightly closed, and feel like I could see my surroundings more clearly if I could open them, but I can't. At the same time, I can see/feel 360 degrees. The by now familiar salvia sensation of a passing parade or procession; I'm both in it and observing it.
2nd hit : A few minutes later. The track 'Subway' is starting, and I wanted to use this to travel, but it backfired. Lie down on the floor on my back, flat but with legs crossed at the ankles. Again, go from wondering how to get somewhere, to being in a completely different reality. Sink straight down, to a stained-glass, mosaic world. Instead of a subway, it seems more like a busstop, cause it's outside. I'm a businessman with a briefcase, impatiently checking my watch, then my briefcase changes to a big flat portfolio, and I'm a model (female)- need to see my agent, but the damn bus/train is never coming! Realize I kind of set myself up with the music- the song never really gets going. Feel stuck- if the music would just take off, I'd be travelling to who-knows-what exciting places.
Start feeling a painful gravity, and realize it's my knees: my legs are pressed tightly together. Eventually relax my legs a little, and slowly come out of it.
3rd hit : 5 min. later. Slump half on/half off the futon. Very strange dimension - I'm squeezed flat, feel like tape in a tape dispenser. I become an n-dimensional mobius creature, a ribbon that mates with itself. In 'real' life, I'm trying to stop from sliding completley off onto the floor, and this tension creates some of the forces of this world.
Writing this now, the next morning, I'm struck by how it's the connection to my body in real life, tenuous and garbled, that creates a big part of these other worlds. The physical hallucinations make these realities much more convincing. Wonder what it would be like to go deeper. Don't know if the connection to this physical plane is key to the whole thing, or just one stage or level. Could easily say 2CB is a big contributor to the physical effects, since it has a strong physical energy of its own. It does seem to be an excellent potentiator. However, the first time I broke through with salvia, I was otherwise straight, and there were strong physical gravity effects then too.
Experience Reports are the writings and opinions of the individual authors who submit them.
Some of the activities described are dangerous and/or illegal and none are recommended by Erowid.


Bender is an experimental, declarative Web application authoring framework based on XML, Javascript and Web technologies, and with a focus on rich graphical user interfaces.
Bender is free software and is released under the Apache License v2.0. The source code is hosted on Github.
Copyright © 2011, 2012, IGEL Co., Ltd.


Hello, and welcome to my personal page!
You might want some information about me or be curious about the technologies I used to make this page. Have fun! And feel free to tweet me if you found a bug or feel like I should add a feature.
An error occurred.


Next: complexp, Previous: cis, Up: Numbers Dictionary
complex
realpart &optional imagpart ⇒ complex
realpart—a real.
imagpart—a real.
complex—a rational or a complex.
complex returns a number whose real part is realpart and whose imaginary part is imagpart.
If realpart is a rational and imagpart is the rational number zero, the result of complex is realpart, a rational. Otherwise, the result is a complex.
If either realpart or imagpart is a float, the non-float is converted to a float before the complex is created. If imagpart is not supplied, the imaginary part is a zero of the same type as realpart; i.e., (coerce 0 (type-of realpart)) is effectively used.
Type upgrading implies a movement upwards in the type hierarchy lattice. In the case of complexes, the type-specifier
[Reviewer Note by Barmar: What type specifier?] must be a subtype of (upgraded-complex-part-type type-specifier). If type-specifier1 is a subtype of type-specifier2, then (upgraded-complex-element-type 'type-specifier1) must also be a subtype of (upgraded-complex-element-type 'type-specifier2). Two disjoint types can be upgraded into the same thing.
(complex 0) ⇒ 0 (complex 0.0) ⇒ #C(0.0 0.0) (complex 1 1/2) ⇒ #C(1 1/2) (complex 1 .99) ⇒ #C(1.0 0.99) (complex 3/2 0.0) ⇒ #C(1.5 0.0)
‘realpart; imagpart’ , imagpart
#c(a b) ≡ #.(complex a b)


Disgraced MP Keith Vaz to stand down before General Election
Keith Vaz, of the Labour Party, has quit ahead of the General Election 2019 after he was found to have "expressed willingness" to purchase cocaine for others
by Bradley Jolly, https://www.mirror.co.uk/authors/bradley-jolly/Shamed MP Keith Vaz is to stand down before the General Election .
The Labour MP, who was facing suspension from the Commons for six months after he was found to have "expressed willingness" to purchase cocaine for others, will not stand at the upcoming General Election.
Sunday Mirror exposed the Leicester East MP in September 2016. It found Vaz called himself Jim and posed as an industrial washing machine salesman.
In response to the 62-year-old's announcement, Labour leader Jeremy Corbyn said: "Keith Vaz was among the pioneering group of black and Asian Labour MPs elected in 1987. I was proud to support his selection and incredibly proud when he won, taking the seat from the Tories.
"Keith has made a substantial and significant contribution to public life, both as a constituency MP for the people of Leicester and for the Asian community across the country. He has helped to pave the way for more BAME people to become involved in politics.
"His work in Parliament has been exemplary, as Britain's first Asian origin Minister, Chair of the Home Affairs Select Committee, a campaigner on diabetes issues, and most recently trying to help the peace process in Yemen.
"Our work to combat racism and bring our diverse communities together is far from over."
Vaz apologised and quit as chair of the Home Affairs Select Committee after the secret came to light.
Prior to this, a video showing Vaz speaking using loudspeakers from a campaign car upset the Tories in Leicester.
Using a loudspeaker on the street is an offence that carries a penalty of up to £5,000.
Leicester City Council investigated Vaz and confirmed it was illegal but that no action would be taken.
We'll be bringing you the very latest updates, pictures and video on this breaking news story.


Five virtues
| Wisdom (gyan) | is the complete knowledge of a set of religious principles. It can be achieved by hearing good, thinking good and doing good. A man of wisdom tries to achieve a high moral standard in his life and interaction with others. According to Sikhism, the first steps to wisdom is to consider oneself as an ignorant person who has to learn a lot in life |
| Truthful Living (sat) | This is more than 'truth'. It means living according to the way of God i.e. the thoughts should match the words that a person speaks and his actions should also match his words. Truthful living brings a person closer to God |
| Temperance (santokh) | means self control which has to be developed through meditation and prayers. A Sikh has to banish evil thoughts from his mind by constantly repeating Gods name and reciting prayers. Torture to the body to develop self-control is not advocated in Sikhism. |
| Patience (dhiraj) | implies a high level of tolerance and empathy for others. It requires control over ones ego and willingness to overlook another's weakness or mistakes. It requires that a Sikh should be strong willed, but kind hearted. |
| Courage (himmat) | means bravery i.e. absence of fear. It is the ability to stake ones life for ones convictions and for saving others from injustice or cruelty |


Test Server
This is a sample Python application deployed to Heroku. It's a reasonably
simple app - but a good foundation for understanding how to get the most
out of the Heroku platform.
Getting Started with
Python
Source on GitHub
To deploy your own copy, and learn the fundamentals of the Heroku platform,
head over to the
Getting Started with Python on Heroku
tutorial.
How this sample app
works
-
This app was deployed to Heroku, either using Git or by using
Heroku Button
on the repository.
-
When Heroku received the source code, it fetched all the dependencies
in the
Pipfile, creating a deployable slug.
-
The platform then spins up a dyno, a lightweight container that
provides an isolated environment in which the slug can be mounted and
executed.
-
You can scale your app, manage it, and deploy over
150 add-on services, from the
Dashboard or CLI.
Next Steps
-
If you are following the
Getting Started
guide, then please head back to the tutorial and follow the next
steps!
-
If you deployed this app by deploying the Heroku Button, then in a
command line shell, run:
-
git clone
https://github.com/heroku/python-getting-started.git
- this will create a local copy of the source code for the app
-
cd python-getting-started
- change directory into the
local source code repository
-
heroku git:remote -a <your-app-name>
- associate the
Heroku app with the repository
-
You'll now be set up to run the app locally, or
deploy changes
to Heroku
Helpful Links
Please do work through the Getting Started guide, even if you do know how to
build such an application. The guide covers the basics of working with
Heroku, and will familiarize you with all the concepts you need in order to
build and deploy your own apps.
{% endblock %}


Experienced Full Stack Developer with Engineering Background
Find Out MoreOver years of hands-on software development experience. I've worked for Fortune 500 companies, startups and non-profits across a range of industries such as manufacturing, logistics, financial services, healthcare and SAS.
Let's Get StartedCopyright © Incerto Technology Services, LLC.


This is a simple demo used for testing the integration with PaymentIQ.
To test a payment you can register an account and log in or use the existing test account (email<EMAIL_ADDRESS>password: password)


{%extends "accounts/base.html"%} {% load bootstrap4 %} {% load static %} {% block content %}
Some Information Might be Incorrect
Have an account ? Log in


Adds a function that occurs when a an element is clicked. Click for an alert
Hides an element
show a hidden function
toggles between show and hide
provides a slide down animation when showing
I was hiding
hides and element by sliding up
switches between slide up and slide down
I am the toggled element
shows and element with a fade in animation
Hides an element with an animation
I will fade out
Adds a class to an element
My text will turn green
Adds something before the element
An h1 tag will be added before me
Adds something after the element
An h1 tag will be added after me
appends something after the last element/text within an element
I am the p tag
replaces the html within a element
I am a p tag within the div
Retreives or set an attribute of an element
I am a p tag with the class of green. Class=
Retreives or set a value of an input
replace the text of an element
My text will be replaced
stores a data value in that element(hidden in javascript)
I have a name hidden in me. What is it?


|
Panda3D
|
A simple place to store and manipulate tcp and port address for communication layer. More...
Public Member Functions | |
| __init__ (const SocketAddress inaddr) | |
| __init__ (unsigned short int port) | |
| Constructor that lets us set a port value. More... | |
| clear () | |
| Set the internal values to a suitable known value. More... | |
| sa_family_t | getFamily () |
| Returns AF_INET if this is an IPv4 address, or AF_INET6 if this is an IPv6 address. More... | |
| str | getIp () |
| Return the IP address portion in dot notation string. More... | |
| unsigned long int | GetIPAddressRaw () |
| Returns a raw 32-bit unsigned integer representing the IPv4 address. More... | |
| str | getIpPort () |
| Return the ip address/port in dot notation string. More... | |
| unsigned short int | getPort () |
| Get the port portion as an integer. More... | |
| bool | isAny () |
| True if the address is zero. More... | |
| bool | isMcastRange () |
| True if the address is in the multicast range. More... | |
| bool | operator!= (const SocketAddress in) |
| bool | operator< (const SocketAddress in) |
| bool | operator== (const SocketAddress in) |
| bool | setAnyIP (unsigned short int port) |
| Set to any address and a specified port. More... | |
| bool | setAnyIPv6 (unsigned short int port) |
| Set to any IPv6 address and a specified port. More... | |
| bool | setBroadcast (unsigned short int port) |
| Set to the broadcast address and a specified port. More... | |
| bool | setHost (str hostname) |
| Initializes the address from a string specifying both the address and port, separated by a colon. More... | |
| bool | setHost (str hostname, unsigned short int port) |
| This function will take a port and string-based TCP address and initialize the address with this information. More... | |
| bool | setHost (uint32_t ip4addr, unsigned short int port) |
| bool | setPort (unsigned short int port) |
| Set to a specified port. More... | |
A simple place to store and manipulate tcp and port address for communication layer.
| __init__ | ( | const SocketAddress | inaddr | ) |
| __init__ | ( | unsigned short int | port | ) |
Constructor that lets us set a port value.
| clear | ( | ) |
Set the internal values to a suitable known value.
| sa_family_t getFamily | ( | ) |
Returns AF_INET if this is an IPv4 address, or AF_INET6 if this is an IPv6 address.
| str getIp | ( | ) |
Return the IP address portion in dot notation string.
| unsigned long int GetIPAddressRaw | ( | ) |
Returns a raw 32-bit unsigned integer representing the IPv4 address.
| str getIpPort | ( | ) |
Return the ip address/port in dot notation string.
If this is an IPv6 address, it will be enclosed in square brackets.
| unsigned short int getPort | ( | ) |
Get the port portion as an integer.
| bool isAny | ( | ) |
True if the address is zero.
| bool isMcastRange | ( | ) |
True if the address is in the multicast range.
| bool operator!= | ( | const SocketAddress | in | ) |
| bool operator< | ( | const SocketAddress | in | ) |
| bool operator== | ( | const SocketAddress | in | ) |
| bool setAnyIP | ( | unsigned short int | port | ) |
Set to any address and a specified port.
| bool setAnyIPv6 | ( | unsigned short int | port | ) |
Set to any IPv6 address and a specified port.
| bool setBroadcast | ( | unsigned short int | port | ) |
Set to the broadcast address and a specified port.
| bool setHost | ( | str | hostname | ) |
Initializes the address from a string specifying both the address and port, separated by a colon.
An IPv6 address must be enclosed in brackets.
| bool setHost | ( | str | hostname, |
| unsigned short int | port | ||
| ) |
This function will take a port and string-based TCP address and initialize the address with this information.
Returns true on success; on failure, it returns false and the address may be undefined.
| bool setHost | ( | uint32_t | ip4addr, |
| unsigned short int | port | ||
| ) |
| bool setPort | ( | unsigned short int | port | ) |
Set to a specified port.


This is a simple hero unit, a simple jumbotron-style component for calling extra attention to featured content or information
Learn MoreChase mice mark territory or intently stare at the same spot. Give attitude hunt anything that moves so inspect anything brought into the house climb leg. Give attitude nap all day. Missing until dinner time run in circles yet rub face on everything yet climb leg make muffins or inspect anything brought into the house. Nap all day flop over burrow under covers. All of a sudden go crazy. Find something else more interesting give attitude.
Chew foot stand in front of the computer screen missing until dinner time so missing until dinner time. Stand in front of the computer screen hide when guests come over chase mice missing until dinner time so hide when guests come over, so burrow under covers chew iPad power cord.  Claw drapes leave hair everywhere swat at dog climb leg why must they do that.
Chase mice mark territory or intently stare at the same spot. Give attitude hunt anything that moves so inspect anything brought into the house climb leg. Give attitude nap all day. Missing until dinner time run in circles yet rub face on everything yet climb leg make muffins or inspect anything brought into the house. Nap all day flop over burrow under covers. All of a sudden go crazy. Find something else more interesting give attitude.
Burrow under covers. Swat at dog sweet beast give attitude find something else more interesting leave hair everywhere. Destroy couch run in circles. Claw drapes leave hair everywhere swat at dog climb leg why must they do that.
Burrow under covers. Swat at dog sweet beast give attitude find something else more interesting leave hair everywhere. Destroy couch run in circles. Claw drapes leave hair everywhere swat at dog climb leg why must they do that.
Burrow under covers. Swat at dog sweet beast give attitude find something else more interesting leave hair everywhere. Destroy couch run in circles. Claw drapes leave hair everywhere swat at dog climb leg why must they do that.
Burrow under covers. Swat at dog sweet beast give attitude find something else more interesting leave hair everywhere. Destroy couch run in circles. Claw drapes leave hair everywhere swat at dog climb leg why must they do that.


This theme will look great on any device, no matter the size!
Featuring the latest build of the new Bootstrap 4 framework!
Ready to use with your own content, or customize the source files!
Ready to use with your own content, or customize the source files!
This theme will look great on any device, no matter the size!
Featuring the latest build of the new Bootstrap 4 framework!
Ready to use with your own content, or customize the source files!
Ready to use with your own content, or customize the source files!


{% extends "reports/base_report.html" %} {% block title %} OpenStack foundation members {% endblock %} {% block scripts %} {% endblock %} {% block content %}
OpenStack foundation member companies
|
Members by company |
Individual Members
|
New Companies
|


Small Business
Elegent webpages designed with simplicity and beauty.
Emphasis the best of your work for potential customers to see!
Client: Sofia Arnell Photography
Image heavy design with Deep Links and simplicity.
Google Optimized Sites
Get your ideal website built responsive and beautifully all within Google Sites.
Code-free management of your website after its delivered!
Client: BLC Advisors