etch
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Id$ -->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY firstname "Pierre">
<!ENTITY surname "Pronchery">
<!ENTITY copyright "The EdgeBSD Project">
<!ENTITY username "khorben">
<!ENTITY email "khorben@edgebsd.org">
<!ENTITY section "1">
<!ENTITY title "EdgeBSD Infrastructure Manual">
<!ENTITY package "edgebsd-infrastructure">
<!ENTITY name "etch">
<!ENTITY purpose "Generate bootable and ready-to-flash system images">
]>
<refentry>
<refentryinfo>
<title>&title;</title>
<productname>&package;</productname>
<authorgroup>
<author>
<firstname>&firstname;</firstname>
<surname>&surname;</surname>
<contrib>Code and documentation.</contrib>
<address>
<email>&email;</email>
</address>
</author>
</authorgroup>
<copyright>
<year>2014</year>
<year>2015</year>
<year>2016</year>
<year>2017</year>
<holder>©right; <&email;></holder>
</copyright>
</refentryinfo>
<refmeta>
<refentrytitle>&name;</refentrytitle>
<manvolnum>§ion;</manvolnum>
</refmeta>
<refnamediv>
<refname>&name;</refname>
<refpurpose>&purpose;</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&name;</command>
<arg choice="opt"><option>-c</option></arg>
<arg choice="opt"><option>-q</option></arg>
<arg choice="opt"><option>-v</option></arg>
<arg choice="opt" rep="repeat"><option>-O</option>
<replaceable>name=value</replaceable></arg>
<arg choice="opt"><option>-o</option>
<replaceable>filename</replaceable></arg>
<arg choice="opt"><option>-p</option>
<replaceable>profile</replaceable></arg>
<arg choice="opt"><option>-h</option>
<replaceable>host</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>Description</title>
<para><command>&name;</command> generates either bootable disk images,
ready-to-flash system images or simply environments suitable for jails,
chroots, or cross-compilation.</para>
</refsect1>
<refsect1 id="options">
<title>Options</title>
<para><command>&name;</command> accepts a number of options, modifying the
way it operates.</para>
<variablelist>
<varlistentry>
<term><option>-c</option></term>
<listitem><para>Delete the target data prior to operation.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option> <replaceable>hostname</replaceable></term>
<listitem><para>Hostname definition file to load.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-o</option> <replaceable>filename</replaceable></term>
<listitem><para>Target filename for the disk or ready-to-flash image to
generate.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-q</option></term>
<listitem><para>Reset the verbosity level, minimizing the amount of output
generated by <command>&name;</command>.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<listitem><para>Increase the verbosity level. It can be specified multiple
times, with the following impact:<orderedlist>
<listitem><para>The operations performed are listed</para></listitem>
<listitem><para>The sub-commands used may generate some
output</para></listitem>
<listitem><para>Sub-commands are called in verbose mode (when
applicable)</para></listitem>
<listitem><para>Debugging information is output as well</para></listitem>
</orderedlist></para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para>To create a bootable EdgeBSD image, fitting in a 512MB Compact Flash
memory disk:</para>
<programlisting>$ &name; -o soekris.img -O IMAGE_SIZE=500000</programlisting>
</refsect1>
<refsect1 id="bugs">
<title>Bugs</title>
<para>Issues should be reported to the developers mailing-list of the project,
which can be found at <ulink url="http://lists.edgebsd.org/"/>.</para>
</refsect1>
</refentry>
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->