index : archinstall32 | |
Archlinux32 installer | gitolite user |
summaryrefslogtreecommitdiff |
author | Anton Hvornum <anton.feeds+github@gmail.com> | 2020-09-30 22:24:57 +0200 |
---|---|---|
committer | Anton Hvornum <anton.feeds+github@gmail.com> | 2020-09-30 22:24:57 +0200 |
commit | a91aea315438e7bc2e52a3d3ffb9f2ab0ca1b8e8 (patch) | |
tree | 3a10e91da8e0e30b5b50ccd86c796329061ae685 /docs/archinstall | |
parent | af92d15e9602359282907da78ca5898bf83a8748 (diff) |
-rw-r--r-- | docs/archinstall/Application.rst | 10 | ||||
-rw-r--r-- | docs/archinstall/Installer.rst | 4 | ||||
-rw-r--r-- | docs/archinstall/Profile.rst | 16 | ||||
-rw-r--r-- | docs/archinstall/general.rst | 90 |
diff --git a/docs/archinstall/Application.rst b/docs/archinstall/Application.rst new file mode 100644 index 00000000..72722362 --- /dev/null +++ b/docs/archinstall/Application.rst @@ -0,0 +1,10 @@ +.. _archinstall.Application: + +archinstall.Application +======================= + +This class enables access to pre-programmed application configurations. +This is not to be confused with :ref:`archinstall.Profile` which is for pre-prgrammed profiles for a wider set of installation sets. + + +.. autofunction:: archinstall.Application diff --git a/docs/archinstall/Installer.rst b/docs/archinstall/Installer.rst index b7d8c8ce..22d73116 100644 --- a/docs/archinstall/Installer.rst +++ b/docs/archinstall/Installer.rst @@ -1,7 +1,7 @@ .. _archinstall.Installer: -Installer -========= +archinstall.Installer +===================== The installer is the main class for accessing a installation-instance. You can look at this class as the installation you have or will perform. diff --git a/docs/archinstall/Profile.rst b/docs/archinstall/Profile.rst new file mode 100644 index 00000000..0f57c68c --- /dev/null +++ b/docs/archinstall/Profile.rst @@ -0,0 +1,16 @@ +.. _archinstall.Profile: + +archinstall.Profile +=================== + +This class enables access to pre-programmed profiles. +This is not to be confused with :ref:`archinstall.Application` which is for pre-prgrammed application profiles. + +Profiles in general is a set or group of installation steps. +Where as applications are a specific set of instructions for a very specific application. + +An example would be the *(currently fictional)* profile called `database`. +The profile `database` might contain the application profile `postgresql`. +And that's the difference between :ref:`archinstall.Profile` and :ref:`archinstall.Application`. + +.. autofunction:: archinstall.Profile diff --git a/docs/archinstall/general.rst b/docs/archinstall/general.rst new file mode 100644 index 00000000..349393de --- /dev/null +++ b/docs/archinstall/general.rst @@ -0,0 +1,90 @@ +.. _archinstall.helpers: + +.. warning:: + All these helper functions are mostly, if not all, related to outside-installation-instructions. Meaning the calls will affect your current running system - and not touch your installed system. + +Profile related helpers +======================= + +.. autofunction:: archinstall.list_profiles + +Packages +======== + +.. autofunction:: archinstall.find_package + +.. autofunction:: archinstall.find_packages + +Locale related +============== + +.. autofunction:: archinstall.list_keyboard_languages + +.. autofunction:: archinstall.search_keyboard_layout + +.. autofunction:: archinstall.set_keyboard_layout + +Services +======== + +.. autofunction:: archinstall.service_state + +Mirrors +======= + +.. autofunction:: archinstall.filter_mirrors_by_region + +.. autofunction:: archinstall.add_custom_mirror + +.. autofunction:: archinstall.insert_mirrors + +.. autofunction:: archinstall.use_mirrors + +.. autofunction:: archinstall.re_rank_mirrors + +.. autofunction:: archinstall.list_mirrors + +Disk related +============ + +.. autofunction:: archinstall.BlockDevice + +.. autofunction:: archinstall.Partition + +.. autofunction:: archinstall.Filesystem + +.. autofunction:: archinstall.device_state + +.. autofunction:: archinstall.all_disks + +Luks (Disk encryption) +====================== + +.. autofunction:: archinstall.luks2 + +Networking +========== + +.. autofunction:: archinstall.getHwAddr + +.. autofunction:: archinstall.list_interfaces + +General +======= + +.. autofunction:: archinstall.log + +.. autofunction:: archinstall.locate_binary + +.. autofunction:: archinstall.sys_command + +Exceptions +========== + +.. autofunction:: archinstall.RequirementError + +.. autofunction:: archinstall.DiskError + +.. autofunction:: archinstall.ProfileError + +.. autofunction:: archinstall.SysCallError
\ No newline at end of file |