@database Miscellaneous.guide
@remark ENGLISH VERSION
@author Eddie Churchill
@(c) "Copyright © 1993 Inovatronics, Inc."
@$VER: Miscellaneous.guide 2.5 (06/01/93)
@wordwrap
@font topaz.font 8
@index "CanDo_LexiconIndex"

@node "CanDo_Miscellaneous_Index" "Miscellaneous Commands, Functions and Variables"
@toc "CanDo_LexiconMain"
@{fg highlight}Available Topics...@{fg text}

  Variable @{" =AvailableChipMemory           " link "CanDo_AvailableChipMemory"}
  Variable @{" =AvailableFastMemory           " link "CanDo_AvailableFastMemory"}
  Variable @{" =AvailableMemory               " link "CanDo_AvailableMemory"}
  Variable @{" =DeckName                      " link "CanDo_DeckName"}
  Command  @{" Delay                          " link "CanDo_Delay"}
  Command  @{" InsertStartingMessage          " link "CanDo_InsertStartingMessage"}
  Variable @{" =IntuitionVersion              " link "CanDo_IntuitionVersion"}
  Variable @{" =LargestChunkOfMemory          " link "CanDo_LargestChunkOfMemory"}
  Variable @{" =LibraryVersion                " link "CanDo_LibraryVersion"}
  Command  @{" Nop                            " link "CanDo_Nop"}
  Variable @{" =StartedFromWorkbench          " link "CanDo_StartedFromWorkbench"}
  Variable @{" =Supervised                    " link "CanDo_Supervised"}
  Variable @{" =TheCommandLine                " link "CanDo_TheCommandLine"}
  Variable @{" =TheDate                       " link "CanDo_TheDate"}
  Variable @{" =TheTime                       " link "CanDo_TheTime"}
@endnode

@node "CanDo_availablechipmemory" "Let {Integer}=AvailableChipMemory"
@toc "CanDo_Miscellaneous_Index"
@{fg highlight}Command...@{fg text}

  Let {Integer}=AvailableChipMemory

@{fg highlight}Description...@{fg text}

  This returns the amount of free chip memory, which will change
frequently.
  
  SEE ALSO: @{" AvailableFastMemory " link "CanDo_AvailableFastMemory"} and @{" AvailableMemory " link "CanDo_AvailableMemory"}.

@endnode

@node "CanDo_availablefastmemory" "Let {Integer}=AvailableFastMemory"
@toc "CanDo_Miscellaneous_Index"
@{fg highlight}Command...@{fg text}

  Let {Integer}=AvailableFastMemory

@{fg highlight}Description...@{fg text}

  This returns the amount of free fast memory.  This will change
frequently.
  
  SEE ALSO: @{" AvailableChipMemory " link "CanDo_AvailableChipMemory"} and @{" AvailableMemory " link "CanDo_AvailableMemory"}.

@endnode

@node "CanDo_availablememory" "Let {Integer}=AvailableMemory"
@toc "CanDo_Miscellaneous_Index"
@{fg highlight}Command...@{fg text}

  Let {Integer}=AvailableMemory

@{fg highlight}Description...@{fg text}

  This returns the amount of total free memory.  This will change
frequently.
  
  SEE ALSO: @{" AvailableFastMemory " link "CanDo_AvailableFastMemory"} and @{" AvailableChipMemory " link "CanDo_AvailableChipMemory"}.
@endnode

@node "CanDo_deckname" "Let {String}=DeckName"
@toc "CanDo_Miscellaneous_Index"
@{fg highlight}Command...@{fg text}

  Let {String}=DeckName

@{fg highlight}Description...@{fg text}

  This returns the current name of the deck.
  
  SEE ALSO: @{" CardName " link "CanDo_CardName"}.

@endnode

@node "CanDo_delay" "Delay {Minutes}, {Seconds}, {Jiffies}"
@toc "CanDo_Miscellaneous_Index"
@{fg highlight}Command...@{fg text}

  Delay {Minutes}, {Seconds}, {Jiffies}

@{fg highlight}Description...@{fg text}

  Delay the execution of the current script by {minutes}, {seconds}, and
{jiffies}.  Jiffies are 1/60 of a second under @{" NTSC " link "CanDo_NTSC"} systems and 1/50 of a
second on PAL systems.

@endnode

@node "CanDo_insertstartingmessage" "InsertStartingMessage"
@toc "CanDo_Miscellaneous_Index"
@{fg highlight}Command...@{fg text}
 
 InsertStartingMessage

@{fg highlight}Description...@{fg text}

  This will insert the startup parameters into the current document.  This
may be icon names when run from the workbench, or command line arguments
when run from the CLI.  See the manual for a full description of this
command.

@endnode

@node "CanDo_intuitionversion" "Let {Integer}=IntuitionVersion"
@toc "CanDo_Miscellaneous_Index"
@{fg highlight}Command...@{fg text}

  Let {Integer}=IntuitionVersion

@{fg highlight}Description...@{fg text}

  This returns the operating system version number.  If you are using
Intuition 1.32 this will return a 34, while if you are using Intuition 2.04
it will return a 37.

@endnode

@node "CanDo_largestchunkofmemory" "Let {Integer}=LargestChunkOfMemory"
@toc "CanDo_Miscellaneous_Index"
@{fg highlight}Command...@{fg text}

  Let {Integer}=LargestChunkOfMemory

@{fg highlight}Description...@{fg text}

  This will return the largest contiguous chunk of free memory.  Some
commands/actions will only work with contiguous memory.
  
  SEE ALSO: @{" AvailableMemory " link "CanDo_AvailableMemory"}.

@endnode

@node "CanDo_libraryversion" "Let {String}=LibraryVersion"
@toc "CanDo_Miscellaneous_Index"
@{fg highlight}Command...@{fg text}

  Let {String}=LibraryVersion

@{fg highlight}Description...@{fg text}

  This will return the current CanDo library version string.  This returns
@{" Nothing " link "CanDo_Nothing"} if you are running using the DeckBrowser.

@endnode

@node "CanDo_nop" "Nop"
@toc "CanDo_Miscellaneous_Index"
@{fg highlight}Command...@{fg text}

  Nop

@{fg highlight}Description...@{fg text}

  This is a "no operation" command which does nothing, but can be used as a
placeholder for comments.  For example:
  
   nop ;comments must follow some command.

@endnode

@node "CanDo_startedfromworkbench" "Let {Logical}=StartedFromWorkbench"
@toc "CanDo_Miscellaneous_Index"
@{fg highlight}Command...@{fg text}

  Let {Logical}=StartedFromWorkbench

@{fg highlight}Description...@{fg text}

  Returns @{" True " link "CanDo_True"} if the application was started from the Workbench.

@endnode

@node "CanDo_supervised" "Let {Logical}=Supervised"
@toc "CanDo_Miscellaneous_Index"
@{fg highlight}Command...@{fg text}

  Let {Logical}=Supervised

@{fg highlight}Description...@{fg text}

  Returns @{" True " link "CanDo_True"} when running from CanDo or if running as a SubDeck.

@endnode

@node "CanDo_thecommandline" "Let {Logical}=TheCommandLine"
@toc "CanDo_Miscellaneous_Index"
@{fg highlight}Command...@{fg text}

  Let {Logical}=TheCommandLine

@{fg highlight}Description...@{fg text}

  Returns the command line if started from CLI, otherwise @{" Nothing " link "CanDo_Nothing"} is
returned.

@endnode

@node "CanDo_thedate" "Let {String}=TheDate"
@toc "CanDo_Miscellaneous_Index"
@{fg highlight}Command...@{fg text}

  Let {String}=TheDate

@{fg highlight}Description...@{fg text}

  Returns the current date in MM/DD/YY format.

@endnode

@node "CanDo_thetime" "Let {String}=TheTime"
@toc "CanDo_Miscellaneous_Index"
@{fg highlight}Command...@{fg text}

  Let {String}=TheTime

@{fg highlight}Description...@{fg text}

  Returns the current time in HH:MM:SS format.

@endnode