Location: a-k-r / wfo

About

wfo is a offline frontend for wikis and blogs. You can checkout a wiki page to a local file, edit the file, and commit to the page.

Home Page

http://www.a-k-r.org/wfo/

Feature

  • checkout a wiki page as a local file
  • edit the file
  • update the file
  • commit the file to the wiki
  • supported wiki and blog systems:
    • qwikWeb
    • Trac's wiki
    • PukiWiki
    • tDiary

Usage

wfo checkout [-t repo_type] URL [local-filename][.ext]
wfo status [-u] [local-filename...]
wfo update [local-filename...]
wfo commit [local-filename...]
wfo diff [-u] [local-filename...]
wfo workdump [local-filename...]

Requirements

Download

  • latest release: wfo-0.1.tar.gz (sha256)
  • development version in Subversion repository:

    % svn co svn://svn@svn.a-k-r.org/akr/wfo/trunk wfo

Install

% ./configure
% make
% make install

configure option:

--prefix=PREFIX         install files in PREFIX
--with-ruby=PATHNAME    use ruby interpreter specified by PATHNAME

Example

You can edit "SandBox" page on qwik.jp as follows.

% wfo co ((<"http://qwik.jp/SandBox.html"|URL:http://qwik.jp/SandBox.html>))
% vi SandBox.txt
% wfo ci SandBox.txt

Note that you needs TypeKey account. TypeKey username and password should be stored in ~/.keyring/.

Authentication

% mkdir ~/.keyring
% cd ~/.keyring

* TypeKey

    % echo TypeKey typekey-username typekey-password |
      gpg --comment TypeKey -e -a --default-recipient-self > typekey.asc

* HTTP Basic Authentication

    % echo 'canonical-root-url basic "realm" username password' |
      gpg --comment 'canonical-root-url basic "realm"' -e -a --default-recipient-self > service.asc

See KeyRing manual for details.

License

GPLv2 or later

(escape.rb, keyring.rb and mconv.rb is the modified BSD license.)