Skip to content

Commit 280feca

Browse files
committed
[update] : Updated jp docs
1 parent 65057f2 commit 280feca

File tree

6 files changed

+28
-24
lines changed

6 files changed

+28
-24
lines changed

default.conf

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -293,21 +293,18 @@ dependence=(
293293
# "archiso"
294294
"arch-install-scripts"
295295
"curl"
296-
"cmake"
297296
"dosfstools"
298297
"git"
299298
"libburn"
300299
"libisofs"
301300
"lz4"
302301
"lzo"
303302
"make"
304-
"ninja"
305303
"pyalpm"
306304
"squashfs-tools"
307305
"libisoburn"
308306
# "lynx"
309307
"xz"
310-
"yay"
311308
"zlib"
312309
"zstd"
313310
"qt5-base"

docs/jp/AUR.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ AlterISO 3ではAURのパッケージをビルドに含めることができま
33

44
## yayについて
55
yayは最も使用されているAURヘルパーです。AlterISOはまず一時的な一般ユーザーを作成した後、yayをmakepkgでビルドしてインストールします。
6+
全てのAURパッケージはyayコマンドを利用してインストールされます。それにより高度な依存関係の解決を行うことができます。
67

78
## AURビルドを無効化する
89
チャンネルの`config.<arch>`かビルド時に`--noaur`を指定することでAURのビルドをスキップできます。
@@ -14,3 +15,4 @@ AURビルドを無効化すると一部のパッケージがインストール
1415
# Do not install the AUR package.
1516
noaur=true
1617
```
18+
AURからのインストールを無効化すると、その後の`PKGBUILD`からのパッケージのインストールのための依存関係をインストールできず、エラーが発生する場合があります。(デフォルトで設定されているCalamaresはAURのパッケージを依存関係に含んでいます。)エラーが発生する場合には`--nopkgbuild`も一緒に指定することでこのエラーを回避できます。

docs/jp/BUILD.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
ビルドは実機のArch Linuxを利用する方法とDocker上でビルドする方法があります。
33
Dockerでビルドする方法は[この手順](DOCKER.md)を参照してください。
44

5-
実機でビルドする場合は、必ずOSがArch LinuxかAlter Linuxでなければなりません。
5+
実機でビルドする場合は、OSがArch LinuxかAlter Linuxでなければなりません。
6+
(Manjaroや他のディストリビューションでも必要なコマンドをインストールすれば理論上は可能ですが動作は保証されません。)
67
以下では実機でビルドする方法を解説します。
78

89
ArchやAlter上で直接ビルドする場合、ビルドはいくつかの方法で行うことができます。
@@ -31,12 +32,7 @@ sudo ./tools/keyring.sh --alter-add --arch32-add
3132
ビルドに必要なパッケージをインストールします。
3233

3334
```bash
34-
sudo pacman -S --needed git make ninja arch-install-scripts squashfs-tools libisoburn dosfstools ninja cmake pyalpm
35-
git clone https://aur.archlinux.org/yay.git
36-
cd yay
37-
makepkg -siAcC
38-
cd ..
39-
rm -rf yay/
35+
sudo pacman -S --needed curl dosfstools git libburn libisofs lz4 lzo make pyalpm squashfs-tools libisoburn xz zlib zstd qt5-base
4036
```
4137

4238
### TUIを使用する
@@ -96,19 +92,20 @@ sudo ./build.sh [options] [channel]
9692

9793
- Plymouthを有効化
9894
- 圧縮方式は`gzip`
99-
- カーネルは`linux-lqx`
95+
- カーネルは`linux-lts`
10096
- パスワードは`ilovearch`
97+
- チャンネルは`xfce`
10198

10299
```bash
103-
./build.sh -b -c "gzip" -k "lqx" -p 'ilovearch' xfce
100+
./build.sh -b -c "gzip" -k "lts" -p 'ilovearch' xfce
104101
```
105102

106103

107104
### 注意事項
108105
#### チャンネルについて
109106
チャンネルは、インストールするパッケージと含めるファイルを切り替えます。
110107
この仕組みにより様々なバージョンのAlter Linuxをビルドすることが可能になります。
111-
2020年8月17日現在でサポートされているチャンネルは以下のとおりです
108+
2021年5月07日現在でサポートされているチャンネルは以下のとおりです
112109
完全なチャンネルの一覧は`./build.sh -h`を参照して下さい。
113110

114111
名前 | 目的
@@ -120,6 +117,7 @@ i3 | i3とカスタマイズ可能なpolybarを搭載したrelengを除いて最
120117
lxde | LXDEと最小限のアプリケーションのみが入っている軽量なチャンネル
121118
plasma | PlasmaとQtアプリを搭載した現在開発中のチャンネル
122119
releng | 純粋なArchLinuxのライブ起動ディスクをビルドできるチャンネル
120+
serene | Serene Linuxを移植したチャンネル
123121
xfce | デスクトップ環境にXfce4を使用し、様々なソフトウェアを追加したデフォルトのチャンネル
124122
xfce-pro | xfceチャンネルのウィンドウマネージャを変更し、多くのソフトを追加したチャンネル
125123

@@ -129,7 +127,7 @@ xfce-pro | xfceチャンネルのウィンドウマネージャを変更し、
129127
また`x86_64`では公式カーネルに加えて以下ようなカーネルをサポートしています。
130128
カーネルの説明は[ArchWiki](https://wiki.archlinux.jp/index.php/%E3%82%AB%E3%83%BC%E3%83%8D%E3%83%AB)を引用しています。
131129
AlterISO3からは非公式なカーネルはyayによりコンパイル、インストールされます。カーネルのコンパイルに時間がかかる場合が有るので注意してください。
132-
この一覧に無いカーネルもサポートしています。完全な一覧は[x86_64のカーネル設定ファイル](/system/kernel-x86_64)を参照してください
130+
この一覧に無いカーネルもサポートしています。完全な一覧は`./build.sh -h`を参照して下さい
133131

134132
名前 | 特徴
135133
--- | ---

docs/jp/CHANNEL.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ AlterISO 2の複数アーキテクチャ対応により大幅に仕様が変更
1111

1212

1313
# ドキュメントの見方
14-
`<arch>`はビルド時のアーキテクチャ名、`<locale>`は言語名、`<ch_name>`はチャンネル名に置き換えてください
14+
`<arch>`はビルド時のアーキテクチャ名、`<locale>`は言語名、`<ch_name>`はチャンネル名、`<md_name>`はモジュール名に置き換えてください
1515

1616

1717
# スクリプトにチャンネルを認識させる
@@ -153,6 +153,9 @@ Plymouthを強制的に無効化したい場合は`exclude`ではなく各チャ
153153

154154
また、`exclude`はパッケージを削除するわけではないため依存関係によってインストールされるパッケージを除外することはできません。
155155

156+
#### additional_exclude_pkg
157+
もしビルドに失敗するなどの理由で一時的にインストールしたくないパッケージが存在する場合、`custom.con`を使用して`additional_exclude_pkg`配列を設定することでそのパッケージのインストールを除外することができます。
158+
156159

157160
### excludeの適用されるタイミング
158161
`exclude`はパッケージが全て読み込まれた後に適用されます。
@@ -191,18 +194,20 @@ PNG形式の画像で640x480の画像を配置してください。この変更
191194
既存のビルド設定を上書きするスクリプトです。かならずシェルスクリプトの構文で記述して下さい。
192195
雛形が`build.sh`と同じ階層に設置してあります。
193196
各チャンネルのディレクトリに配置された設定ファイルは**引数による設定さえ**上書きしてしまうため、最小限の必須項目のみを記述するようしてください。(例えばPlymouthのテーマ名やパッケージ名など)
197+
引数によって変更可能な変数をこのファイルで設定することは推奨されていません。
194198

195199
### 警告
196200
スクリプト内では変数のスコープを明示しないでください。また、変数定義以外の処理を記述すると思わぬ動作につながる場合はあります。
197201

198202

199203
### アーキテクチャごとの設定と優先順位
200-
`channels/<ch_name>/config.any`が読み込まれた後`channels/<ch_name>/config.<arch>`が読み込まれます。
204+
`channels/<ch_name>/config.any`が読み込まれた後`channels/<ch_name>/config.<arch>`が読み込まれます。
205+
このアーキテクチャの優先順位はモジュールにおいても共通です。
201206

202207

203208
## architecture
204209
そのチャンネルで利用可能なアーキテクチャの一覧です。`#`はコメントとして扱われます。
205-
AlterISO 3は現在`x86_64``i686`アーキテクチャのみをサポートしています
210+
チャンネル内でカーネル設定ファイルやpacman設定ファイルなどを適切に設定することでアーキテクチャを独自で定義することも可能です
206211

207212
## kernel_list-<arch>
208213
使用可能なカーネルの一覧を記述します。このファイルが存在しない場合、対応している全てのカーネルを使用可能です。
@@ -229,10 +234,11 @@ rt
229234
`over_isofs`ディレクトリ内でビルドされるISOファイルの`/`にファイルを上書きします。
230235
`airootfs`と似ていますが`over_isofs`ではビルドされるイメージファイル内のファイルを直接操作することができます。
231236
既存のファイルを上書きしてしまうとブートできなくなる可能性があるので注意して下さい。
237+
`over_isofs`はsquashfsの作成が終わった後にisoファイルを作成する直前で上書きされます。
232238

233239
## pkgbuild.any pkgbuild.<arch>
234-
チャンネルディレクトリ内に`pkgbuild.any(arch)/パッケージ名/PKGBUILD`を配置するとmakepkgによってビルドし、インストールされます。
240+
チャンネルディレクトリ内に`pkgbuild.any(arch)/任意のディレクトリ名/PKGBUILD`を配置するとmakepkgによってビルドし、インストールされます。
235241
依存関係もpacmanによって自動的にインストールされますが、注意が必要です。
236242
自動的にインストールされる依存関係はあくまでArch Linuxの公式リポジトリに存在しているものだけです。
237243
依存しているパッケージが一つでもAUR上に存在している場合は、その依存パッケージをAURのパッケージリストに書かなければなりません。
238-
また、PKGBUILDを格納するパッケージ名も他のモジュールなどと重複してはいけません。重複してしまうとディレクトリが上書きされてしまいます
244+
また、PKGBUILDを格納するディレクトリ名は絶対に重複しないようにしてください

docs/jp/CHANNEL_2_to_3.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ AlterISO3では様々な新機能が追加されました。そしてそれと
2121
以前の`japanese`変数は意味を成しません。AlterISO3では言語名を`locale_name`変数で行っています。
2222
特定の言語を強制的に使用させたい場合は、`-l`オプションで指定する言語名を`locale_name`変数で指定して下さい。
2323

24+
### モジュールについて
25+
AlterISO 3.1用に開発する場合はモジュール一覧も定義する必要があります。
26+
詳細は後ほど追記します。
27+
2428
#### 詳細設定を行う
2529
AlterISO3は`locale_name`の値を元にいくつかの変数を`system/locale-<arch>`から参照します。
2630
チャンネルの`config`ファイルでは変数を上書きできるので、これらを詳細に書き換えることができます。

docs/jp/SOFTWARE.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,9 @@ Alter Linuxのリポジトリを使用する場合は鍵を追加する必要が
1313

1414
ソースコード | PKGBUILD
1515
--- | ---
16-
[alterlinux-calamares](https://github.com/FascodeNet/alterlinux-calamares) | [PKGBUILD](https://github.com/FascodeNet/alterlinux-pkgbuilds/tree/master/alter-stable/any/alterlinux-calamares)
16+
[alterlinux-calamares](https://github.com/FascodeNet/alterlinux-calamares) | [PKGBUILD](https://github.com/FascodeNet/alterlinux/tree/noroot/modules/share-extra/pkgbuild.any/alterlinux-calamares)
1717
[alterlinux-fcitx-conf](https://github.com/FascodeNet/alterlinux-fcitx-conf) | [PKGBUILD](https://github.com/FascodeNet/alterlinux-pkgbuilds/tree/master/alter-stable/any/alterlinux-fcitx-conf)
18-
[alterlinux-gtk-bookmarks](https://github.com/FascodeNet/alterlinux-desktop-file/tree/master/alterlinux-gtk-bookmarks) | [PKGBUILD](https://github.com/FascodeNet/alterlinux-pkgbuilds/tree/master/alter-stable/any/alterlinux-gtk-bookmarks)
1918
[alterlinux-i3-manager](https://github.com/FascodeNet/alterlinux-i3-manager) | [PKGBUILD](https://github.com/FascodeNet/alterlinux-pkgbuilds/tree/master/alter-stable/any/alterlinux-i3-manager)
2019
[alterlinux-keyring](https://github.com/FascodeNet/alterlinux-keyring) | [PKGBUILD](https://github.com/FascodeNet/alterlinux-pkgbuilds/tree/master/alter-stable/any/alterlinux-keyring)
21-
[alterlinux-desktop-file](https://github.com/FascodeNet/alterlinux-desktop-file) | [PKGBUILD](https://github.com/FascodeNet/alterlinux-pkgbuilds/tree/master/alter-stable/any/alterlinux-desktop-file)
2220
[alterlinux-mirrorlist](https://github.com/FascodeNet/alterlinux-pkgbuilds/tree/master/alter-stable/any/alterlinux-mirrorlist) | [PKGBUILD](https://github.com/FascodeNet/alterlinux-pkgbuilds/tree/master/alter-stable/any/alterlinux-mirrorlist)
23-
[alterlinux-wallpapers](https://github.com/FascodeNet/alterlinux-pkgbuilds/tree/master/alter-stable/any/alterlinux-wallpapers) | [PKGBUILD](https://github.com/FascodeNet/alterlinux-pkgbuilds/tree/master/alter-stable/any/alterlinux-wallpapers)
24-
[alterlinux-welcome-page](https://github.com/FascodeNet/alterlinux-desktop-file/tree/master/alterlinux-welcome-page) | [PKGBUILD](https://github.com/FascodeNet/alterlinux-pkgbuilds/tree/master/alter-stable/any/alterlinux-welcome-page)
21+

0 commit comments

Comments
 (0)