-## What is a channel
-A channel is an AlterLinux original mechanism that is made so that you can easily switch the files (airootfs) included in the image file, the packages to install, the configuration files, etc.
-This mechanism allows you to easily create an AlterLinux derivative OS.
-Initially it was only possible to switch packages, but now the specifications have changed significantly, and various changes can be made for each channel.
-
-
-The following are channel specifications as of April 14, 2020.
+# What is a channel
+Channel is an AlterLinux original mechanism that is made so that you can easily switch the files (airootfs) to be included in the image file, the packages to install, the configuration files, etc.
+This mechanism allows you to easily create an AlterOS derivative OS.
+Initially it was only possible to switch packages, but now the specifications have changed significantly and various changes can be made for each channel.
+
+
+The following are channel specifications as of May 13, 2020.
-## Let the script recognize the channel
-The conditions for the script to recognize the channel are as follows.
+# Let the script recognize the channel
+The conditions for the script to recognize the channel are as follows.
- There is a channel name directory in `channels`
- The directory is not empty
-The script does not recognize you if you create an empty directory or create it elsewhere.
+The script will not recognize it if you create an empty directory or create it somewhere else.
You can check with `./build.sh -h` to see if the script recognized the channel.
-Channels not displayed in the channel list of the help cannot be used.
+Channels that are not displayed in the Help channel list cannot be used.
-## About channel name
-The channel name is basically a directory name in `channels`.
-All the characters that can be used for the directory name can be used for the channel name, but if you enter a space character or double-byte character, it may not work properly in some environments.
-In addition, it is desirable to keep the channel name within 18 characters because it is handled in the script. (If the number of characters is longer than this, the channel name will not be displayed correctly in the help.)
+# チャンネル名について
+チャンネル名は基本的には`channels`内のディレクトリ名です。
+ディレクトリ名に使用できる全ての文字はチャンネル名に利用することができますが、空白文字や全角文字を入れた場合、一部の環境で正常に動作しない可能性が有ります。
+また、チャンネル名はスクリプト内で扱う関係上、18文字以内にすることが望ましいです。（それ以上の文字数ではヘルプでチャンネル名が正常に表示されません。）
-If the directory name ends in `.add`, the channel name will be the string before .add.
-This is to exclude it from Git management and add your own customized channel.
-Finally, check the channel name that can be used as an argument by executing `./build -h`.
+もしディレクトリ名が`.add`で終了する場合、チャンネル名は`.add`の前の文字列になります。
+これは、Gitの管理から除外し、カスタマイズした独自のチャンネルを追加するためのものです。
+最終的に引数として使用できるチャンネル名は`./build -h`を実行して確認して下さい。
+
+## チャンネル名の重複について
+**チャンネル名が`.add`がついているものといないもので重複しないようにして下さい！**
+`.add`がついているものとついていないものが重複した場合、**`.add`が付いている方が優先**されます。
+`.add`がついていないチャンネルは一切使用不可能になりますのでご注意下さい。
+また、以下の特殊なチャンネルの名前も使用することができません。
-### About duplicate channel names
-**Please DO NOT duplicate the channel name with or without `.add`!**
-Duplicate channel names are not considered in the script and can lead to unexpected behavior.
-In the future, if there are duplicates with and without `.add`, the policy with `.add` will be prioritized.
-Even if you deal with duplicate channel names in the future, the official channel will still be unavailable, so please DO NOT duplicate channel names.
+# 特殊なチャンネル
+いくつかの特殊なチャンネルがあります。これらのチャンネルはスクリプトに組み込まれているため、追加や削除は行なえません。
+## share
+`share`チャンネルは指定されたチャンネルに関わらず使用される共有チャンネルです。
+`share`はその他のチャンネルと同じ構造をしていますが、`share`単体をチャンネルとして指定してビルドすることはできません。
+全てのチャンネルでインストールされる基本パッケージや共通のファイルなどをここに追加します。
+
+## rebuild
+このチャンネルはヘルプには表示されていますがディレクトリの実体はありません。このチャンネルはスクリプトに組み込まれています。
+このチャンネルは作業ディレクトリに生成されたビルドオプションを保存したファイルを読み込み、再ビルドを行うチャンネルです。
+そのため作業ディレクトリが存在しない場合はエラーを出力し正常に機能しません。
-## Specifications of each channel
-The main directories that make up the channel are airootfs and packages.
-The `airootfs` directory overwrites `/` just before installing the package and running mksquashfs.
-The `packages` directory contains a text file that describes the list of packages to install.
-There are several other files that can be used in some cases.
+# それぞれのチャンネルの仕様
+チャンネルを構成する主要なディレクトリは`airootfs`と`packages`です。
+`airootfs`ディレクトリはパッケージをインストールし`mksquashfs`を実行する直前に`/`を上書きします。
+`packages`ディレクトリはインストールするパッケージのリストを記述したテキストファイルを格納します。
+それ以外にも場合によって使用できるファイルがいくつか有ります。
-### airootfs
-Place the file in this directory as `/`. The permissions of all files are inherited as much as possible.
+## airootfsから始まるディレクトリ
+それぞれのディレクトリ内を`/`としてファイルを配置して下さい。全てのファイルの権限はなるべく引き継がれるようになっています。
+
+### airootfs.any
+アーキテクチャに関わらず最初にライブ環境を上書きします。
+
+### airootfs.i686 airootfs.x86_64
+`x86_64`アーキテクチャなら`airootfs.x86_64`が、`i686`なら`airootfs.i686`が使用されます。
+
+### ファイルの重複の優先順位
+各チャンネルと`share`チャンネルのファイルでは各チャンネルのファイルが優先されます。
+また、`airootfs.any`と各アーキテクチャ用のディレクトリでは各アーキテクチャ用のものが優先されます。
+以下は`airootfs`のコピーされる順番を示しています。要約すると左が一番優先されず、右が優先されます。
+
+`share/airootfs.any` -> `share/airootfs.<architecture>` -> `<channel_name>/airootfs.any` -> `<channel_name>/airootfs.<architecture>`
+
-### customize_airootfs.sh
-If the file `/root/customize_airootfs_<channel name>.sh` is placed in `airootfs` of each channel, the build script will be executed after `customize_airootfs.sh` is executed.
-If you want to change the rootfs settings, create this file.
+## customize_airootfs.sh
+各チャンネルの`airootfs`で、`/root/customize_airootfs_<channel_name>.sh`というファイルが配置された場合、ビルドスクリプトは、`customize_airootfs.sh`が実行された後にそのスクリプトを実行します。
+（`customize_airootfs.sh`は`share`チャンネルの`airootfs.any`によって配置されるため、各チャンネルで自由に上書きすることができます。）
+もしrootfsの設定を変更したい場合、このファイルを作成して下さい。
+
+## packagesから始まるディレクトリ
+このディレクトリ内に配置された、ファイル名が`.<architecture>`で終わるがパッケージリストとして読み込まれます。
+1行で1つのパッケージとして扱い、`#`から始まる行はコメントとして扱われます。
-### packages
-Placed in this directory, files with names ending in `.x86_64` will be loaded as a package list.
-Each line is treated as one package, and lines starting with `#` are treated as comments.
+パッケージ名やパッケージリストのファイル名に空白文字や全角文字を含めると正常に動作しない可能性があります。
-If the package name or the file name of the package list includes white space characters or double-byte characters, it may not operate properly.
-Some packages should not be included in the package list.See [here](PACKAGE.md) for details.
+### ディレクトリの種類
+各アーキテクチャごとにパッケージリストを入れるディレクトリがあります。`airootfs`と違ってアーキテクチャの共有はありません。
+例えば`x86_64`アーキテクチャならば`packages.x86_64`が読み込まれます。
-#### Special package list
-As a special package list, there are `jp.x86_64` and `non-jp.x86_64`.
-When Japanese is enabled by the `-j` option, the script will read` jp.x86_64`.
-On the contrary, if Japanese is not enabled, the script will use `non-jp.x86_64`.
+### 特殊なパッケージ
+一部、パッケージリストに記述してはいけないパッケージが有ります。
+詳細は[こちら](PACKAGE.md)を参照して下さい。
-#### Exclusion list
-If you have a package on the `share` channel that you really don't want to install, you can exclude it by creating a file called` exclude` in the `packages` directory and listing the package in it.
-For example, if you don't want to install `alterlinux-calamares` that is always installed by` share`, you can add it by adding the package name to `exclude` of that channel.
-(In that case, delete unnecessary files with customize_airootfs of each channel.)
-The package description method is the same as the package list. Each line is treated as one package, and lines beginning with `#` are treated as comments.
+### 特殊なパッケージリスト
+特殊なパッケージリストとして、`jp.<architecture>`と`non-jp.<architecture>`があります。
+`-j`オプションによって日本語が有効化されている時、スクリプトは`jp.<architecture>`を読み込みます。
+反対に日本語が有効化されていない場合、スクリプトは`non-jp.<architecture>`を使用します。
+
+
+### 除外リスト
+もしあなたが`share`チャンネルのパッケージでどうしてもインストールしたくないパッケージがある場合、各チャンネルの`packages`ディレクトリ内に`exclude`というファイルを作成し、その中にパッケージを記述することでパッケージを除外することができます。
+例えば`share`で必ずインストールされる`alterlinux-calamares`をインストールしたくない場合、そのチャンネルの`exclude`にパッケージ名を追加することでインストールされなくなります。
+（その場合は各チャンネルのcustomize_airootfsで不要なファイルを削除して下さい。）
+パッケージの記述方法はパッケージリストと同様で、1行で1つのパッケージとして扱い、`#`から始まる行はコメントとして扱われます。
+
+除外できないパッケージも存在します。
+スクリプトによって強制的にインストールされるパッケージ（`efitools`など）は除外リストに関係なくインストールされます。
+例えば`exclude`に`plymouth`を記述しても`-b`オプションが有効化された場合は強制的にインストールされます。
+Plymouthを強制的に無効化したい場合は`exclude`ではなく各チャンネルの`config`より`boot_splash`を`false`に固定して下さい。
-Some packages cannot be excluded.
-Packages that are forced to be installed by the script (`efitools` etc.) will be installed regardless of the exclusion list.
+`channels/share/packages/exclude`は、スクリプトによって強制的にインストールされるパッケージの一覧が記述されています。
+これは作業ディレクトリに正確にログを記録し、チャンネルによって使用不可能なパッケージがインストールされるのを防ぐためです。
-`channels / share / packages / exclude` contains a list of packages installed by the above script.
-This is to log accurately in the working directory.
+また、`exclude`はパッケージを削除するわけではないため依存関係によってインストールされるパッケージを除外することはできません。
-### description.txt
-This is a text file that describes the channel. It is placed in `channels/<channel_name>/description.txt`.
-This file is not mandatory. If this file does not exist, the help will say `This channel does not have a description.txt.`.
+### excludeの適用されるタイミング
+`exclude`はパッケージが全て読み込まれた後に適用されます。
+
+パッケージが読み込まれる順番は以下のとおりです、
+`share/packages.<architecture>` -> `<channel_name>/packages.<architecture>`
+
+その後に以下の順番でexcludeが読み込まれ、パッケージが除外されます。
+`share/packages.<architecture>/exclude` -> `<channel_name>/packages.<architecture>`
-It is recommended to write this file on one line. If you need to write multiple lines, it is better to put 19 half-width spaces at the beginning of the second and subsequent lines, considering the layout of the text.
+## description.txt
+これはチャンネルの説明を記述したテキストファイルです。`channels/<channel_name>/description.txt`に配置されます。
+このファイルは必須ではありません。このファイルが無い場合、ヘルプには`This channel does not have a description.txt.`と表示されます。
-### pacman.conf
-Place `channels/<channel_name>/pacman.conf` and use that file at build time. However, since the configuration file after installation is not replaced, put `/etc/pacman.conf` in` airootfs`.
+このファイルは1行で記述することが推奨されています。複数行を記述する必要がある場合、テキストのレイアウトを考えて2行目以降は先頭に19個の半角空白文字を入れたほうが良いでしょう。
+
+## pacman.conf
+`channels/<channel_name>/pacman-<architecture>.conf`を配置すると、ビルド時にそのファイルを使用します。ただし、インストール後の設定ファイルは置き換えないので`airootfs`で`/etc/pacman.conf`を配置して下さい。
-### splash.png
-By placing `channels / <channel_name> / splash.png`, you can change the background of the SYSLINUX boot loader.Place a 640x480 image in PNG format.
+## splash.png
+`channels/<channel_name>/splash.png`を配置すると、SYSLINUXのブートローダの背景を変更することができます。
+PNG形式の画像で640x480の画像を配置してください。
-### config
-Placing `channels / <channel_name> / config` allows you to overwrite the existing build configuration. Be sure to write it in the shell script syntax. The template is placed in the same hierarchy as `build.sh`.
-This configuration file will be overwritten ** even the settings by the argument **, so please describe only the minimum required items. (For example, Plymouth theme name and package name)
-## Special channel
-### share
-There is a special channel, the `share` channel. The `share` channel is a shared channel used regardless of the specified channel.
-Although `share` has the same structure as other channels, it cannot be built by specifying` share` alone as a channel.
-Add here basic packages and common files that will be installed on all channels.
-
-If files are duplicated in `airootfs`, the files in` share` will be overwritten.
-For example, if there is a file with the same location in `share` and` xfce`, the file in `xfce` will be used.
+## config
+既存のビルド設定を上書きするスクリプトです。かならずシェルスクリプトの構文で記述して下さい。
+雛形が`build.sh`と同じ階層に設置してあります。
+この設定ファイルは**引数による設定さえ**上書きしてしまうため、最小限の必須項目のみを記述するようしてください。（例えばPlymouthのテーマ名やパッケージ名など）
-### rebuild
-There is also another `rebuild` channel. This channel is visible in the help, but it is not a directory entity. This channel is embedded in the script.
-This channel is a channel to read the file which saved the build option generated in the working directory and rebuild.
-Therefore, if the working directory does not exist, an error will be output and it will not function properly.
-**This channel is still in alpha. Rebuilding can cause unexpected problems.**
\ No newline at end of file
+## 警告
+スクリプト内ではローカル変数の定義以外を絶対に行わないで下さい。グローバル変数の定義やその他のコマンドの実効は思わぬ動作につながる危険性が有ります。
+
+### アーキテクチャごとの設定と優先順位
+`channels/<channel_name>/config.any`が読み込まれた後`channels/<channel_name>/config.<architecture>`が読み込まれます。
+
+
+## architecture
+そのチャンネルで利用可能なアーキテクチャの一覧です。`#`はコメントとして扱われます。
\ No newline at end of file
OSDN Git Service
