help.txt

   1
   2     ntch  version 1.0.2.5
   3
   4     This file is part of ntch.
   5
   6     The ntch is free software: you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation, either version 3 of the License, or
   9     (at your option) any later version.
  10
  11     The ntch is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with ntch.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     Contributors
  20
  21     hlhex(SORCE FORGE.JP ID)
  22     takeutch-kemeco(GitHub ID)
  23
  24     Copyright 2013,2014 Akira Ohta (akohta001@gmail.com)
  25
  26 Linux用 2ch専用ブラウザー
  27
  28 -v --version
  29     バージョンを表示します
  30
  31 -h --help
  32     このヘルプを表示します
  33
  34 -r -refresh-screen
  35     冗長な画面更新を行います。
  36     画面がうまく更新されない時に指定しますが、ちらつくかもしれません
  37
  38 -o --out-path
  39     プログラムの作業ファイルを出力するディレクトリを指定します
  40     無指定の時は、実行時のカレントディレクトリの配下にlogディレクトリを
  41     作成して出力します。
  42
  43 -p --pem
  44     pem形式のCAファイルを指定します。未指定時にはカレントディレクトリから
  45     cacert.pemファイルを探します。
  46     ※クラウド拡張（後述）使用時にSSL通信を行う場合に使用します
  47
  48 キーコマンド
  49
  50 全般
  51     j   下移動
  52     k   上移動
  53     space 項目選択
  54     q   終了
  55     c   前画面に戻る
  56     f   ページダウン
  57     b   ページアップ
  58     r   画面リフレッシュ
  59     z   画面構造ツリーを上に移動する
  60             cキーは直前の画面に戻りますがzキーは
  61             例えばお気に入りからスレッドを開いた時にcキーはお気に入り画面に
  62             戻りますが、zキーはスレタイ一覧画面に遷移します
  63             スレタイ一覧画面ではzキーは直前の画面に関係なく板メニューに遷移
  64             します。
  65     :search :se [検索文字列] 全板検索
  66             指定された文字列をキーにして板全体からスレッドを検索します
  67             文字列の指定はオプションで、未指定時には空の全板検索画面に
  68             遷移します
  69     :favorite :f お気に入りの表示
  70     :history  :h 履歴の表示（表示したスレッドの履歴を表示します）
  71
  72
  73 板メニュー
  74     h   左カラムへ移動
  75     l   右カラムへ移動
  76     a   選択中の板をお気に入りに追加
  77
  78 スレタイ一覧
  79     :[数字] 指定されたスレッド番号にカーソル移動
  80     g   最後の行に移動する
  81     h   [数字]で指定する前の表示位置に戻るUNDO
  82     l   hで戻った移動を元に戻すREDO
  83     r   板を更新する
  84     /[検索文字列]   指定文字列の後方検索
  85     ?[検索文字列]   指定文字列の前方検索
  86                     検索文字列は任意で有り、指定しなかった場合
  87                     以前に指定した文字列で検索します
  88                     デフォルトでregex関数に渡されるので
  89                     標準関数の正規表現が使用できます
  90     :s :sort [number|read|unread] スレタイを並べ替えます
  91                     number  スレッド番号順
  92                     read    取得済みスレッド優先
  93                     unread  未読数順
  94                     リソースファイルに初期値を指定出来ます
  95     :d :del [スレ番号 | * ] 指定したスレッドの取得済みログを削除します
  96                     *  表示している板の全ての取得済ログを削除
  97                     スレ番号 以下の2ch形式の番号指定が使えます
  98                     10  - 10番のログを削除
  99                     14,17,20,100 - 指定した4つの番号を削除
 100                     25-50 - 25番から50番までを削除
 101     a   選択中のスレッドをお気に入りに追加
 102
 103 レス一覧
 104     :[数字]         指定されたレス番号にカーソル移動
 105     :[2ch形式の番号 | tree  | t | id | i ]
 106                   [2ch形式の番号] 表示するレス番号を以下の2ch形式で指定できます
 107                         14,17,20,100 - 指定した4つの番号を表示
 108                         25-50 - 25番から50番までを表示
 109                   tree [数字] or t [数字] 指定レス番号が参照しているorされている
 110                         レスのみを表示します。
 111                         数字とtree（もしくはt）の間には空白が必要です
 112                     id [ID] or i [ID] 指定IDを持つレスのみを表示します
 113                         数字とid（もしくはi）の間には空白が必要です
 114     g   最後の行に移動する
 115     h   [数字]で指定する前の表示位置に戻るUNDO
 116             ※  :treeコマンドなどでレス表示をフィルターしている時は、
 117                 フィルターする前の画面に戻ります。
 118     l   hで戻った移動を元に戻すREDO
 119     :w :write スレッドに書き込む為にエディターを起動します
 120         標準でviエディターが立ち上がるので、本分を編集して
 121         保存終了すると書込を行います。無編集、もしくは
 122         本文が無い場合、書込を中止します。
 123         編集テキストの上部に、mail:[メール], name:[名前]
 124         をそれぞれコロン記号の後に指定出来ます。
 125         ※）メール、名前は本文に含まれません。
 126         書込確認、クッキー確認、エラーなどがサーバーから
 127         返された時には、その内容をviエディターで表示します。
 128         内容を確認してエディターを終了して下さい。
 129         書込確認を中止する方法が（現時点で）ないでの
 130         その場合は強制終了して下さい。
 131     r   スレッドを更新する
 132     /[検索文字列]   指定文字列の後方検索
 133     ?[検索文字列]   指定文字列の前方検索
 134                     検索文字列は任意で有り、指定しなかった場合
 135                     以前に指定した文字列で検索します
 136                     デフォルトでregex関数に渡されるので
 137                     標準関数の正規表現が使用できます
 138     :n :new 新規取得スレにジャンプ
 139     :a :autoscroll 自動スクロール
 140                     j,k,f,bキー以外の入力で自動スクロール解除
 141                     k,bキーで反転スクロール
 142
 143 お気に入り一覧
 144     d   選択項目をお気に入りから削除
 145     l   直前に表示したお気に入りを再表示
 146     h   スレッド選択時にそのスレッドの上位の板を表示
 147
 148 履歴一覧
 149     :limit :l [n[,n]]   表示履歴範囲を指定します
 150           例1 :l 50     履歴データーベースの新しいものから50件を取得します
 151           例2 :l 10,30  履歴データーベースの新しいものから10件をスキップして
 152                         30件を取得します
 153           例3 :l        履歴データーベースの直前のスキップ位置に表示範囲数を
 154                         ずらして同じ件数を取得します
 155           SQLの文法では　例1 :l limit 例2 :l offset,limit
 156                         例3  直前のoffsetに直前のlimitを加算して、同じlimit値で
 157                              例2と同様に検索します（次ページの動作）
 158
 159 リソースファイルの設定
 160          実行ユーザーのホームディレクトリに.ntchrcファイルを作成します
 161          項目と設定値を=で繋げて記述します
 162
 163 起動時の画面の指定
 164 未指定            板メニュー
 165 show=favorite     お気に入り画面
 166 show=history      履歴画面
 167
 168 お気に入りの自動更新頻度
 169 auto-update-interval=[数字] ミリ秒で指定（標準値60000msec）
 170
 171 レス画面の自動スクロール速度
 172 auto-scroll-interval=[数字] ミリ秒で指定（標準値500msec）
 173
 174 スレッドタイトル一覧画面の表示順序の初期値
 175 sort=[number | read | unread]
 176         number   レス番号順
 177         read     既読を上に表示
 178         unread   未読数順
 179
 180 行の先頭に # を指定するとその行はコメントとして扱われます
 181
 182 ---------------------------------------------
 183
 184 NCE (ntch cloud extention) クラウド拡張
 185
 186 添付のphpスクリプトをWebサーバーに導入することで、お気に入りや
 187 既読数などの情報を複数端末間で同期することが出来ます。
 188 ※1.0.2.2の段階ではお気に入りの同期のみ対応
 189
 190 用意する物：
 191 　phpスクリプトが実行可能なWebサーバー
 192 　スクリプトから操作できるMySQL
 193
 194 使い方：（サーバー編）
 195 　1.添付のスクリプトをWebサーバーのスクリプトが実行できるディレクトリに
 196 　コピーします
 197 　2.preference.phpを開き、コメントに従ってDBのパスワードや、クライアント
 198 　に渡すサーバーアクセス情報などを記入します
 199 　3.少数のユーザー設定であればpreference.phpに直接ユーザー情報を記入して
 200 　登録することも出来ます
 201 　4.create_table.phpをブラウザーから開きます。成功すれば
 202 　 Initialization Success が表示されます。
 203
 204 使い方：（クライアント編）
 205 　5.実行ユーザーのホームディレクトリに.ntchrcファイルを作成し以下の書式で
 206 　必要な情報を設定します。
 207 例：
 208 rfc2898-salt=abcdefghijklmn
 209 rfc2898-iteration=1001
 210 aes256-pass=passpass
 211 nce-auth-url=https://neetchan.securesite.jp/nc_checkuser.php
 212 nce-id=user1
 213 nce-pass=1234
 214
 215
 216 項目名（暗号化に関する物）
 217
 218 rfc2898-salt        8文字以上の文字列を指定して下さい
 219 rfc2898-iteration   1000以上の数値を10進数で指定します
 220 aes256-pass         任意のパスワードを指定して下さい。
 221
 222 項目名（サーバーログインに関する物）
 223 nce-auth-url        認証スクリプト（nc_checkuser.php）のURL
 224 nce-id              preference.phpで登録したユーザーID
 225 nce-pass            preference.phpで登録したユーザーパスワード
 226
 227 ※複数のプログラムで同期する場合、上記の設定を必ず全く同じにして下さい。
 228 ※認証スクリプトは平文のパスワードを送信しますのでSSL通信を推奨します
 229 　通常の同期処理は認証時に渡される期限付きのトークンを使用して接続します
 230 　但し、nceでのセキュリティはデーターそのものを暗号化することを重視して
 231 　おり、DBのレコード種別と日付を除いてAES256で暗号化しています。
 232 設定が全て完了したら、プログラムを実行します。
 233
 234 クラウドサーバーとの同期はお気に入り編集時に（サーバー側にデータがあれば）
 235 自動的に行われます。
 236 クラウド設定有効時には起動時にクラウドのデータを読み込みます。
 237 現在のお気に入りの内容でクラウドのデータを明示的に更新したい場合は、
 238 お気に入り一覧で、以下のコマンドを入力します
 239 :upload           現在のお気に入りを全てアップロード
 240 :upload board     現在の板のお気に入りをアップロード
 241 :upload thread    現在のスレッドのお気に入りをアップロード
 242