summaryrefslogtreecommitdiff
path: root/src/backend/f_help.sh
diff options
context:
space:
mode:
Diffstat (limited to 'src/backend/f_help.sh')
-rw-r--r--src/backend/f_help.sh80
1 files changed, 80 insertions, 0 deletions
diff --git a/src/backend/f_help.sh b/src/backend/f_help.sh
new file mode 100644
index 0000000..f8cc605
--- /dev/null
+++ b/src/backend/f_help.sh
@@ -0,0 +1,80 @@
+#!/usr/bin/env bash
+
+export local colorstart="\e[1;49;34m"
+export local colorstop="\e[0m"
+
+showhelp () {
+
+echo -e "\
+"$colorstart"SYNOPSIS"$colorstop"
+ "$colorstart"vasile --option"$colorstop" ["$colorstart"arguments"$colorstop"]
+ "$colorstart"vasile --help"$colorstop"
+
+"$colorstart"DESCRIPTION"$colorstop"
+
+ Vasile is an acronym for ** Versatile Advanced Script for Iso and Latest Enchantments **
+
+"$colorstart"OPTIONS"$colorstop"
+ "$colorstart"--makepkg"$colorstop" ["$colorstart"package(s)"$colorstop"]
+ This option will allow you to build a package or multiple packages in an overlayfs mounted squashfs chroot jail.
+
+ It must be run in the folder where the squashfs chroot jail resides, or else it will fail to mount the squahfs chroot jail and build the package(s).
+
+ The squashfs chroot jail and the md5sum checksum file are hardcored into "$colorstart"libvasile"$colorstop", but you may want to change them to suit your needs.
+
+ You MUST provide package(s) to build as arguments, or else vasile will only mount the chroot jail
+
+ Examples :
+ "$colorstart"vasile --makepkg wine"$colorstop"
+ "$colorstart"vasile --makepkg wine playonlinux q4wine"$colorstop"
+
+ If the package(s) is/are already built, it will not build it/them again (unless newer version(s) is/are available), but install it/them into squahfs chroot jail
+
+ If the package(s) you want to build depends on any already built package(s) it will make use of it/them to satisfy the required dependencies.
+
+ "$colorstart"--makeiso"$colorstop"
+ This option will allow you to build a live iso image based on the squashfs chroot jail.
+
+ It must be run in the folder where the squashfs chroot jail resides, or else it will fail to rsync the contents of it and build the iso image.
+
+ It is not fully automatic, it will only rsync the contents of the squashfs chroot jail, chroot into it, and let you install packages you want into the iso image.
+ There are some predefined package sets available in "$colorstart"/etc/portage/sets"$colorstop". Adjust them to suit your needs.
+
+ It will ALLWAYS use package(s) built with "$colorstart"--makepkg"$colorstop" option. When you are happy with package selection, just exit the chroot environment and
+ the live filesystem will be compressed, live services will be autoenabled, live bootloader autoconfigured and in the end live iso image will be built. You will find
+ a list of predefined live services list hardcoded into "$colorstart"libvasile"$colorstop". Adjust it to suit your needs.
+
+ "$colorstart"--resetmode"$colorstop"
+ This option will allow you to reset the system state. It will remove whole portage tree, overlays and portage configuration files and reset the system profile. Usually
+ you will never want to call this option directly, unless you really really really know what are you doing. It is called automatically when switching to other states.
+
+ !!! WARNING !!! : Never never never leave the system in this state. You will no longer be able to install/remove/upgrade any packages untill you set the system profile,
+ get the portage tree, overlays and configure portage by hand. Or, you can always activate one of the three other supported system states.
+
+ "$colorstart"--binmode"$colorstop"
+ This option will allow you to change the system state to binmode. In this state portage will allways use only binary packages from the binhost. It will fetch a minimal
+ portage tree without any ebuilds in it, but only with portage profiles, metadata and eclass. It will also fetch overlay and portage configuration files, and will adjust
+ "$colorstart"make.conf"$colorstop" for binary only usage. This system state is for those who just meet with the power of Gentoo.
+
+ !!! WARNING !!! : Never never never modify or create any file in "$colorstart"/etc/portage/"$colorstop" in this state.
+
+ "$colorstart"--mixedmode"$colorstop"
+ This option will allow you to change the system state to mixedmode. In this state portage will prefer binary packages from the binhost over ebuilds from the portage tree.
+ It will fetch the full portage tree, the overlay and portage configuration files, and adjust "$colorstart"make.conf"$colorstop" for binary/ebuild usage. Usually you will find this system state
+ useful if you want to install a package not available in the binhost, you want to upgrade a package to a newer version from portage tree or if you wanna rebuild a package
+ with your own useflags.
+
+ !!! WARNING !!! : Never never never modify any file in "$colorstart"/etc/portage/"$colorstop" in this state. If you want to adjust useflags or keywords for a package, you can create a new file
+ e.g.: "$colorstart"100-my.package.use"$colorstop" in "$colorstart"/etc/portage/package.use/"$colorstop" or "$colorstart"100-my.package.keywords"$colorstop" in "$colorstart"/etc/portage/package.keywords/"$colorstop".
+
+ "$colorstart"--srcmode"$colorstop"
+ This option will allow you to change the system state to srcmode. In more clear terms, it will transform your Kogaion/Argent/Redcore system into pure Gentoo. Binary packages
+ from the binhost will be ignored, and you will only install packages building from portage tree using emerge. It will fetch the full portage tree, the overlay and portage
+ configuration files and adjust "$colorstart"make.conf"$colorstop" for ebuild only usage.
+
+ In this system state you can modify whatever you want in "$colorstart"/etc/portage/"$colorstop". You can adjust useflags, keywords, masks, build environment and rebuild the whole system to suit you.
+ You have the full power of Gentoo available only one command away!
+
+ !!! WARNING !!! : Only use this system state if you have a strong knowledge of Gentoo tools e.g.: "$colorstart"emerge, equery, layman, eix, qlist, useflags, keywords, masks"$colorstop". "
+exit 0
+}