Skip to content

Commit

Permalink
Create open.xml man page
Browse files Browse the repository at this point in the history
  • Loading branch information
joshbaker22 authored Aug 15, 2023
1 parent 59833f1 commit ab61e64
Showing 1 changed file with 68 additions and 0 deletions.
68 changes: 68 additions & 0 deletions doc/docbook/system/mann/open.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="open">

<refmeta>
<refentrytitle>OPEN</refentrytitle>
<manvolnum>nged</manvolnum>
<refmiscinfo class="source">BRL-CAD</refmiscinfo>
<refmiscinfo class="manual">BRL-CAD MGED Commands</refmiscinfo>
</refmeta>

<refnamediv xml:id="name">
<refname>open</refname>
<refpurpose>
Opens a file.
</refpurpose>
</refnamediv>

<!-- body begins here -->
<refsynopsisdiv xml:id="synopsis">
<cmdsynopsis sepchar=" ">
<command>open</command>
<arg choice="req" rep="norepeat"><replaceable>example.g</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsection xml:id="description"><title>DESCRIPTION</title>

<para>
The <command>open</command> command opens the given BRL-CAD file. The command will look in
the current working directory for the file. If the file is in another directory, use the relative or full
path to the file or use the <command>pwd</command> and <command>cd</command> commands to navigate
to the file's directory.
</para>
</refsection>

<refsection xml:id="examples"><title>EXAMPLES</title>

<example><title>Open a BRL-CAD dateabase.</title>

<para>
<prompt>mged&gt; </prompt><userinput>open example.g</userinput>
</para>
<para>Opens example.g located in the current working directory.
</para>
</example>

<example><title>Open a BRL-CAD database using the full path to the file.</title>

<para>
<prompt>mged&gt; </prompt><userinput>open C:/cad_work/example.g</userinput>
</para>
<para>Opens example.g located at C:\cad_work\.
</para>
</example>

</refsection>

<refsection xml:id="author"><title>AUTHOR</title>
<para>BRL-CAD Team</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>devs@brlcad.org</email>
</para>
</refsection>
</refentry>

0 comments on commit ab61e64

Please sign in to comment.