manpage: -Wuninitialized-constant -Wuninitialized-global

[xonotic/gmqcc.git] / doc / qcvm.1

diff --git a/doc/qcvm.1 b/doc/qcvm.1
index 1d895956ef7963fd016a3fc1b43b67d5ffe26286..332cce969802eabeed281a9336d3202b4b9a8caf 100644 (file)
--- a/doc/qcvm.1
+++ b/doc/qcvm.1
@@ -32,6 +32,9 @@ Print information from the program's header instead of executing.
 .B "-disasm"
 Disassemble the program by function instead of executing.
 .TP
+.BI "-disasm-func" function
+Search for and disassemble the given function.
+.TP
 .B "-printdefs"
 List all entries from the program's defs-section. Effectively
 listing all the global variables of the program.
@@ -44,7 +47,13 @@ This option disables execution.
 .TP
 .B "-printfuns"
 List functions and some information about their parameters.
-This option disables execution.
+This option disables execution. With a verbosity level of 1, builtin
+numbers are printed. With a verbosity of 2, the function's sizes are
+printed as well. This takes a little longer since the size is found by
+searching for a DONE instruction in the code.
+.TP
+.B "-v"
+Increase verbosity level, can be used multiple times.
 .TP
 .BI "-vector """ "x y z" """"
 Append a vector parameter to be passed to \fImain\fR.
@@ -56,36 +65,64 @@ Append a float parameter to be passed to \fImain\fR.
 Append a string parameter to be passed to \fImain\fR.
 .SH BUILTINS
 The following builtin functions are available:
-.TP
+.fi
+
 .RI "1) " void " print(" string... ") = " "#1" ;
+.in +8
 Print the passed strings to stdout. At most 8 strings are allowed.
-.TP
+.in
+
 .RI "2) " string " ftos(" float ") = " "#2" ;
+.in +8
 Convert a float to a string.
-.TP
+.in
+
 .RI "3) " entity " spawn() = " "#3" ;
+.in +8
 Spawn an entity.
-.TP
+.in
+
 .RI "4) " void " remove(" entity ") = " "#4" ;
+.in +8
 Remove an entity.
-.TP
+.in
+
 .RI "5) " string " vtos(" vector ") = " "#5" ;
+.in +8
 Convert a vector to a string.
-.TP
+.in
+
 .RI "6) " void " error(" string... ") = " "#6" ;
+.in +8
 Print at most 8 strings to stdout and then exit with an error.
-.TP
+.in
+
 .RI "7) " float " vlen(" vector ") = " "#7" ;
+.in +8
 Get the length of a vector.
-.TP
+.in
+
 .RI "8) " string " etos(" entity ") = " "#8" ;
+.in +8
 Get the entity ID as string.
-.TP
+.in
+
 .RI "9) " float " stof(" string ") = " "#9" ;
+.in +8
 Convert a string to a float.
-.TP
+.in
+
 .RI "10) " string " strcat(" string ", " string ") = " "#10" ;
+.in +8
 Concatenate two strings, returning a tempstring.
+.in
+
+.RI "11) " float " strcmp (" string ", " string ") = " "#11" ;
+.fi
+.RI "    " float " strncmp(" string ", " string ", " float ") = " "#11" ;
+.in +8
+Compare two strings. Returns the same as the corresponding C functions.
+.in
 .SH BUGS
 Please report bugs on <http://github.com/graphitemaster/gmqcc/issues>,
 or see <http://graphitemaster.github.com/gmqcc> on how to contact us.