OSDN Git Service

Merge branch 'development' of ssh://baumgarr@nevernote.git.sourceforge.net/gitroot...
[neighbornote/NeighborNote.git] / man / nixnote.1
1 .TH NIXNOTE "1" "January 2011" "nixnote 1.1"
2 .SH NAME
3 NixNote \- An open source Evernote client.
4 .SH SYNOPSIS
5 NixNote is an open source clone of Evernote. Evernote is a collection of software and services that allows users to collect, sort, tag and annotate notes and other miscellaneous information. Data may be stored locally and/or synchronized with Evernote servers so they can be accessed by other clients.
6 .SH OPTIONS
7 .IP "NN_NAME=<name>"
8 The name of this NixNote account. This can be used to create separate NixNote databases. Separate databases do not need to be connected to the same Evernote account.
9 .IP "NN_HOME=<path>" 
10 The default NixNote database is stored in ~/.nevernote. Specifying this value will change where the database 
11 is located.
12 .IP "NN_XMS=<amount>M" 
13 Minimum amount of heap memory (in megabytes). The default is 256M.
14 .IP "NN_XMX=<amount>M"
15 Maximum amount of heap memory (in megabytes). The default is 1024M.
16 .IP "NN_NEW_RATIO=<number>"
17 The ratio between young & old generations. This is used in heap management and garbage collection. The default is 1.
18 .IP "NN_GC_OPT=<value>"
19 This determines how Java garbage collection is performed.  Valid values are -XX:+UseParNewGC, -XX:+UseConcMarkSweepGC, and -XX:+UseParallelGC. The default is -XX:+UseParallelGC and enables parallel garbage collection.
20 .IP "NN_DEBUG=<value>"
21 Used to set Java debug options for problem diagnosis. These values are not normally set.
22
23 .SH AUTHORS
24 NixNote is developed by Randy Baumgarte <randy@fbn.cx>.
25 .PP
26 This manual page was written by Vincent Cheng <Vincentc1208@gmail.com> and Randy Baumgarte for the Debian project (and may be used by others).