1 .\"
   2 .\" Permission to use, copy, modify, and distribute this software for any
   3 .\" purpose with or without fee is hereby granted, provided that the above
   4 .\" copyright notice and this permission notice appear in all copies.
   5 .\"
   6 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   7 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
   8 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
   9 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  10 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  11 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  12 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  13 .\"
  14 .\"
  15 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  16 .\" Copyright 2012 Nexenta Systems, Inc. All rights reserved.
  17 .\"
  18 .Dd Sep 25, 2011
  19 .Dt EQN 5
  20 .Os
  21 .Sh NAME
  22 .Nm eqn
  23 .Nd eqn language reference for mandoc
  24 .Sh DESCRIPTION
  25 The
  26 .Nm eqn
  27 language is an equation-formatting language.
  28 It is used within
  29 .Xr mdoc 5
  30 and
  31 .Xr man 5
  32 .Ux
  33 manual pages.
  34 It describes the
  35 .Em structure
  36 of an equation, not its mathematical meaning.
  37 This manual describes the
  38 .Nm

 150 a legal construction.
 151 .Bd -literal -offset indent
 152 define foo 'define'
 153 foo bar 'baz'
 154 .Ed
 155 .Pp
 156 Self-referencing definitions will raise an error.
 157 The
 158 .Cm ndefine
 159 statement is a synonym for
 160 .Cm define ,
 161 while
 162 .Cm tdefine
 163 is discarded.
 164 .It Cm gfont
 165 Set the default font of subsequent output.
 166 Its syntax is as follows:
 167 .Pp
 168 .D1 gfont Ar font
 169 .Pp
 170 In mandoc, this value is discarded.


 171 .It Cm gsize
 172 Set the default size of subsequent output.
 173 Its syntax is as follows:
 174 .Pp
 175 .D1 gsize Ar size
 176 .Pp
 177 The
 178 .Ar size
 179 value should be an integer.
 180 .It Cm set
 181 Set an equation mode.
 182 In mandoc, both arguments are thrown away.


 183 Its syntax is as follows:
 184 .Pp
 185 .D1 set Ar key val
 186 .Pp
 187 The
 188 .Ar key
 189 and
 190 .Ar val
 191 are not expanded for replacements.
 192 This statement is a GNU extension.
 193 .It Cm undef
 194 Unset a previously-defined key.
 195 Its syntax is as follows:
 196 .Pp
 197 .D1 define Ar key
 198 .Pp
 199 Once invoked, the definition for
 200 .Ar key
 201 is discarded.
 202 The
 203 .Ar key
 204 is not expanded for replacements.
 205 This statement is a GNU extension.
 206 .El
 207 .Sh COMPATIBILITY
 208 This section documents the compatibility of mandoc

 209 .Nm
 210 and the troff

 211 .Nm
 212 implementation (including GNU troff).
 213 .Pp
 214 .Bl -dash -compact
 215 .It
 216 The text string
 217 .Sq \e\*q
 218 is interpreted as a literal quote in troff.
 219 In mandoc, this is interpreted as a comment.



 220 .It
 221 In troff, The circumflex and tilde white-space symbols map to


 222 fixed-width spaces.
 223 In mandoc, these characters are synonyms for the space character.


 224 .It
 225 The troff implementation of


 226 .Nm
 227 allows for equation alignment with the
 228 .Cm mark
 229 and
 230 .Cm lineup
 231 tokens.
 232 mandoc discards these tokens.

 233 The
 234 .Cm back Ar n ,
 235 .Cm fwd Ar n ,
 236 .Cm up Ar n ,
 237 and
 238 .Cm down Ar n
 239 commands are also ignored.
 240 .El
 241 .Sh SEE ALSO
 242 .Xr mandoc 1 ,
 243 .Xr man 7 ,
 244 .Xr mandoc_char 5 ,
 245 .Xr mdoc 5 ,
 246 .Xr roff 5
 247 .Rs
 248 .%A Brian W. Kernighan
 249 .%A Lorinda L. Cherry
 250 .%T System for Typesetting Mathematics
 251 .%J Communications of the ACM
 252 .%V 18
 253 .%P 151\(en157
 254 .%D March, 1975
 255 .Re
 256 .Rs
 257 .%A Brian W. Kernighan
 258 .%A Lorinda L. Cherry
 259 .%T Typesetting Mathematics, User's Guide
 260 .%D 1976
 261 .Re
 262 .Rs
 263 .%A Brian W. Kernighan

   1 .\"
   2 .\" Permission to use, copy, modify, and distribute this software for any
   3 .\" purpose with or without fee is hereby granted, provided that the above
   4 .\" copyright notice and this permission notice appear in all copies.
   5 .\"
   6 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   7 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
   8 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
   9 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  10 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  11 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  12 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  13 .\"
  14 .\"
  15 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  16 .\" Copyright 2012 Nexenta Systems, Inc. All rights reserved.
  17 .\"
  18 .Dd Jul 19, 2014
  19 .Dt EQN 5
  20 .Os
  21 .Sh NAME
  22 .Nm eqn
  23 .Nd eqn language reference for mandoc
  24 .Sh DESCRIPTION
  25 The
  26 .Nm eqn
  27 language is an equation-formatting language.
  28 It is used within
  29 .Xr mdoc 5
  30 and
  31 .Xr man 5
  32 .Ux
  33 manual pages.
  34 It describes the
  35 .Em structure
  36 of an equation, not its mathematical meaning.
  37 This manual describes the
  38 .Nm

 150 a legal construction.
 151 .Bd -literal -offset indent
 152 define foo 'define'
 153 foo bar 'baz'
 154 .Ed
 155 .Pp
 156 Self-referencing definitions will raise an error.
 157 The
 158 .Cm ndefine
 159 statement is a synonym for
 160 .Cm define ,
 161 while
 162 .Cm tdefine
 163 is discarded.
 164 .It Cm gfont
 165 Set the default font of subsequent output.
 166 Its syntax is as follows:
 167 .Pp
 168 .D1 gfont Ar font
 169 .Pp
 170 In
 171 .Xr mandoc 1 ,
 172 this value is discarded.
 173 .It Cm gsize
 174 Set the default size of subsequent output.
 175 Its syntax is as follows:
 176 .Pp
 177 .D1 gsize Ar size
 178 .Pp
 179 The
 180 .Ar size
 181 value should be an integer.
 182 .It Cm set
 183 Set an equation mode.
 184 In
 185 .Xr mandoc 1 ,
 186 both arguments are thrown away.
 187 Its syntax is as follows:
 188 .Pp
 189 .D1 set Ar key val
 190 .Pp
 191 The
 192 .Ar key
 193 and
 194 .Ar val
 195 are not expanded for replacements.
 196 This statement is a GNU extension.
 197 .It Cm undef
 198 Unset a previously-defined key.
 199 Its syntax is as follows:
 200 .Pp
 201 .D1 define Ar key
 202 .Pp
 203 Once invoked, the definition for
 204 .Ar key
 205 is discarded.
 206 The
 207 .Ar key
 208 is not expanded for replacements.
 209 This statement is a GNU extension.
 210 .El
 211 .Sh COMPATIBILITY
 212 This section documents the compatibility of
 213 .Xr mandoc 1
 214 .Nm
 215 and the
 216 .Xr troff 1
 217 .Nm
 218 implementation (including GNU troff).
 219 .Pp
 220 .Bl -dash -compact
 221 .It
 222 The text string
 223 .Sq \e\*q
 224 is interpreted as a literal quote in
 225 .Xr troff 1 .
 226 In
 227 .Xr mandoc 1 ,
 228 this is interpreted as a comment.
 229 .It
 230 In
 231 .Xr troff 1 ,
 232 The circumflex and tilde white-space symbols map to
 233 fixed-width spaces.
 234 In
 235 .Xr mandoc 1 ,
 236 these characters are synonyms for the space character.
 237 .It
 238 The
 239 .Xr troff 1 ,
 240 implementation of
 241 .Nm
 242 allows for equation alignment with the
 243 .Cm mark
 244 and
 245 .Cm lineup
 246 tokens.
 247 .Xr mandoc 1
 248 discards these tokens.
 249 The
 250 .Cm back Ar n ,
 251 .Cm fwd Ar n ,
 252 .Cm up Ar n ,
 253 and
 254 .Cm down Ar n
 255 commands are also ignored.
 256 .El
 257 .Sh SEE ALSO
 258 .Xr mandoc 1 ,
 259 .Xr man 5 ,
 260 .Xr mandoc_char 5 ,
 261 .Xr mdoc 5 ,
 262 .Xr roff 5
 263 .Rs
 264 .%A Brian W. Kernighan
 265 .%A Lorinda L. Cherry
 266 .%T System for Typesetting Mathematics
 267 .%J Communications of the ACM
 268 .%V 18
 269 .%P 151\(en157
 270 .%D March, 1975
 271 .Re
 272 .Rs
 273 .%A Brian W. Kernighan
 274 .%A Lorinda L. Cherry
 275 .%T Typesetting Mathematics, User's Guide
 276 .%D 1976
 277 .Re
 278 .Rs
 279 .%A Brian W. Kernighan