share/man/nitx.md

   1 % NITX(1)
   2
   3 # NAME
   4
   5 nitx - displays specific pieces of API information from Nit source files.
   6
   7 # SYNOPSIS
   8
   9 nitx [*options*] FILE [COMMAND]
  10
  11 # DESCRIPTION
  12
  13 `nitx` in an interactive tool that display information about programs and libraries.
  14
  15 A command that query some information can be given as and argument.
  16 This will immediately displays the information then terminates the programs.
  17
  18 If no command are given, the program starts an interactive session where commands are entered until `:q` is given.
  19
  20 # COMMANDS
  21
  22 `name`
  23 :   lookup module, class and property with the corresponding 'name'.
  24
  25 `param: Type`
  26 :   lookup methods using the corresponding 'Type' as parameter.
  27
  28 `return: Type`
  29 :   lookup methods returning the corresponding 'Type'.
  30
  31 `new: Type`
  32 :   lookup methods creating new instances of 'Type'.
  33
  34 `:h`
  35 :   display an help message about the commands.
  36
  37 `:q`
  38 :   exit the tool.
  39
  40 # OPTIONS
  41
  42 Only common options of the Nit tools are understood.
  43
  44 # SEE ALSO
  45
  46 The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>