Skip to content

Commit cf19f0d

Browse files
Hayao0819Hayao0819
committed
[add] : Added build.sh help
1 parent 1268baf commit cf19f0d

File tree

3 files changed

+51
-52
lines changed

3 files changed

+51
-52
lines changed

‎build.sh‎

Lines changed: 2 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -84,28 +84,7 @@ getclm() { cut -d " " -f "${1}"; }
8484
echo_blank(){ yes " " 2> /dev/null | head -n "${1}" | tr -d "\n"; }
8585

8686
_usage () {
87-
echo "usage ${0} [options] [channel]"
88-
echo
89-
echo "A channel is a profile of AlterISO settings."
90-
echo
91-
echo " General options:"
92-
echo " -b | --boot-splash Enable boot splash"
93-
echo " -e | --cleanup | --cleaning Enable post-build cleaning"
94-
echo " -r | --tarball Build rootfs in tar.xz format"
95-
echo " -h | --help This help message and exit"
96-
echo
97-
echo " -a | --arch <arch> Set iso architecture"
98-
echo " -c | --comp-type <comp_type> Set SquashFS compression type (gzip, lzma, lzo, xz, zstd)"
99-
echo " -g | --gpgkey <key> Set gpg key"
100-
echo " -l | --lang <lang> Specifies the default language for the live environment"
101-
echo " -k | --kernel <kernel> Set special kernel type. See below for available kernels"
102-
echo " -o | --out <out_dir> Set the output directory"
103-
echo " -p | --password <password> Set a live user password"
104-
echo " -t | --comp-opts <options> Set compressor-specific options."
105-
echo " -u | --user <username> Set user name"
106-
echo " -w | --work <work_dir> Set the working directory"
107-
echo
108-
87+
cat "${script_path}/docs/build.sh/help.1"
10988
local blank="29" _arch _dirname _type _output _first
11089
for _type in "locale" "kernel"; do
11190
echo " ${_type} for each architecture:"
@@ -125,36 +104,7 @@ _usage () {
125104
_first=false
126105
done
127106
done
128-
129-
echo
130-
echo " Debug options: Please use at your own risk."
131-
echo " -d | --debug Enable debug messages"
132-
echo " -x | --bash-debug Enable bash debug mode(set -xv)"
133-
echo " --channellist Output the channel list and exit"
134-
echo " --config Load additional config file"
135-
echo " --[no]gitversion Add Git commit hash to image file version"
136-
echo " --logpath <file> Set log file path (use with --log)"
137-
echo " --[no]log (No) log ;re-run script with tee"
138-
echo " --msgdebug Enables output debugging"
139-
echo " --noaur Ignore aur packages (Use only for debugging)"
140-
echo " --nocolor No output colored output"
141-
echo " --[no]confirm (No) check the settings before building"
142-
echo " --nochkver No check the version of the channel"
143-
echo " --nodebug Disable all debug messages"
144-
echo " --noefi No efi boot (Use only for debugging)"
145-
echo " --noloopmod No check and load kernel module automatically"
146-
echo " --[no]depend (No) check package dependencies before building"
147-
echo " --noiso No build iso image (Use with --tarball)"
148-
echo " --nosigcheck No pacman signature check"
149-
echo " --pacman-debug Enable pacman debug mode"
150-
echo " --normwork No remove working dir"
151-
echo " --nopkgbuild Ignore PKGBUILD (Use only for debugging)"
152-
echo " --tar-type <comp_type> Set compression type (gzip, lzma, lzo, xz, zstd)"
153-
echo " --tar-opts <option> Set tar command argument (Use with --tarball)"
154-
echo " --add-module <module> Load additional modules (Separated by \",\")"
155-
echo
156-
echo " Many packages are installed from AUR, so specifying --noaur can cause problems."
157-
echo
107+
cat "${script_path}/docs/build.sh/help.2"
158108
[[ -n "${1:-}" ]] && exit "${1}"
159109
}
160110

‎docs/build.sh/help.1‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
usage build.sh [options] [channel]
2+
3+
A channel is a profile of AlterISO settings.
4+
5+
General options:
6+
-b | --boot-splash Enable boot splash
7+
-e | --cleanup | --cleaning Enable post-build cleaning
8+
-r | --tarball Build rootfs in tar.xz format
9+
-h | --help This help message and exit
10+
11+
-a | --arch <arch> Set iso architecture
12+
-c | --comp-type <comp_type> Set SquashFS compression type (gzip, lzma, lzo, xz, zstd)
13+
-g | --gpgkey <key> Set gpg key
14+
-l | --lang <lang> Specifies the default language for the live environment
15+
-k | --kernel <kernel> Set special kernel type. See below for available kernels
16+
-o | --out <out_dir> Set the output directory
17+
-p | --password <password> Set a live user password
18+
-t | --comp-opts <options> Set compressor-specific options.
19+
-u | --user <username> Set user name
20+
-w | --work <work_dir> Set the working directory
21+

‎docs/build.sh/help.2‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
2+
Debug options: Please use at your own risk.
3+
-d | --debug Enable debug messages
4+
-x | --bash-debug Enable bash debug mode(set -xv)
5+
--channellist Output the channel list and exit
6+
--config Load additional config file
7+
--[no]gitversion Add Git commit hash to image file version
8+
--logpath <file> Set log file path (use with --log)
9+
--[no]log (No) log ;re-run script with tee
10+
--msgdebug Enables output debugging
11+
--noaur Ignore aur packages (Use only for debugging)
12+
--nocolor No output colored output
13+
--[no]confirm (No) check the settings before building
14+
--nochkver No check the version of the channel
15+
--nodebug Disable all debug messages
16+
--noefi No efi boot (Use only for debugging)
17+
--noloopmod No check and load kernel module automatically
18+
--[no]depend (No) check package dependencies before building
19+
--noiso No build iso image (Use with --tarball)
20+
--nosigcheck No pacman signature check
21+
--pacman-debug Enable pacman debug mode
22+
--normwork No remove working dir
23+
--nopkgbuild Ignore PKGBUILD (Use only for debugging)
24+
--tar-type <comp_type> Set compression type (gzip, lzma, lzo, xz, zstd)
25+
--tar-opts <option> Set tar command argument (Use with --tarball)
26+
--add-module <module> Load additional modules (Separated by ",")
27+
28+
Many packages are installed from AUR, so specifying --noaur can cause problems.

0 commit comments

Comments
 (0)