.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH VDB_AX "1" "February 2024" "vdb_ax 10.0.1" "User Commands"
.SH NAME
vdb_ax - utility for processing OpenVDB data using AX
.SH DESCRIPTION
usage: vdb_ax [command] [\-\-help|\-h] [\-v] [<args>]
.PP
CLI utility for processing OpenVDB data using AX.
.TP
\fB\-h\fR, \fB\-\-help\fR, \fB\-help\fR
print help and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose (print timing and diagnostics)
.SS "[execute] read/process/write VDB file/streams (default command):"
.TP
\fB\-i\fR [file.vdb]
append an input vdb file to be read
.TP
\fB\-s\fR [code], \fB\-f\fR [file]
input code to execute as a string or from a file
.TP
\fB\-o\fR [file.vdb]
write the result to a given vdb file
.TP
\fB\-\-opt\fR [NONE|O0|O1|O2|Os|Oz|O3]
compilation optimization level (Default: 03)
.TP
\fB\-\-threads\fR [n]
number of threads to use, 0 uses all available (Default: 0)
.TP
\fB\-\-werror\fR
warnings as errors
.TP
\fB\-\-max\-errors\fR [n]
maximum error messages, 0 allows all error messages (Default: 0)
.TP
\fB\-\-copy\-file\-metadata\fR
copy the file level metadata of the first input to the output
.IP
Volumes:
.TP
\fB\-\-create\-missing\fR [ON|OFF]
whether to implicitly create volumes (Default: ON)
.TP
\fB\-\-tree\-level\fR [l1|l1:l2]
a node level or node range to process (Default: 0:4)
.TP
\fB\-\-node\-iter\fR [ON|OFF|ALL]
the active state type of nodes to process (Default: ON)
.TP
\fB\-\-tile\-stream\fR [ON|OFF|AUTO]
set the active tile streaming behaviour (Default: AUTO)
.TP
\fB\-\-volume\-grain\fR [g1|g1:g2]
threading grain size for processing nodes (Default: 1:32)
.TP
\fB\-\-bindings\fR ["ax_name:volume_name,..."]
attribute bindings for volumes
.IP
Points:
.TP
\fB\-\-create\-missing\fR [ON|OFF]
whether to implicitly point attributes (Default: ON)
.TP
\fB\-\-group\fR [name]
a point group to process
.TP
\fB\-\-points\-grain\fR [n]
the threading grain size for processing nodes (Default: 1)
.TP
\fB\-\-bindings\fR ["ax_name:point_attr_name,..."]
attribute bindings for points
.SS "[analyze] parse code and run analysis:"
.TP
\fB\-\-ast\-print\fR
print the generated abstract syntax tree
.TP
\fB\-\-re\-print\fR
re\-interpret print of the code post ast traversal
.TP
\fB\-\-reg\-print\fR
print the attribute registry (name, types, access, dependencies)
.TP
\fB\-\-try\-compile\fR <points | volumes>
attempt compilation for points, volumes or both if no option is
provided
.SS "[functions] query available function information:"
.TP
\fB\-\-list\fR <filter\-name>
list functions, their documentation and their signatures
.TP
\fB\-\-list\-names\fR
list all available functions names only
.PP
Email bug reports, questions, discussions to <openvdb\-dev@lists.aswf.io>
and/or open issues at https://github.com/AcademySoftwareFoundation/openvdb.
.SH AUTHOR
This manual page was written by Mathieu Malaterre <malat@debian.org> for the
Debian GNU/Linux system (but may be used by others).