Copyright (c) Hyperion Entertainment and contributors.

Difference between revisions of "SDK Developer Tools"

From AmigaOS Documentation Wiki
Jump to navigation Jump to search
Line 3: Line 3:
 
== AutoDoc ==
 
== AutoDoc ==
   
AutoDoc extracts and sorts autodocs from the given files to the standard output stream.
+
AutoDoc extracts and sorts autodocs from the given files and prints them in the standard output.
   
 
=== Tool Types ===
 
=== Tool Types ===
Line 24: Line 24:
 
| {<infile>} || List of files to be processed.
 
| {<infile>} || List of files to be processed.
 
|-
 
|-
| -t<number> || This option converts tabulators to given number of spaces.
+
| -t<number> || Turn tabulators to given number of spaces.
 
|-
 
|-
 
| -i || Process only INTERNAL autodocs.
 
| -i || Process only INTERNAL autodocs.
Line 36: Line 36:
 
| -C || Process autodocs starting with "/*". This is the default setting.
 
| -C || Process autodocs starting with "/*". This is the default setting.
 
|-
 
|-
| -l<number> || Set line length for output. Default is 78.
+
| -l<number> || Set the line length for the output. The default is 78.
 
|-
 
|-
 
| -w || Turn off word wrapping.
 
| -w || Turn off word wrapping.
Line 42: Line 42:
 
| -c || Do not convert "\*" to "/*" or "*\" to "*/".
 
| -c || Do not convert "\*" to "/*" or "*\" to "*/".
 
|-
 
|-
| -f || No form feeds between entries.
+
| -f || Do not add form feeds between the autodoc entries.
 
|-
 
|-
| -r || Troff source output.
+
| -r || Generate Troff source output.
 
|-
 
|-
| -F<file> || Use <file> as a temporary file. Default temporary file is "tmpfile".
+
| -F<file> || Use <file> as a temporary file. The default temporary file is "tmpfile".
 
|-
 
|-
| -I || Do not output "Table of Contents" before entries. If omitted, "Table of Contents" will be outputted after the entries.
+
| -I || Do not print "Table of Contents" before entries. If omitted, "Table of Contents" will be printed after the entries.
 
|}
 
|}
   

Revision as of 06:59, 14 June 2020

Contents

Version 53.30 (AmigaOS 4.1 Final Edition)

AutoDoc

AutoDoc extracts and sorts autodocs from the given files and prints them in the standard output.

Tool Types

(none)

Shell Usage

Format
AUTODOC [-t <number>] [-i] [-o] [-a] [-s] [-C] [-l <length>] [-w] [-c] [-f] [-r] [-F <file>] [-I] {<infile>}
Template
[-t number] [-i] [-o] [-a] [-s] [-C] [-l length] [-w] [-c] [-f] [-r] [-F file] [-I] {infile}
Location
SDK:C

The options are:

{<infile>} List of files to be processed.
-t<number> Turn tabulators to given number of spaces.
-i Process only INTERNAL autodocs.
-o Process only OBSOLETE autodocs.
-a Do not process autodocs starting with an asterisk.
-s Process autodocs starting with a semicolon.
-C Process autodocs starting with "/*". This is the default setting.
-l<number> Set the line length for the output. The default is 78.
-w Turn off word wrapping.
-c Do not convert "\*" to "/*" or "*\" to "*/".
-f Do not add form feeds between the autodoc entries.
-r Generate Troff source output.
-F<file> Use <file> as a temporary file. The default temporary file is "tmpfile".
-I Do not print "Table of Contents" before entries. If omitted, "Table of Contents" will be printed after the entries.
Example

Extract autodocs from files "main.c" and "functions.h" and redirect AutoDoc's output to file "MyDocs.doc".

1> autodoc -a -C main.c functions.h >MyDocs.doc

ARexx Interface

AutoDoc has no ARexx interface.

BuildLanguageCT

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

BuildMapTable

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

BumpRev

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

CatComp

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

ChangeRegs

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

DistCC

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

DistCCD

Missing description.

Tool Types

Shell Usage

ARexx Interface

DistCCMon-Amiga

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

DistCCMon-Text

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

Expunge

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

FDTrans

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

FSTest

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

FSVPTool

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

GDB

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

GMake

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

GUnZip

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

GZip

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

IDLTool

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

ListDynDep

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

Localize

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

Make

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

MakeAudioMode

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

ModList

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

SH

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

TAR

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface

USBSnoop

Missing description.

Tool Types

Shell Usage

Format
Template
Location
SDK:C

ARexx Interface