<?xml version="1.0" encoding="utf-8"?><!DOCTYPE article  PUBLIC '-//OASIS//DTD DocBook XML V4.4//EN'  'http://www.docbook.org/xml/4.4/docbookx.dtd'><article><articleinfo><title>MemberManual/UsingDomtool</title><revhistory><revision><revnumber>20</revnumber><date>2013-01-14 07:07:24</date><authorinitials>ClintonEbadi</authorinitials></revision><revision><revnumber>19</revnumber><date>2013-01-14 07:07:12</date><authorinitials>ClintonEbadi</authorinitials><revremark>cat / remove seemingly superfluous info about ip addresses</revremark></revision><revision><revnumber>18</revnumber><date>2011-01-28 19:59:41</date><authorinitials>laurenmcnees</authorinitials></revision><revision><revnumber>17</revnumber><date>2008-07-07 04:28:15</date><authorinitials>localhost</authorinitials><revremark>converted to 1.6 markup</revremark></revision><revision><revnumber>16</revnumber><date>2008-04-30 15:13:24</date><authorinitials>AdamChlipala</authorinitials><revremark>deleuze ~~&gt; mail</revremark></revision><revision><revnumber>15</revnumber><date>2008-04-20 15:44:11</date><authorinitials>AdamChlipala</authorinitials><revremark>ns2 -&gt; ns5</revremark></revision><revision><revnumber>14</revnumber><date>2008-04-05 06:09:55</date><authorinitials>MichaelOlson</authorinitials><revremark>Recommend mire_ip and deleuze_ip</revremark></revision><revision><revnumber>13</revnumber><date>2007-11-17 16:19:28</date><authorinitials>AdamChlipala</authorinitials><revremark>No more domtool.deleuze</revremark></revision><revision><revnumber>12</revnumber><date>2007-11-14 14:56:59</date><authorinitials>MichaelOlson</authorinitials><revremark>Point to Examples page, remove &quot;brag on domtool&quot; line</revremark></revision><revision><revnumber>11</revnumber><date>2007-11-14 14:53:48</date><authorinitials>MichaelOlson</authorinitials></revision><revision><revnumber>10</revnumber><date>2007-11-14 14:53:22</date><authorinitials>MichaelOlson</authorinitials><revremark>Clarify by mentioning copying</revremark></revision><revision><revnumber>9</revnumber><date>2007-11-14 14:51:39</date><authorinitials>MichaelOlson</authorinitials><revremark>Add warning about testing domtool configuration</revremark></revision><revision><revnumber>8</revnumber><date>2007-11-12 01:13:35</date><authorinitials>MichaelOlson</authorinitials><revremark>Add domtool.deleuze to instructions</revremark></revision><revision><revnumber>7</revnumber><date>2007-11-10 00:14:41</date><authorinitials>AdamChlipala</authorinitials><revremark>IP address comment</revremark></revision><revision><revnumber>6</revnumber><date>2007-11-08 20:38:01</date><authorinitials>MichaelOlson</authorinitials><revremark>Add hcoop-specific instructions</revremark></revision><revision><revnumber>5</revnumber><date>2007-10-28 01:48:58</date><authorinitials>MichaelOlson</authorinitials><revremark>Add rmdir</revremark></revision><revision><revnumber>4</revnumber><date>2007-10-28 01:46:21</date><authorinitials>MichaelOlson</authorinitials><revremark>Write page</revremark></revision><revision><revnumber>3</revnumber><date>2007-10-27 19:19:21</date><authorinitials>AdamChlipala</authorinitials><revremark>Mention changes to DomTool/UserGuide</revremark></revision><revision><revnumber>2</revnumber><date>2007-10-27 17:51:32</date><authorinitials>AdamChlipala</authorinitials><revremark>Comments</revremark></revision><revision><revnumber>1</revnumber><date>2007-10-25 00:07:09</date><authorinitials>MichaelOlson</authorinitials><revremark>Initial contents</revremark></revision></revhistory></articleinfo><para>This is the chapter of the <ulink url="https://wiki.hcoop.net/MemberManual/UsingDomtool/MemberManual#">MemberManual</ulink> that describes the bare minimum that you need to know concerning our use of <ulink url="https://wiki.hcoop.net/MemberManual/UsingDomtool/DomTool#">DomTool</ulink>.  This is meant to be a very brief HCoop-specific overview, compared to the <ulink url="https://wiki.hcoop.net/MemberManual/UsingDomtool/DomTool/UserGuide#">DomTool/UserGuide</ulink> page, which is more thorough. </para><section><title>Configuration files</title><para>Domtool has user-specified configuration files that determine how to set up a domain or subdomain.  Each file contains all of the information needed to configure a single domain. </para><para>If you want Domtool to process these files automatically, then place them in the <code>~/.domtool</code> directory.  If you are just testing out a domain temporarily, the configuration files may be placed anywhere. </para><para>By default, this <code>~/.domtool</code> directory is actually a symlink to the <code>~/.public/.domtool</code> directory.  This makes your configuration files readable by anyone, but writable only by you.  If you want to make them private, then do the following. </para><screen><![CDATA[rm ~/.domtool
mkdir ~/.domtool
fs setacl ~/.domtool domtool read
# Do the following two commands if you have any files in ~/.public/.domtool
mv ~/.public/.domtool/* ~/.domtool
rmdir ~/.public/.domtool]]></screen></section><section><title>Running domtool</title><para>In order to activate or test a domain, you must run the <code>domtool</code> command. It can take a long time to run, like many minutes, so have patience. </para><section><title>Testing your configuration</title><para>Running the following command tests your configuration file (here called &quot;MYDOMAIN&quot;) for errors.  Make sure to give the full path to the configuration file, unless you are currently in the same directory as the configuration file. </para><screen><![CDATA[domtool -tc ~/.domtool/MYDOMAIN]]></screen><para>The &quot;-tc&quot; argument means &quot;type-check&quot;. </para><para>It is <emphasis role="strong">highly recommended</emphasis> to store your domtool configuration in a different directory while you are testing it (for example, <code>~/.domtool-test</code>).  The reason for this is that admins sometimes need to regenerate all domtool configuration files, and if any of your files in <code>~/.domtool</code> have errors, none of them will be published.  Once you are done testing, copy the known-good configuration files to <code>~/.domtool</code>. </para></section><section><title>Activating your configuration</title><para>In order to make your changes go live, you need to run domtool without the &quot;-tc&quot; argument, as follows. </para><screen><![CDATA[domtool ~/.domtool/MYDOMAIN]]></screen></section></section><section><title>Further instructions</title><para>The intention of this page was to give you a very quick overview of the <code>domtool</code> command.  To learn about how to create working configuration files, it is essential that you read the <ulink url="https://wiki.hcoop.net/MemberManual/UsingDomtool/DomTool/UserGuide#">Domtool User Guide</ulink>, and also <ulink url="https://wiki.hcoop.net/MemberManual/UsingDomtool/DomTool/Examples#">see some examples</ulink>. </para><!--rule (<hr>) is not applicable to DocBook--><para> <ulink url="https://wiki.hcoop.net/MemberManual/UsingDomtool/CategoryMemberManual#">CategoryMemberManual</ulink> </para></section></article>