Skip to content

Latest commit

 

History

History
137 lines (66 loc) · 3.83 KB

texinfo.md

File metadata and controls

137 lines (66 loc) · 3.83 KB
Raw

Notes About Texinfo

Language Translation with makeinfo

For the GNU Octave Application

The command line option "--texi-macros-file filename" "[specifies] the name of the file containing Texinfo macros for use by makeinfo" \cite[pp. 17, \S2.1.1]{Eaton2016a}.

By default, GNU Octave uses makeinfo for language translation to generate documentation (in other formats, such as HTML and PDF) via Texinfo \cite[pp. 23, \S2.3]{Eaton2016a}.

Getting Help Information

For the GNU Octave Application

Help information for a command in GNU Octave can be obtained in different formats, such as: texinfo, HTML, or "plain text" \cite[pp. 24-25, \S2.3]{Eaton2016a}.

Information Provided By Errors And Warnings

For the GNU Octave Application

Information, including "help information," provided for errors raised by a command in GNU Octave can be provided in different levels of verbosity \cite[pp. 206-207, \S12.1.1]{Eaton2016a}.

Examples

## -- texinfo --

## @deftypefn {Function File} f (@var{arg1})

## Function help text goes here...

## @end deftypefn

Commenting Classes in GNU Octave

Classes are supported in GNU Octave, so that developers can use the object-oriented programming paradigm to develop software using GNU Octave. A guideline on how to comment classes in GNU Octave, using Texinfo is shown on pp. 721, in \S34.1 \cite[pp. 721, \S34.1]{Eaton2016a}, \cite[pp. 733, \S34.4.3]{Eaton2016a}, \cite[pp. 734, \S34.5]{Eaton2016a}, and \cite[pp. 737, \S34.5]{Eaton2016a}.

Commenting Oct-Files

Examples of how to comment Oct-Files is found in \cite[pp. 841, \SA.1.13]{Eaton2016a}.

Suggestions

Suggestions for Documentation Strings

Suggestions for Texinfo documentation strings are found in \cite[pp. 873-875, \SC.4]{Eaton2016a}.

Suggestions for Programming Languages Other Than C++ and Octave Language

Suggestions for programming languages other than C++ and Octave language are found in \cite[pp. 884, \SD.7]{Eaton2016a}.

  • C
  • Fortran
  • M4
  • Perl
  • Unix shell
  • AWK
  • Texinfo
  • TeX

References

Citations/References that use the LaTeX/BibTeX notation are taken from my BibTeX database (set of BibTeX entries).

These references are:

  • \cite{Stallman2016b}
  • \cite{Stallman2016a}
  • \cite{Stallman2016}
  • \cite{WikipediaContributors2016h}

Author Information

The MIT License (MIT)

Copyright (c) <2016> Zhiyang Ong

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Email address: echo "cukj -wb- 23wU4X5M589 TROJANS cqkH wiuz2y 0f Mw Stanford" | awk '{ sub("23wU4X5M589","F.d_c_b. ") sub("Stanford","d0mA1n"); print $5, $2, $8; for (i=1; i<=1; i++) print "6\b"; print $9, $7, $6 }' | sed y/kqcbuHwM62z/gnotrzadqmC/ | tr 'q' ' ' | tr -d [:cntrl:] | tr -d 'ir' | tr y "\n" Don't compromise my computing accounts. You have been warned.