Revision: 77127
http://sourceforge.net/p/brlcad/code/77127
Author: starseeker
Date: 2020-09-13 14:47:05 +0000 (Sun, 13 Sep 2020)
Log Message:
-----------
bolt man page was added to MGED's category, but we still have the command line
tool as well.
Modified Paths:
--------------
brlcad/trunk/doc/docbook/system/man1/CMakeLists.txt
Added Paths:
-----------
brlcad/trunk/doc/docbook/system/man1/bolt.xml
Modified: brlcad/trunk/doc/docbook/system/man1/CMakeLists.txt
===================================================================
--- brlcad/trunk/doc/docbook/system/man1/CMakeLists.txt 2020-09-13 14:37:31 UTC
(rev 77126)
+++ brlcad/trunk/doc/docbook/system/man1/CMakeLists.txt 2020-09-13 14:47:05 UTC
(rev 77127)
@@ -6,6 +6,7 @@
asc2dsp.xml
asc2g.xml
benchmark.xml
+ bolt.xml
brlman.xml
bot_dump.xml
brep_simple.xml
Added: brlcad/trunk/doc/docbook/system/man1/bolt.xml
===================================================================
--- brlcad/trunk/doc/docbook/system/man1/bolt.xml
(rev 0)
+++ brlcad/trunk/doc/docbook/system/man1/bolt.xml 2020-09-13 14:47:05 UTC
(rev 77127)
@@ -0,0 +1,190 @@
+<refentry xmlns="http://docbook.org/ns/docbook"; version="5.0" xml:id="bolt1">
+
+<refmeta>
+ <refentrytitle>BOLT</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="source">BRL-CAD</refmiscinfo>
+ <refmiscinfo class="manual">BRL-CAD User Commands</refmiscinfo>
+</refmeta>
+
+<refnamediv xml:id="name">
+ <refname>bolt</refname>
+ <refpurpose>
+ Creates a BRL-CAD .g file containing bolts.
+ </refpurpose>
+</refnamediv>
+
+<!-- body begins here -->
+<refsynopsisdiv xml:id="synopsis">
+ <cmdsynopsis sepchar=" ">
+ <command>bolt</command>
+ <arg choice="opt" rep="repeat"><replaceable>options</replaceable></arg>
+ </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsection xml:id="description"><title>DESCRIPTION</title>
+
+ <para>
+ <command>bolt</command> is a program to create a BRL-CAD data base of
+ one of four different kinds of bolts. Up to twenty-six bolts of one type
+ and size may be created. <command>bolt</command> uses libwdb to create a
+ database file. This program may be run interactively or the user may
+ specify options on a command line. If the user chooses to run the program
+ interactively he answers the questions as the program prompts him. Below
+ are the options that can be used on the command line.
+ </para>
+</refsection>
+
+
+<refsection xml:id="options"><title>OPTIONS</title>
+
+ <variablelist remap="TP">
+ <varlistentry>
+ <term><option>-o#</option></term>
+ <listitem>
+ <para>
+ Type of bolt to be created: 1=>bolt head; 2=>bolt head and
washer; 3=>bolt
+ head, washer, and bolt stem; and 4=>bolt head and bolt stem.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-f </option><replaceable>name.g</replaceable></term>
+ <listitem>
+ <para>
+ BRL-CAD file name.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-n #</option></term>
+ <listitem>
+ <para>
+ The number of bolts to be created. This number must be less than or
equal to
+ 26 (or it will be set to 26).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-hd #</option></term>
+ <listitem>
+ <para>
+ Diameter of bolt head, flat edge to flat edge, in millimeters.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-hh #</option></term>
+ <listitem>
+ <para>
+ Height of bolt head in millimeters.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-wd #</option></term>
+ <listitem>
+ <para>
+ Diameter of washer in millimeters.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-wh #</option></term>
+ <listitem>
+ <para>
+ Height of washer in millimeters.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-sd #</option></term>
+ <listitem>
+ <para>
+ Diameter of bolt stem in millimeters.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-sh #</option></term>
+ <listitem>
+ <para>
+ Height of bolt stem in millimeters.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+</refsection>
+
+<refsection xml:id="examples"><title>EXAMPLES</title>
+
+ <example><title>Interactive <command>bolt</command> Session</title>
+
+ <para>
+ <literallayout class="normal">
+$ bolt
+Enter option:
+ 1 - bolt head
+ 2 - bolt head & washer
+ 3 - bolt head, washer, & stem
+ 4 - bolt head & stem
+1
+Enter name of mged file to be created (25 char max).
+ bolt.g
+Enter the number of bolts to be created (26 max).
+ 3
+Enter diameter (flat edge to flat edge) & height of bolt head.
+ 30 10
+
+option: 1 - bolt head
+file: bolt.g
+head diameter: 30.000000, & height: 10.000000
+washer diameter: 0.000000, & height: 0.000000
+stem diameter: 0.000000, & height: 0.000000
+number of bolts: 3
+ </literallayout>
+ </para>
+ </example>
+
+ <example><title>Single-Line <command>bolt</command> Command</title>
+
+ <para>
+ <userinput>bolt -o1 -fbolt.g -n3 -hd30 -hh10</userinput>
+ </para>
+ </example>
+
+ <para>
+ Both examples produce the same output - the bolt heads (option 1)
+ are created with a diameter of 30mm and a height of 10mm in a database
+ file called bolt.g.
+ </para>
+
+</refsection>
+
+<refsection xml:id="author"><title>AUTHOR</title>
+ <para>Susan A. Coates</para>
+</refsection>
+
+<refsection xml:id="copyright"><title>COPYRIGHT</title>
+
+ <para>
+ This software is Copyright (c) 2005-2020 United States Government as
+ represented by the U.S. Army Research Laboratory.
+ </para>
+</refsection>
+
+<refsection xml:id="see_also"><title>SEE ALSO</title>
+
+ <para>
+ handle(1), window(1), window_frame(1), gastank(1)
+ </para>
+</refsection>
+
+<refsection xml:id="bug_reports"><title>BUG REPORTS</title>
+
+ <para>
+ Reports of bugs or problems should be submitted via electronic
+ mail to <email>[email protected]</email>
+ </para>
+</refsection>
+</refentry>
Property changes on: brlcad/trunk/doc/docbook/system/man1/bolt.xml
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:mime-type
## -0,0 +1 ##
+text/xml
\ No newline at end of property
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
