Skip to content

Commit 97cbc01

Browse files
committed
[add] : Added tool documents
1 parent 0962c27 commit 97cbc01

1 file changed

Lines changed: 72 additions & 0 deletions

File tree

tools/README.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Tools
2+
Alter Linuxのビルドに使用する処理をコマンド化したものです。
3+
これらのスクリプトは相互に呼び出したり、`build.sh`から呼び出されたりします。
4+
コマンドラインから実行することも可能です。
5+
6+
## allpkglist.sh
7+
全てのチャンネルのパッケージの一覧を表示します。
8+
`channel.sh`でチャンネルの一覧を取得後、`pkglist.sh`でパッケージ一覧を取得します。
9+
10+
## build_helper.py
11+
GUIのビルドヘルパーです。PyGobjectが必要です。
12+
13+
## channel.sh
14+
チャンネルの一覧や`description.txt`の取得、確認を行います。
15+
詳細は`channel.sh -h`を実行してください。
16+
17+
## clean.sh
18+
作業ディレクトリの削除を行います。
19+
詳細は`clean.sh -h`を実行してください。
20+
21+
## docker-build.sh
22+
DockerでAlterISO3のビルドを行います。
23+
24+
## fullbuiuld.sh
25+
条件に合致する全てのエディションのビルドを行います。
26+
新しいバージョンがリリースされる際のビルドはこのスクリプトが使用されます。
27+
詳細は`fullbuild.sh -h`を実行してください。
28+
29+
## kernel.sh
30+
カーネル設定ファイルの解析とその結果の出力、確認を行います。
31+
詳細は`kernek.sh -h`を実行してください。
32+
33+
## kernel-choice-conf-gen.sh
34+
menuconfigで使用されるスクリプトです。
35+
36+
## keyring.sh
37+
キーリングの追加と削除を行います。
38+
39+
## locale.sh
40+
言語設定ファイルの解析とその結果の出力、確認を行います。
41+
詳細は`locale.sh -h`を実行してください。
42+
43+
## menuconf-to-alterconf.sh
44+
menuconfigで使用されるスクリプトです。
45+
46+
## mkalteriso.sh
47+
mkalterisoのシェルスクリプト実装です。
48+
`--shmkalteriso`が指定されるか`shmkalteriso=true`の場合に使用されます。
49+
詳細は`mkalteriso.sh -h`を実行してください。
50+
51+
## msg.sh
52+
ラベルと色がついたメッセージを出力します。このスクリプトは様々な場所から呼び出されます。
53+
詳細は`msg.sh -h`を実行してください。
54+
55+
## package.py
56+
`package.sh`の代わりに開発されたものです。Pyalpを使用して引数に指定されたパッケージの状態を出力します。
57+
`build.sh`の依存関係チェックに使用されています。
58+
詳細は`package.py -h`を実行してください。
59+
60+
## pkglist.py
61+
指定されたチャンネルのパッケージ一覧を取得します。
62+
詳細は`pkglist.sh`を実行してください。
63+
64+
## testpkg.sh
65+
`allpkglist.sh`で全てのパッケージ一覧を取得後、そのパッケージが公式リポジトリから利用可能かどうかを調べます。
66+
詳細は`testpkg.sh`を実行してください。
67+
68+
## wizard.sh
69+
CLIの対話型のビルド設定ツールです。英語と日本語に対応しています。
70+
依存パッケージの自動インストールやキーリングの自動インストールを行います。
71+
一部のデバッグオプションには対応していません。
72+
詳細は`wizard.sh -h`を実行してください。

0 commit comments

Comments
 (0)