qexo.man 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. .TH QEXO 1
  2. .\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
  3. .\" other parms are allowed: see man(7), man(1)
  4. .SH NAME
  5. qexo \- the XQuery language implemented on a Java VM
  6. .SH SYNOPSIS
  7. .B qexo
  8. .I "[options]"
  9. .br
  10. .B java kawa.repl --xquery
  11. .I "[options]"
  12. .SH "DESCRIPTION"
  13. This manual page documents briefly the
  14. .BR qexo
  15. package, an XQuery implementation written completely in the Java language.
  16. XQuery expressions are compiled into Java bytecodes for efficiency.
  17. XQuery is a new language designed for querying, manipulating, and
  18. generating XML and similar data sets.
  19. Using the
  20. .B qexo
  21. script is equivalent to invoking an interpreter of the Java language on the
  22. .B "kawa.repl"
  23. class and specifying the
  24. .B "--xquery"
  25. option.
  26. This manual page is just a quick synopsis.
  27. For more information, see the links below.
  28. .SH OPTIONS
  29. .TP
  30. .BI "-e " expression
  31. Evaluate the
  32. .IR expression .
  33. .TP
  34. .BI "-c " expression
  35. Evaluate the
  36. .IR expression ,
  37. but does not cause the start-up file
  38. .I ~/.kawarc.scm
  39. to be read.
  40. .TP
  41. .BI "-f " filename
  42. Read and evaluate XQuery expressions from the
  43. .IR filename .
  44. .TP
  45. .B -s
  46. Enter an interactive read-evaluate-print command loop.
  47. .TP
  48. .B -w
  49. Enter an interactive read-evaluate-print in a new top-level window.
  50. .TP
  51. .BI "-C " filename
  52. Compile
  53. .IR filename
  54. to one or more Java class files. See the Kawa manual for details.
  55. .P
  56. If no options are specified, it is equivalent to
  57. .BR "-s" "."
  58. .br
  59. GNU
  60. .BR "readline(3)" " can normally be used to edit commands."
  61. .SH FILES
  62. .TP
  63. .B /usr/bin/qexo
  64. The
  65. .B qexo
  66. executable just invokes
  67. .B kawa(1)
  68. with the
  69. .B --xquery
  70. option.
  71. .TP
  72. .B ~/.kawarc.scm
  73. Commands that are executed when
  74. .BR "qexo" " (or"
  75. .BR "kawa" ") is started."
  76. .SH AUTHOR
  77. Per Bothner <per@bothner.com>.
  78. .SH "SEE ALSO"
  79. .B kawa(1)
  80. .P
  81. .BR "info kawa" " - the complete Kawa manual."
  82. .UR "http://www.gnu.org/software/qxeo/"
  83. .I http://www.gnu.org/software/qxeo/
  84. .UE
  85. - the
  86. .B qexo
  87. home page.
  88. .UR "http://www.gnu.org/software/kawa/"
  89. .I "http://www.gnu.org/software/kawa/"
  90. .UE
  91. - the
  92. .B kawa
  93. home page.
  94. .UR "htpp://www.w3.org/XML/Query"
  95. .I "htpp://www.w3.org/XML/Query"
  96. .UE
  97. - the W3C XQuery home page.