NIXNOTE2(1)

NAME
NixNote2 - An open source Evernote client.

SYNOPSIS

nixnote2 [command] [options]

DESCRIPTION
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.

COMMANDS

start <options>
    Start NixNote normally. If not specified, this is the default option."

    start options:

        --accountId=<id>
            The ID of the account to use upon startup. Each account has an ID number assigned to it. Look under File/Accounts for a list of accounts. If not specified, it defaults to the last used account.

        --enableIndexing
            Enable background indexing thread. This can be useful in doing a total database reindex, but can also cause performance issues.

        --disableEditing
            Place notes in a read-only mode by default.

        --dontStartMinimized
            Ignore user settings and do not start minimized.

        --forceSystemTrayAvailable
            NixNote will only show a system tray if it can ensure the window manager can handle it. This option forces NixNote to try and show a tray icon.

        --help or -? or --? or help
            Display command line options.

        --openNote=<lid>
            Start NixNote and show this specific note on startup.

        --startMinimized
            Start NixNote in a minimized state by default.

        --syncAndExit
            Do a sync with Evernote and exit NixNote. Synchronize with Evernote. If not running, NixNote will do a sync and exit without showing the GUI.

sync <options>
    Synchronize NixNote with Evernote.

    sync options:

        --accountId=<id>
            The ID of the account to use upon startup. Each account has an ID number assigned to it. Look under File/Accounts for a list of accounts. If not specified, it defaults to the last used account.

shutdown
    If running, ask NixNote to stop.

    shutdown options:

        --accountId=<id>
            The ID of the account to use. Each account has an ID number assigned to it. Look under File/Accounts for a list of accounts. If not specified, it defaults to the last used account.

show_window
    If NixNote is running nad minimized, raise the window.

    show_window options:

        --accountId=<id>
            The ID of the account to use upon startup. Each account has an ID number assigned to it. Look under File/Accounts for a list of accounts. If not specified, it defaults to the last used account.

query <options>
    Query the NixNote database.

    query options:

        --accountId=<id>
            The ID of the account to use upon startup. Each account has an ID number assigned to it. Look under File/Accounts for a list of accounts. If not specified, it defaults to the last used account.

        --search=<search_string>
            Search string. The search syntax is the same as the graphical interface uses to search.

        --delimiter=<delimiter_string>
            Report column separation string. If not specified | is used as the separator.

        --noHeaders
            Do not display column headers with the results.

        --display=<display_string>
            "Output format for the results. This can be customized by using <field><padding><:>"

            Display String Fields:
                %i : Display note identifier.
                %t : Display note title.
                %n : Display notebook name.
                %g : Display the note's tags.
                %c : Display the creation date.
                %u : Display the date the note was last updated.
                %e : Show if the note is synchronized with Evernote.
                %s : Show the source URL.
                %a : Show the author.
                %x : Show if the note has a todo item.
                %r : Show the note's reminder time.
                %v : Show the time the reminder was completed.

            <padding>
                Any numeric number specifying the minimum number of characters for a result.

            <padding>:
                Any numeric number specifying the minimum number of characters for a result. Anything longer than this value is truncated.

readNote <options>
    Read the text contents of a note."

    readNote options:

        --accountId=<id>
            The ID of the account to use upon startup. Each account has an ID number assigned to it. Look under File/Accounts for a list of accounts. If not specified, it defaults to the last used account.

        --id=<id> : The ID of the note to be read.

deleteNote <options>
    Delete a specic note.
    deleteNote options

        --id=<note_id>
            Note ID to delete.

        --noVerify
            Do not perform a verification prior to deleting the note.

        --accountId=<id>
            The ID of the account to use upon startup. Each account has an ID number assigned to it. Look under File/Accounts for a list of accounts. If not specified, it defaults to the last used account.

emailNote <options>
    Email a note. Any attachments will also be sent. In order to use this feature, the SMTP settings must be specified under Edit/Preferences.

    emailNote Options:

        --to:<email_address>
            The recipient of the email. For multiple recipients, use this parameter multiple times."

        --cc:<email_address>
            The carbon copy recipient of the email. For multiple recipients, use this parameter multiple times."

        --bcc:<email_address>
            The blind carbon copy recipient of the email. For multiple recipients, use this parameter multiple times.

        --subject=<subject>
            Subject of the email. If not specified the note title is used.

        --note=<text>
            Additional comments to be added to the beginning of the note

        --ccSelf
            Send a copy to yourself.

        --accountId=<id>
            The ID of the account to use upon startup. Each account has an ID number assigned to it. Look under File/Accounts for a list of accounts. If not specified, it defaults to the last used account.

addNote <options>
    Add a note via the command line.

    addNote options:

        --title=<text>
            The title of the note to be created.

        --notebook=<notebook_name>
            The notebook to place the note into. If no notebook is given, the default notebook is used.

        --tag=<tag_name>
            Assign this particular tag to this note. For multiple tags, use multiple --tag statements. If a tag does not exist it will be created.

        --created=<creation_date>
            The date the note was created. It should be in the format of YYYMMDDTHHMMSSZ where YYYY is the year, MM is the month, DD is the day, HH is the hour, MM is the minute, and SS is the second. For example, 20151201T1302Z would be December 1, 2015 at 1:02pm. All times are GMT time. If omitted, the current date is used.

        --updated=<creation_date>
            The date the note was last updated. It should be in the format of YYYMMDDTHHMMSSZ where YYYY is the year, MM is the month, DD is the day, HH is the hour, MM is the minute, and SS is the second. For example, 20151201T1302Z would be December 1, 2015 at 1:02pm. All times are GMT time. If omitted, the current date is used.

        --updated=<creation_date>
            The date the note was last updated. It should be in the format of YYYMMDDTHHMMSSZ where YYYY is the year, MM is the month, DD is the day, HH is the hour, MM is the minute, and SS is the second. For example, 20151201T1302Z would be December 1, 2015 at 1:02pm. All times are GMT time. If omitted, the current date is used.

        --accountId=<id>
            The ID of the account to use upon startup. Each account has an ID number assigned to it. Look under File/Accounts for a list of accounts. If not specified, it defaults to the last used account.

        --delimiter=<delimiter>
            This is a special string to use within a note. When specified, and a --attachment parameter is specified, this string is where the attachment will appear in the note. If not specified, the default is %%.

        --attachment=<file-path>
            The location of a file to attach in the note. For multiple attachments use the --attachment parameter multiple times. If the character string specified by the --delimiter parameter appears in the note, the delimiter string will be replaced with the attachment. If there is no delimiter, the attachment will be appended to the end of the note.

        --noteText=<note_text>
            The actual text of the note. If not specified the note will be read from stdin. Some limited HTML is supported but not all HTML tags are supported by Evernote.

appendNote <options>
    Append to an existing note.

    appendNote Options:

        --id=<note_id>
            The ID of the existing note to append.

        --noteText="<note_text>"
            The text to add to the existing note. If not specified, input is read from stdin.

        --accountId
            The ID of the account to use. Each account has an ID number assigned to it. Look under File/Accounts for a list of accounts. If not specified, it defaults to the last used account.

export <options>

    export options:

        --accountId=<id>
            The ID of the account to use upon startup. Each account has an ID number assigned to it. Look under File/Accounts for a list of accounts. If not specified, it defaults to the last used account.

        --output=<filename>
            The output file for the exported notes.

        --search="search_string"
            Export notes matching the search criteria.

        --id=""<id_list>"""
            A list of notes ids to export. The list should be separated by spaces if more than one is desired.

        --deleteOnExport
            If set, the exported notes will be deleted when the export is complete.

        --noVerifyDelete
            If "--deleteOnExport" is set, this will disable the verification of the deletes

backup <options>

    backup options

        --accountId=<id>
            The account to backup. Each account has an ID number assigned to it. Look under File/Accounts for a list of accounts. If not specified, it defaults to the last used account.

        --output=<filename>
            Output file for the backup.

import <options>

    import options

        --accountId=<id>
            Account to import into. Each account has an ID number assigned to it. Look under File/Accounts for a list of accounts. If not specified, it defaults to the last used account.

        --input=<filename>
            The file containing the NixNote export (nnex) file.

openNotebook <options>
    If a notebook is closed, open it. This will allow a notebook to be searched or viewed.

    openNotebook options

        --accountId=<id>
            Account owning the notebook you wish to open. Each account has an ID number assigned to it. Look under File/Accounts for a list of accounts. If not specified, it defaults to the last used account.

        --notebook=<notebook_name>
            The notebook to open.

closeNotebook <options>
    If a notebook is open, close it. This will prevent it from being searched or viewed, but not from being synchronized.

    closeNotebook options

        --accountId=<id>
            Account owning the notebook you wish to close. Each account has an ID number assigned to it. Look under File/Accounts for a list of accounts. If not specified, it defaults to the last used account.

        --notebook=<notebook_name>
            The notebook to close.

signalGui <options>
    Signal a running NixNote instance to perform a particular function.

    --show
        Show a hidden or running NixNote.

    --synchronize
        Start a sync with Evernote.

    --shutdown
        Stop NixNote.

    --screenshot
        Take a screenshot.

    --openNote
        Open an existing note. The --id=<id> option must be specified.

    --openExternalNote
        Open an existing note in an external window. The --id=<id> option must be specified.

    --id=<id>
        Id of note to open.

    --newNote
        Create a new note.

    --newExternalNote
        Create a new note in an external window.

    --accountId=<id>
        Account ID containing the note or the account for the new note.

EXAMPLES

nixnote2 start --dontStartMinimized
    Start NixNote but do not start minimized.

nixnote2 sync
    Start NixNote and do a sync with Evernote. When complete the program will end.

nixnote2 query --search="Classwork" --noHeaders --delimiter="<>" --display="%i%n5%t20:%a"
    Query the NixNote database. The results of the search will be displayed without column headings. The individual fields will be separated by a ""<>"". The fields returned are the note ID, the notebook (padded to a minimum of 5 characters), the note title (padded to 20 characters but truncated if longer) and the note's author.

nixnote2 deleteNote id=22
    Delete note 22 from NixNote.

nixnote2 emailNote id=13 --to=foo@bar.com --subject="My email"
    Email note 13 to foo@bar.com. The subject will be ""My email"".

nixnote2 addNote --title="My New Note" --notebook="My Notebook" --tag="Important Stuff" --delimiter="##" --attachment=/home/foo/file1.pdf --attachment=/home/foo/file2.pdf --noteText="This is my note.  The first attachment will appear ## <hr><br>The second attachment will appear at the end, because there is no delimiter tag for it."
    Create a new note. There will be two files attached (one in the middle and one at the end). It will be put in ""My Notebook" and will be tagged as "Important Stuff".

AUTHORS
NixNote2 is developed by Randy Baumgarte <randy@fbn.cx>.

This manual page was written by Vincent Cheng <Vincentc1208@gmail.com> and Randy Baumgarte for the Debian project (and may be used by others).