Ioan Rogers > App-SimplenoteSync-0.2.0 > simplenotesync

Download:
App-SimplenoteSync-0.2.0.tar.gz

Annotate this POD

Website

View/Report Bugs
Source  

NAME ^

simplenotesync

VERSION ^

version 0.2.0

SYNOPSIS ^

simplenotesync [options] [pathname]

 Options:
   --help     -h           brief help message
   --man                   full documentation
   --version -v            display program and library version
   --debug   -d            write debug output to a logfile in current dir
   --quiet   -q            log nothing
   --email                 email used for simplenote account
   --password              password used for simplenote account
   --no_server_updates     don't modify notes on server
   --no_local_updates      don't modify notes locally
   --edit                  edit a note, preserving xattrs
   --editor                override $ENV{EDITOR}

  [pathname] is the local notes folder to syncronise with. Defaults to $HOME/Notes.
  
  Everything is optional and can be specified in the config file. See manual.

DESCRIPTION ^

simplenotesync provides bidirectional synchronization between the http://simplenoteapp.com// website and a local directory of text files on your computer

WARNING ^

Please note that this software is still in development stages --- I STRONGLY urge you to backup all of your data before running to ensure nothing is lost. If you run simplenotesync on an empty local folder without the net result will be to copy the remote notes to the local folder, effectively performing a backup.

CONFIGURATION ^

TODO x-platform!

simplenotesync can optionally use a config file. Create a file called simplenotesync.ini in your config dir, usually ~/.config.

It is an ini file, supporting the following keys:

  email, password, notes_dir, no_server_updates, no_local_updates, editor

KNOWN ISSUES ^

FAQ ^

Why can I download notes from Simplenote, but local notes aren't being uploaded?

Do the text files end in .txt or .mkdn? These are currently the only two extensions considered.

Text files can't be located in subdirectories - this script does not (by design) recurse folders looking for files (since they shouldn't be anywhere but the specified directory).

TROUBLESHOOTING ^

Running with --debug will put a log in the current directory with lots of useful information. If your filing a bug report, I'd like to see that log!

You can disable writing changes to either the local directory or to the Simplenote web server with "--no_local_updates and --no_remote_updates to protect your data.

SEE ALSO ^

Designed for use with Simplenote:

<http://www.simplenoteapp.com/>

Based on SimplenoteSync:

<http://fletcherpenney.net/other_projects/simplenotesync/>

AUTHORS ^

COPYRIGHT AND LICENSE ^

This software is Copyright (c) 2012 by Ioan Rogers.

This is free software, licensed under:

  The GNU General Public License, Version 2, June 1991

BUGS AND LIMITATIONS ^

You can make new bug reports, and view existing ones, through the web interface at https://github.com/ioanrogers/App-SimplenoteSync/issues.

SOURCE ^

The development version is on github at http://github.com/ioanrogers/App-SimplenoteSync and may be cloned from git://github.com/ioanrogers/App-SimplenoteSync.git

syntax highlighting: