<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Eric</firstname>">
  <!ENTITY dhsurname   "<surname>Lavarde</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>2005-03-16</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>deb@zorglub.s.bawue.de</email>">
  <!ENTITY dhusername  "Eric Lavarde">
  <!ENTITY dhucpackage "<refentrytitle>FREEMIND</refentrytitle>">
  <!ENTITY dhpackage   "freemind">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2003</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>A Java program for creating and viewing mindmaps.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg>no_options</arg>

    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command.</para>

    <para>This manual page was written for the &debian; distribution
      because the original program does not have a manual page.
      Instead, it has documentation as a mindmap (see Help menu in
      FreeMind).</para>

    <para><command>&dhpackage;</command> is a program that allows to create
    and view so-called mindmaps, as well as export them to HTML or different
    image formats.
    It also has a plugin concept to extend its functionality.</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para>This program does not have any option. Just start it!</para>

  </refsect1>
  <refsect1>
    <title>ENVIRONMENT VARIABLES</title>
    <variablelist>
      <varlistentry>
        <term><option>DEBUG</option>
        </term>
        <listitem>
          <para>If  this environment variable is set, freemind gives more
	  information on how it finds its different elements, as well as some
	      other information.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>JAVACMD</option>
        </term>
        <listitem>
          <para>Default value for the java virtual machine (the java command).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>JAVA_BINDIR</option>
        </term>
        <listitem>
          <para>If $JAVACMD is not set, the java virtual machine is searched
              under $JAVA_BINDIR/java.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>JAVA_HOME</option>
        </term>
        <listitem>
          <para>If $JAVACMD and $JAVA_BINDIR are not set, the java virtual
              machine is searched under $JAVA_HOME/bin/java.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>PATH</option>
        </term>
        <listitem>
          <para>If all $JAVA... environment variables fail, the java virtual
              machine command (java) is searched in the $PATH (with which).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>CLASSPATH</option>
	  <option>ADD_JARS</option>
        </term>
        <listitem>
          <para>The $CLASSPATH variable also lets one specify additional jars,
              which is good, if you want to add a new Look&amp;Feel jar (the motif
              one is so ugly...). Alternatively, the content of $ADD_JARS will
              be prepended to $CLASSPATH.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>FREEMIND_BASE_DIR</option>
        </term>
        <listitem>
          <para>Directory where FreeMind searches for its plugins and
	  libraries</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>FILES</title>
    <variablelist>
      <varlistentry>
        <term><option>/etc/freemind/freemindrc</option>
	  <option>~/.freemind/freemindrc</option>
        </term>
        <listitem>
          <para>freemind tries to read its environment variables from
	  /etc/freemind/freemindrc and ~/.freemind/freemindrc,
	  so that specific settings are possible at machine and user level.
	      </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>/usr/bin/java</option>
        </term>
        <listitem>
           <para>If all searches through environment variables fail, the
	   java virtual machine is expected to be /usr/bin/java; if not,
	   freemind exits with an error.
	      </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>
    <para>The online documentation under http://freemind.sf.net/,
    especially the Linux related one under the Wiki page link
    http://freemind.sourceforge.net/wiki/index.php/FreeMind_on_Linux.</para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (but may be used by others).  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the &gnu; General Public License, Version 2 any 
	  later version published by the Free Software Foundation.
    </para>
	<para>
	  On Debian systems, the complete text of the GNU General Public
	  License can be found in /usr/share/common-licenses/GPL.
	</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->


