Skip to content

Commit 794b008

Browse files
rdbrdb
committed
Add man pages for the majority of utilities
1 parent fef66d1 commit 794b008

File tree

107 files changed

+3110
-9
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

107 files changed

+3110
-9
lines changed

‎doc/man/bam-info.1‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.\" Automatically generated by bam-info -write-bam
2+
.TH BAM-INFO 1 "27 December 2014" "1.9.0" Panda3D
3+
.SH NAME
4+
bam-info \- describe the contents of .bam files
5+
.SH SYNOPSIS
6+
\fBbam-info\fR [opts] input.bam [input.bam ... ]
7+
.SH DESCRIPTION
8+
This program scans one or more Bam files\-\-Panda's Binary Animation and Models native binary format\-\-and describes their contents.
9+
.SH OPTIONS
10+
.TP
11+
.B \-ls
12+
List the scene graph hierarchy in the bam file.
13+
.TP
14+
.B \-t
15+
List explicitly each transition in the hierarchy.
16+
.TP
17+
.B \-g
18+
Output verbose information about the each Geom in the Bam file.
19+
.TP
20+
.B \-h
21+
Display this help page.

‎doc/man/bam2egg.1‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
.\" Automatically generated by bam2egg -write-bam
2+
.TH BAM2EGG 1 "27 December 2014" "1.9.0" Panda3D
3+
.SH NAME
4+
bam2egg \- convert a native Panda .bam file to an .egg file
5+
.SH SYNOPSIS
6+
\fBbam2egg\fR [opts] input.bam output.egg
7+
.br
8+
\fBbam2egg\fR [opts] -o output.egg input.bam
9+
.br
10+
\fBbam2egg\fR [opts] input.bam >output.egg
11+
.SH DESCRIPTION
12+
This program converts native Panda bam files to egg. The conversion is somewhat incomplete; running egg2bam followed by bam2egg should not be expected to yield the same egg file you started with.
13+
.SH OPTIONS
14+
.TP
15+
.B \-noabs
16+
Don't allow the input bam file to have absolute pathnames. If it does, abort with an error. This option is designed to help detect errors when populating or building a standalone model tree, which should be self-contained and include only relative pathnames.
17+
.TP
18+
.B \-noexist
19+
Don't treat it as an error if the input file references pathnames (e.g. textures) that don't exist. Normally, this will be flagged as an error and the command aborted; with this option, an egg file will be generated anyway, referencing pathnames that do not exist.
20+
.TP
21+
.B \-ignore
22+
Ignore non-fatal errors and generate an egg file anyway.
23+
.TP
24+
.BI "\-o " "filename"
25+
Specify the filename to which the resulting egg file will be written. If this option is omitted, the last parameter name is taken to be the name of the output file, or standard output is used if there are no other parameters.
26+
.TP
27+
.BI "\-cs " "coordinate-system"
28+
Specify the coordinate system of the input bam file. By default, this is taken from the Config.prc file, which is currently zup_right.
29+
.TP
30+
.B \-h
31+
Display this help page.

‎doc/man/dae2egg.1‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
.\" Automatically generated by dae2egg -write-bam
2+
.TH DAE2EGG 1 "27 December 2014" "1.9.0" Panda3D
3+
.SH NAME
4+
dae2egg \- convert COLLADA assets into .egg files
5+
.SH SYNOPSIS
6+
\fBdae2egg\fR [opts] input.dae output.egg
7+
.br
8+
\fBdae2egg\fR [opts] -o output.egg input.dae
9+
.br
10+
\fBdae2egg\fR [opts] input.dae >output.egg
11+
.SH DESCRIPTION
12+
This program converts .dae files (COLLADA Digital Asset Exchange) to .egg.
13+
.SH OPTIONS
14+
.TP
15+
.B \-noabs
16+
Don't allow the input COLLADA file to have absolute pathnames. If it does, abort with an error. This option is designed to help detect errors when populating or building a standalone model tree, which should be self-contained and include only relative pathnames.
17+
.TP
18+
.B \-noexist
19+
Don't treat it as an error if the input file references pathnames (e.g. textures) that don't exist. Normally, this will be flagged as an error and the command aborted; with this option, an egg file will be generated anyway, referencing pathnames that do not exist.
20+
.TP
21+
.B \-ignore
22+
Ignore non-fatal errors and generate an egg file anyway.
23+
.TP
24+
.B \-invtrans
25+
Import the .dae file using inverted transparency. This is useful when importing COLLADA files from some authoring tools that export models with inverted transparency, such as Google SketchUp.
26+
.TP
27+
.BI "\-ui " "units"
28+
Specify the units of the input COLLADA file. Normally, this can be inferred from the file itself.
29+
.TP
30+
.BI "\-uo " "units"
31+
Specify the units of the resulting egg file. If this is specified, the vertices in the egg file will be scaled as necessary to make the appropriate units conversion; otherwise, the vertices will be left as they are.
32+
.TP
33+
.B \-no
34+
Strip all normals.
35+
.TP
36+
.B \-np
37+
Strip existing normals and redefine polygon normals.
38+
.TP
39+
.BI "\-nv " "threshold"
40+
Strip existing normals and redefine vertex normals. Consider an edge between adjacent polygons to be smooth if the angle between them is less than threshold degrees.
41+
.TP
42+
.B \-nn
43+
Preserve normals exactly as they are. This is the default.
44+
.TP
45+
.BI "\-tbn " "name"
46+
Compute tangent and binormal for the named texture coordinate set(s). The name may include wildcard characters such as * and ?. The normal must already exist or have been computed via one of the above options. The tangent and binormal are used to implement bump mapping and related texture-based lighting effects. This option may be repeated as necessary to name multiple texture coordinate sets.
47+
.TP
48+
.B \-tbnall
49+
Compute tangent and binormal for all texture coordinate sets. This is equivalent to -tbn "*".
50+
.TP
51+
.B \-tbnauto
52+
Compute tangent and binormal for all normal maps.
53+
.TP
54+
.BI "\-TS " "sx[,sy,sz]"
55+
Scale the model uniformly by the given factor (if only one number is given) or in each axis by sx, sy, sz (if three numbers are given).
56+
.TP
57+
.BI "\-TR " "x,y,z"
58+
Rotate the model x degrees about the x axis, then y degrees about the y axis, and then z degrees about the z axis.
59+
.TP
60+
.BI "\-TA " "angle,x,y,z"
61+
Rotate the model angle degrees counterclockwise about the given axis.
62+
.TP
63+
.BI "\-TT " "x,y,z"
64+
Translate the model by the indicated amount.
65+
66+
All transformation options (-TS, -TR, -TA, -TT) are cumulative and are applied in the order they are encountered on the command line.
67+
.TP
68+
.BI "\-o " "filename"
69+
Specify the filename to which the resulting egg file will be written. If this option is omitted, the last parameter name is taken to be the name of the output file, or standard output is used if there are no other parameters.
70+
.TP
71+
.BI "\-cs " "coordinate-system"
72+
Specify the coordinate system of the input COLLADA file. Normally, this can inferred from the file itself.
73+
.TP
74+
.B \-h
75+
Display this help page.

‎doc/man/dxf-points.1‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.\" Automatically generated by dxf-points -write-bam
2+
.TH DXF-POINTS 1 "27 December 2014" "1.9.0" Panda3D
3+
.SH NAME
4+
dxf-points \- extract points from AutoCAD .dxf files
5+
.SH SYNOPSIS
6+
\fBdxf-points\fR [opts] input.dxf > output.txt
7+
.br
8+
\fBdxf-points\fR [opts] -o output.txt input.dxf
9+
.br
10+
\fBdxf-points\fR [opts] input.dxf output.txt
11+
.SH DESCRIPTION
12+
This program reads an AutoCAD .dxf file and generates a simple list of all the points contained within it, one per line, to a text file, or to standard output.
13+
.SH OPTIONS
14+
.TP
15+
.B \-h
16+
Display this help page.

‎doc/man/dxf2egg.1‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
.\" Automatically generated by dxf2egg -write-bam
2+
.TH DXF2EGG 1 "27 December 2014" "1.9.0" Panda3D
3+
.SH NAME
4+
dxf2egg \- convert AutoCAD .dxf files to .egg files
5+
.SH SYNOPSIS
6+
\fBdxf2egg\fR [opts] input.dxf output.egg
7+
.br
8+
\fBdxf2egg\fR [opts] -o output.egg input.dxf
9+
.br
10+
\fBdxf2egg\fR [opts] input.dxf >output.egg
11+
.SH DESCRIPTION
12+
This program converts DXF (AutoCAD interchange format) to egg. It only converts polygon data, with no fancy tricks. DXF does not support hierarchical databases, so dxf2egg creates a single group at the root level for each layer in the DXF file.
13+
.SH OPTIONS
14+
.TP
15+
.B \-noabs
16+
Don't allow the input DXF file to have absolute pathnames. If it does, abort with an error. This option is designed to help detect errors when populating or building a standalone model tree, which should be self-contained and include only relative pathnames.
17+
.TP
18+
.B \-noexist
19+
Don't treat it as an error if the input file references pathnames (e.g. textures) that don't exist. Normally, this will be flagged as an error and the command aborted; with this option, an egg file will be generated anyway, referencing pathnames that do not exist.
20+
.TP
21+
.B \-ignore
22+
Ignore non-fatal errors and generate an egg file anyway.
23+
.TP
24+
.BI "\-ui " "units"
25+
Specify the units of the input DXF file. Normally, this can be inferred from the file itself.
26+
.TP
27+
.BI "\-uo " "units"
28+
Specify the units of the resulting egg file. If this is specified, the vertices in the egg file will be scaled as necessary to make the appropriate units conversion; otherwise, the vertices will be left as they are.
29+
.TP
30+
.B \-no
31+
Strip all normals.
32+
.TP
33+
.B \-np
34+
Strip existing normals and redefine polygon normals.
35+
.TP
36+
.BI "\-nv " "threshold"
37+
Strip existing normals and redefine vertex normals. Consider an edge between adjacent polygons to be smooth if the angle between them is less than threshold degrees.
38+
.TP
39+
.B \-nn
40+
Preserve normals exactly as they are. This is the default.
41+
.TP
42+
.BI "\-tbn " "name"
43+
Compute tangent and binormal for the named texture coordinate set(s). The name may include wildcard characters such as * and ?. The normal must already exist or have been computed via one of the above options. The tangent and binormal are used to implement bump mapping and related texture-based lighting effects. This option may be repeated as necessary to name multiple texture coordinate sets.
44+
.TP
45+
.B \-tbnall
46+
Compute tangent and binormal for all texture coordinate sets. This is equivalent to -tbn "*".
47+
.TP
48+
.B \-tbnauto
49+
Compute tangent and binormal for all normal maps.
50+
.TP
51+
.BI "\-TS " "sx[,sy,sz]"
52+
Scale the model uniformly by the given factor (if only one number is given) or in each axis by sx, sy, sz (if three numbers are given).
53+
.TP
54+
.BI "\-TR " "x,y,z"
55+
Rotate the model x degrees about the x axis, then y degrees about the y axis, and then z degrees about the z axis.
56+
.TP
57+
.BI "\-TA " "angle,x,y,z"
58+
Rotate the model angle degrees counterclockwise about the given axis.
59+
.TP
60+
.BI "\-TT " "x,y,z"
61+
Translate the model by the indicated amount.
62+
63+
All transformation options (-TS, -TR, -TA, -TT) are cumulative and are applied in the order they are encountered on the command line.
64+
.TP
65+
.BI "\-o " "filename"
66+
Specify the filename to which the resulting egg file will be written. If this option is omitted, the last parameter name is taken to be the name of the output file, or standard output is used if there are no other parameters.
67+
.TP
68+
.BI "\-cs " "coordinate-system"
69+
Specify the coordinate system of the input DXF file. Normally, this is z-up.
70+
.TP
71+
.B \-h
72+
Display this help page.

‎doc/man/egg-crop.1‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
.\" Automatically generated by egg-crop -write-bam
2+
.TH EGG-CROP 1 "27 December 2014" "1.9.0" Panda3D
3+
.SH NAME
4+
egg-crop \- crop geometry in an .egg file
5+
.SH SYNOPSIS
6+
\fBegg-crop\fR [opts] -o output.egg input.egg
7+
.br
8+
\fBegg-crop\fR [opts] input.egg >output.egg
9+
.SH DESCRIPTION
10+
egg\-crop strips out all parts of an egg file that fall outside of an arbitrary bounding volume, specified with a minimum and maximum point in world coordinates.
11+
.SH OPTIONS
12+
.TP
13+
.B \-noabs
14+
Don't allow the input egg file to have absolute pathnames. If it does, abort with an error. This option is designed to help detect errors when populating or building a standalone model tree, which should be self-contained and include only relative pathnames.
15+
.TP
16+
.BI "\-min " "x,y,z"
17+
Specify the minimum point.
18+
.TP
19+
.BI "\-max " "x,y,z"
20+
Specify the maximum point.
21+
.TP
22+
.BI "\-o " "filename"
23+
Specify the filename to which the resulting egg file will be written. If this option is omitted, the egg file is written to standard output.
24+
.TP
25+
.BI "\-cs " "coordinate-system"
26+
Specify the coordinate system of the resulting egg file. This may be one of 'y-up', 'z-up', 'y-up-left', or 'z-up-left'. The default is the same coordinate system as the input egg file. If this is different from the input egg file, a conversion will be performed.
27+
.TP
28+
.B \-f
29+
Force complete loading: load up the egg file along with all of its external references.
30+
.TP
31+
.B \-h
32+
Display this help page.

‎doc/man/egg-list-textures.1‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.\" Automatically generated by egg-list-textures -write-bam
2+
.TH EGG-LIST-TEXTURES 1 "27 December 2014" "1.9.0" Panda3D
3+
.SH NAME
4+
egg-list-textures \- list textures referenced by an .egg file
5+
.SH SYNOPSIS
6+
\fBegg-list-textures\fR [opts] input.egg
7+
.SH DESCRIPTION
8+
egg\-list\-textures reads an egg file and writes a list of the textures it references. It is particularly useful for building up the textures.txa file used for egg\-palettize, since the output format is crafted to be compatible with that file's input format.
9+
.SH OPTIONS
10+
.TP
11+
.B \-noabs
12+
Don't allow the input egg file to have absolute pathnames. If it does, abort with an error. This option is designed to help detect errors when populating or building a standalone model tree, which should be self-contained and include only relative pathnames.
13+
.TP
14+
.BI "\-cs " "coordinate-system"
15+
Specify the coordinate system to operate in. This may be one of 'y-up', 'z-up', 'y-up-left', or 'z-up-left'. The default is the coordinate system of the input egg file.
16+
.TP
17+
.B \-f
18+
Force complete loading: load up the egg file along with all of its external references.
19+
.TP
20+
.B \-h
21+
Display this help page.

‎doc/man/egg-make-tube.1‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
.\" Automatically generated by egg-make-tube -write-bam
2+
.TH EGG-MAKE-TUBE 1 "27 December 2014" "1.9.0" Panda3D
3+
.SH NAME
4+
egg-make-tube \- generate a tube or sphere from geometry in an .egg file
5+
.SH SYNOPSIS
6+
\fBegg-make-tube\fR [opts] output.egg
7+
.br
8+
\fBegg-make-tube\fR [opts] -o output.egg
9+
.br
10+
\fBegg-make-tube\fR [opts] >output.egg
11+
.SH DESCRIPTION
12+
egg\-make\-tube generates an egg file representing a "tube" model, a cylinder capped on both ends by hemispheres. This is similar in shape to the CollisionTube object within Panda.
13+
.PP
14+
This program can also generate spheres if you omit \-b; in this case, you are generating a degenerate tube of length 0.
15+
.SH OPTIONS
16+
.TP
17+
.BI "\-a " "x,y,z"
18+
Specify the first endpoint of the tube.
19+
.TP
20+
.BI "\-b " "x,y,z"
21+
Specify the second endpoint of the tube.
22+
.TP
23+
.BI "\-r " "radius"
24+
Specify the radius of the tube. The tube will extend beyond the endpoints in each direction by the amount of radius.
25+
.TP
26+
.BI "\-slices " "count"
27+
Specify the number of slices appearing radially around the tube.
28+
.TP
29+
.BI "\-crings " "count"
30+
Specify the number of rings appearing in each endcap of the tube.
31+
.TP
32+
.BI "\-trings " "count"
33+
Specify the number of rings appearing in the cylindrical body of the tube.
34+
.TP
35+
.B \-no
36+
Strip all normals.
37+
.TP
38+
.B \-np
39+
Strip existing normals and redefine polygon normals.
40+
.TP
41+
.BI "\-nv " "threshold"
42+
Strip existing normals and redefine vertex normals. Consider an edge between adjacent polygons to be smooth if the angle between them is less than threshold degrees.
43+
.TP
44+
.B \-nn
45+
Preserve normals exactly as they are. This is the default.
46+
.TP
47+
.BI "\-tbn " "name"
48+
Compute tangent and binormal for the named texture coordinate set(s). The name may include wildcard characters such as * and ?. The normal must already exist or have been computed via one of the above options. The tangent and binormal are used to implement bump mapping and related texture-based lighting effects. This option may be repeated as necessary to name multiple texture coordinate sets.
49+
.TP
50+
.B \-tbnall
51+
Compute tangent and binormal for all texture coordinate sets. This is equivalent to -tbn "*".
52+
.TP
53+
.B \-tbnauto
54+
Compute tangent and binormal for all normal maps.
55+
.TP
56+
.BI "\-TS " "sx[,sy,sz]"
57+
Scale the model uniformly by the given factor (if only one number is given) or in each axis by sx, sy, sz (if three numbers are given).
58+
.TP
59+
.BI "\-TR " "x,y,z"
60+
Rotate the model x degrees about the x axis, then y degrees about the y axis, and then z degrees about the z axis.
61+
.TP
62+
.BI "\-TA " "angle,x,y,z"
63+
Rotate the model angle degrees counterclockwise about the given axis.
64+
.TP
65+
.BI "\-TT " "x,y,z"
66+
Translate the model by the indicated amount.
67+
68+
All transformation options (-TS, -TR, -TA, -TT) are cumulative and are applied in the order they are encountered on the command line.
69+
.TP
70+
.BI "\-o " "filename"
71+
Specify the filename to which the resulting egg file will be written. If this option is omitted, the last parameter name is taken to be the name of the output file, or standard output is used if there are no other parameters.
72+
.TP
73+
.BI "\-cs " "coordinate-system"
74+
Specify the coordinate system of the resulting egg file. This may be one of 'y-up', 'z-up', 'y-up-left', or 'z-up-left'. The default is y-up.
75+
.TP
76+
.B \-h
77+
Display this help page.

0 commit comments

Comments
 (0)