File: freeplane.1.xml

package info (click to toggle)
freeplane 1.7.5-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 35,988 kB
  • sloc: java: 130,441; xml: 2,373; sh: 172; perl: 138; makefile: 30
file content (397 lines) | stat: -rw-r--r-- 12,593 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
<?xml version='1.0'?>

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
	"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

  <!-- 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>September, 15th, 2017</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>FREEPLANE</refentrytitle>">
  <!ENTITY dhpackage   "freeplane">

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

<refentry>

  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <authorgroup>
      <author>
        &dhfirstname;
        &dhsurname;
        &dhemail;
      </author>
      <author>
        <firstname>Felix</firstname>
        <surname>Natter</surname>
        <email>fnatter@gmx.net</email>
      </author>
    </authorgroup>
    <copyright>
      <year>2016</year>
      <holder>&dhusername; and Felix Natter</holder>
    </copyright>
    &dhdate;
  </refentryinfo>

  <refmeta>
    &dhucpackage;
    &dhsection;
    <refmiscinfo class="source">Freeplane &version;</refmiscinfo>
    <refmiscinfo class="manual">User Commands</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>Program for working with Mind Maps.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>freeplane</command>
      <arg><option>-X <replaceable>menukey</replaceable></option></arg>
      <arg><option>-S</option></arg>
      <arg><option>-N</option></arg>
      <arg><option>-h</option></arg>
      <arg><option>-U</option></arg>
      <arg><option>--help</option></arg>
      <arg><replaceable>file1</replaceable></arg>
      <arg><replaceable>file2</replaceable></arg>
      <arg><replaceable>...</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para><command>&dhpackage;</command> is a free and open source software
    application that supports thinking, sharing information and getting
    things done at work, in school and at home. The core of the software is
    tools for mind mapping (also known as concept mapping or information
    mapping) and using mapped information.
    </para>

    <para>
      Occupying the middle ground between an editor and a diagramming tool,
      Freeplane allows the user to add content as quickly and naturally as
      they would in a text editor, yet producing structured content that
      can be manipulated as easily as a diagram.
    </para>

    <para>Features include ordering ideas in nodes and freely positionable
    nodes, connecting nodes, automatic/conditional styles, scripting,
    add-ons, LaTeX, search/filtering, different export features, printing,
    password protection of nodes/maps and more.</para>

    <para>
      See http://freeplane.sourceforge.net/wiki/index.php/Main_Page for a
      full list of applications and features.
    </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 in the
      <application>Help</application> menu and the <command>Freeplane</command> wiki
      (http://freeplane.sourceforge.net/wiki/index.php/Main_Page).
    </para>

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

    <variablelist>

      <varlistentry>
        <term>
          <option>-X <replaceable>menukey</replaceable></option>
        </term>
        <listitem>
          <para>execute menu item with
          key <replaceable>menukey</replaceable>. Use devtools add-on to
          find the menu keys</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-S</option>
        </term>
        <listitem>
          <para>stop after executing menu items</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-N</option>
        </term>
        <listitem>
          <para>set the 'nonInteractive' system property to 'true'</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-U <replaceable>userdir</replaceable></option>
        </term>
        <listitem>
          <para>set the freeplane user config directory</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-h</option>
	        <option>--help</option>
	      </term>
        <listitem>
          <para>Show summary of options.</para>
        </listitem>
      </varlistentry>

    </variablelist>

    <para>You can find more detailed descriptions of all command line options and
      environment variables as well as help for batch execution commands
      (-X/-S/-N) in the Wiki page:
      http://freeplane.sourceforge.net/wiki/index.php/Command-line_options
    </para>

  </refsect1>

  <refsect1>
    <title>ENVIRONMENT VARIABLES</title>

    <variablelist>
      <varlistentry>
        <term>JAVA_OPTS</term>
        <listitem>
          <para>Set Java Properties, e.g. set the freeplane user config
            directory:
            <command>JAVA_OPTS=-Dorg.freeplane.userfpdir=$HOME/.myfp freeplane</command>
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>DEBUG</term>
        <listitem>
          <para>Start Freeplane in debug mode (if you have problems starting):
            <command>DEBUG=true freeplane</command></para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>FREEPLANE_JAVA_HOME</term>
        <listitem>
          <para>Prefix of Java(&gt;=8) installation to use (Freeplane only)</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>JAVA_HOME</term>
        <listitem>
          <para>Prefix of Java(&gt;=8) installation to use (many Java applications)</para>
        </listitem>
      </varlistentry>
      
    </variablelist>

  </refsect1>

    <refsect1>
    <title>NEW FEATURES IN 1.7.x</title>
    <variablelist>
      <varlistentry>
        <term>Full Java11 support, requires Java8</term>
        <listitem>
          <para></para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>Freeplane API</term>
        <listitem>
          <para>There is a comprehensive API layer for manipulation
	  of Freeplane files (supports headless mode)</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>References to other mind maps from formulas and scripts</term>
        <listitem>
	  <para></para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>Node aliases, global nodes, export for selected branches only, URLs like #at(:~someNodeAlias), ...</term>
        <listitem>
	  <para></para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>NEW FEATURES IN 1.6.x</title>
    <variablelist>
      <varlistentry>
        <term>SVG Icons</term>
        <listitem>
          <para>All icons are SVGs, the size can be changed per node
	  via the Tools panel.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>Presentations</term>
        <listitem>
          <para>Very powerful presentations can be created via the
          Tools panel. If you have questions about the usage,
	  post in the discussion forum.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>NEW FEATURES IN 1.5.x</title>
    <para>
      Please open the what's new map: Help-&gt;Whats new in Freeplane 1.5.x.
    </para>
  </refsect1>

  <refsect1>
    <title>NEW FEATURES IN 1.3.x</title>

    <variablelist>
      <varlistentry>
        <term>Docking windows</term>
        <listitem>
          <para>You can rearrange and (un-)dock Mindmap windows.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>LaTeX integration</term>
        <listitem>
          <para>You can make use of LaTeX formulas
          <emphasis>within</emphasis> each node by using a
          <replaceable>\latex </replaceable> prefix or by setting
          Format=LaTeX. Automatic linebreaks as well as syntax highlighting
          is supported.  Read more here:
          http://freeplane.sourceforge.net/wiki/index.php/LaTeX_in_Freeplane
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>Openstreetmap integration</term>
        <listitem>
          <para>You can associate a geographical location with a node. See
          more information in the wiki:
          http://freeplane.sourceforge.net/wiki/index.php/Open_Street_Map_Plugin
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>Scripting and Add-on improvements</term>
        <listitem>
          <para>
            See the list of available add-ons:
            http://freeplane.sourceforge.net/wiki/index.php/Add-ons
          </para>
          <para>
            If you want to get started developing add-ons, post in the forum:
            http://www.freeplane.org/discussion
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>Many more improvements...</term>
        <listitem>
          <para>Please see the changelog at /usr/share/doc/freeplane/changelog.gz.</para>
        </listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1>
    <title>KNOWN ISSUES</title>

    <itemizedlist>
      <listitem>
        <para>There are rendering issues (probably due to OpenJDK),
        i.e. distortions when scrolling horizontally or
        vertically. Possible workarounds are described on a wiki page:
        http://freeplane.sourceforge.net/wiki/index.php/Rendering_Issues</para>
      </listitem>
      <listitem>
        <para>
          Sometimes keypresses get lost when running ibus-daemon:
          https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=714524
        </para>
      </listitem>
      <listitem>
        <para>The Debian package does not include the <emphasis>signed</emphasis> applet code.
        That's why <ulink url="http://www.duckware.com/tech/java-security-clusterfuck.html">most applets won't run</ulink> after creating an applet export from the Debian package.
        You can ask for the signed applet in the open discussion forum:
        http://www.freeplane.org/discussion
        </para>
      </listitem>
      <listitem>
        <para>
        The Freeplane flash export has been excluded, because Debian devs
        (among them the flash compiler package maintainer)
        prefer free technologies. You can ask for the
        'freeplane-flash-browser' deb in the open discussion forum:
        http://www.freeplane.org/discussion
        </para>
      </listitem>
    </itemizedlist>

  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>

    <para>Much documentation is available from the Freeplane wiki
      under http://www.freeplane.org/.</para>
    <para>There is an open discussion forum at
      http://www.freeplane.org/discussion, which is
      the place to ask questions.
    </para>
    <para>
      Report bugs here:
      http://www.freeplane.org/bugs and feature requests here:
      http://www.freeplane.org/requests
    </para>
    <para>
      If you want to contribute to the Freeplane project, join us at
      http://freeplane-developer.996969.n3.nabble.com/ !
    </para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (and 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 or any
      later version published by the Free Software Foundation.
    </para>
    <para>
      On Debian systems, the complete text of the GNU General Public
      License, Version 2 can be found in /usr/share/common-licenses/GPL-2.
    </para>

  </refsect1>
</refentry>