File: README

package info (click to toggle)
wfo 0.1-2
  • links: PTS
  • area: main
  • in suites: lenny, squeeze, wheezy
  • size: 1,508 kB
  • ctags: 485
  • sloc: ruby: 1,996; makefile: 66
file content (89 lines) | stat: -rw-r--r-- 1,873 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
= wfo - wiki frontend at offline

== Author

Tanaka Akira <akr@fsij.org>

== License

GPLv2 or later

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

== Home Page

((<URL: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

== Requirements

* ruby 1.8.3 : http://www.ruby-lang.org/
* htree 0.4 : http://raa.ruby-lang.org/project/htree/
* GnuPG : http://www.gnupg.org/

== Download

* latest release: ((<wfo-0.1.tar.gz|URL:wfo-0.1.tar.gz>))

* 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

== 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...]

== Example

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

  % wfo co 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.rb for more information.