share/man/nitx.md

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