diff --git a/README.rst b/README.rst index 83cf1266..ab37040d 100644 --- a/README.rst +++ b/README.rst @@ -1,83 +1,74 @@ -Documentation Build Instructions +Documentation build instructions ################################ -The `website documentation`_ for Clear Linux\* OS for Intel Architecture -should be written in :abbr:`ReStructuredText (ReST)` AKA ``.rst``, which -makes it easy to build parsable, command-line readable, indexed, and -search-friendly documentation and APIs with `Sphinx`_. +.. todo add comment re not using standards here. -.. _requirements: +`Clear Linux\* OS documentation`_ is written using `reStructuredText`_ and +built using `Sphinx`_. Follow the instructions in this README to build the +documentation locally for development and testing. + +Please make yourself familiar with our `contribution guidelines`_ before +submitting a contribution. Requirements -============ +************ -To build documentation with Sphinx, ensure your system has these -prerequisites: +Make sure you have Python and Sphinx installed. We use Python 3 and +Sphinx 1.7.5 -* `GNU make`_ -* `Python`_ -* `PIP`_ -* `Sphinx`_ +The Sphinx documentation provides `instructions for installing Sphinx`_ on various +platforms. -The instructions for installing these varies according to OS. On a basic out- -of-the-box Ubuntu-like OS (which usually has Python installed by default), -check your python version you might need something like: - -.. code-block:: console - - $ sudo apt-get install python-pip - $ sudo pip install -U sphinx sphinx-autobuild - - - -.. code-block:: console - - $ python -c 'print __import__("sphinx").__version__' - 1.3.1 - -Cloning the documentation repository -==================================== - -We have confirmed Sphinx installed. The next step is to clone Gitlab -repository to our local machine. +Clone the documentation repository +********************************** +Once Sphinx is installed, clone the documentation repository to your +local machine. .. code-block:: console $ git clone https://github.com/clearlinux/clear-linux-documentation -Run make -======== +Run the build +************* -Finally are we ready to run :command:`make`. Be sure to :command:`cd` to the -:file:`source/` directory where your ``.rst`` files are, before -running :command:`make html`, or the doc format of your choice. +We build our documentation using Sphinx. In the source directory of your +local clear-linux-documentation repository, build the documentation by running +**make html**: .. code-block:: console $ make html > sphinx-build -b html -d _build/doctrees . _build/html - Running Sphinx v1.3.1 + Running Sphinx v1.7.5 making output directory... . . . build succeeded, 0 warnings. + The HTML pages are in _build/html. + Build finished. The HTML pages are in _build/html. -Open one of the .html pages in a web browser to view the rendered +Open one of the HTML pages in a web browser to view the rendered documentation. -For tips on how to contribute documentation formatted in the .rst style -needed to integrate beautifully on the clearlinux.org website, please see - `Theming Sphinx`_. +When testing changes in the documentation, make sure to remove the previous +build before building again by running **make clean**: +.. code-block:: console -.. _website documentation: https://clearlinux.org/documentation + $ make clean + > + rm -rf _build/* + +This will completely remove the previous build output. + +.. _Clear Linux\* OS documentation: https://clearlinux.org/documentation .. _Sphinx: http://sphinx-doc.org/ -.. _GNU make: https://www.gnu.org/software/make/ -.. _Python: https://www.python.org/ -.. _PIP: https://pypi.python.org/pypi/pip/ -.. _Theming Sphinx: https://github.com/otcshare/tcs-hub/blob/master/theming-sphinx.rst +.. _reStructuredText: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html +.. _contribution guidelines: https://clearlinux.org/documentation/clear-linux/reference/collaboration +.. _instructions for installing Sphinx: https://www.sphinx-doc.org/en/master/usage/installation.html + diff --git a/source/Makefile b/source/Makefile index 9e49b866..cf5be449 100644 --- a/source/Makefile +++ b/source/Makefile @@ -171,10 +171,8 @@ changes: @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." + -$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + python3 scripts/_python/linkcheck/parse-link-check.py $(BUILDDIR)/linkcheck doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest diff --git a/source/clear-linux/get-started/bare-metal-install-beta/bare-metal-install-beta.rst b/source/clear-linux/get-started/bare-metal-install-beta/bare-metal-install-beta.rst index 07cce2a5..0545c003 100644 --- a/source/clear-linux/get-started/bare-metal-install-beta/bare-metal-install-beta.rst +++ b/source/clear-linux/get-started/bare-metal-install-beta/bare-metal-install-beta.rst @@ -28,7 +28,7 @@ Preliminary steps .. note:: - ```` is the latest |CL| auto-numbered release. + is the latest |CL| auto-numbered release. #. Follow your OS instructions to create a bootable USB drive. @@ -36,8 +36,6 @@ Preliminary steps * :ref:`bootable-usb-mac-all` * :ref:`bootable-usb-windows-all` -.. _install-from-live-image: - Install from live image *********************** @@ -48,11 +46,11 @@ USB drive, follow these steps. #. Power on the system. -#. Open the system BIOS setup menu by pressing the F2 key. +#. Open the system BIOS setup menu by pressing the :kbd:`F2` key. .. note:: - Your BIOS setup menu entry point may vary. + Your BIOS setup menu entry point may vary. #. In the setup menu, enable the UEFI boot and set the USB drive as the first option in the device boot order. @@ -69,53 +67,58 @@ Launch the installer #. Select the icon, :guilabel:`Install Clear Linux OS`, shown in Figure 1. .. figure:: figures/bare-metal-install-beta-1.png - :scale: 50 % - :alt: Install Clear Linux OS icon + :scale: 50 % + :alt: Install Clear Linux OS icon - Figure 1: Install Clear Linux OS icon + Figure 1: Install Clear Linux OS icon #. Upon selecting the icon, the installer is launched, as shown in Figure 2. .. figure:: figures/bare-metal-install-beta-2.png - :scale: 50 % - :alt: Clear Linux OS Installer + :scale: 50 % + :alt: Clear Linux OS Installer - Figure 2: Clear Linux OS Installer + Figure 2: Clear Linux OS Installer -.. _minimum-installation-requirements: +.. _incl-bare-metal-beta-start: Minimum installation requirements ********************************* To fulfill minimum installation requirements, complete the -:guilabel:`Required options`. :guilabel:`Advanced options` are optional. Additional user help is described below. +`Required options`_. `Advanced options`_ are optional. .. note:: * The :kbd:`Install` button is only highlighted **after** you complete the - :ref:`required-options-installation`, and after you enter all required - values in submenus of :ref:`required-options-installation` and - :ref:`advanced-options-installation`. + `Required options`_, and after you enter required values in submenus. * You must choose whether or not to participate in :ref:`telemetrics` before you can finish installation. - * You may wish to :ref:`test-network-settings` before you - :ref:`configure-network-interfaces`. Assure that a ``Success`` message is received before installation. + * You may wish to `Test Network Settings`_ before you + `Configure Network Interfaces`_. Assure that a ``Success`` message is received before installation. Main Menu ********* +The |CL| Installer Main Menu appears as shown in Figure 3. -In the |CL| Installer Main Menu, two tabs appear: -:guilabel:`[R] Required options` and :guilabel:`[A] Advanced options`. -Navigate between tabs using the arrow keys or these shortcut keys: +.. figure:: figures/bare-metal-install-beta-3.png + :scale: 100% + :alt: Clear Linux OS Installer Main Menu + + Figure 3: Clear Linux OS Installer Main Menu + +The |CL| Installer Main Menu has two tabs: :guilabel:`[R] Required options` +and :guilabel:`[A] Advanced options`. Navigate between tabs using the arrow +keys or these shortcut keys: * :kbd:`Shift+A` for :guilabel:`[A] Advanced options` * :kbd:`Shift+R` for :guilabel:`[R] Required options` To meet the minimum requirements, enter your choices in the :guilabel:`Required options`. After confirmation, your selections appear -below menu options in the Main Menu, beside the :guilabel:`>>` chevron. +beside the :guilabel:`>>` chevron, below the menu options. Navigation ********** @@ -126,16 +129,6 @@ Navigation * Select :kbd:`Cancel` or :kbd:`Esc` to cancel your choice. - The |CL| Installer Main Menu appears as shown in Figure 3. - - .. figure:: figures/bare-metal-install-beta-3.png - :scale: 100 % - :alt: Clear Linux OS Installer Main Menu - - Figure 3: :guilabel:`Clear Linux OS Installer Main Menu` - -.. _required-options-installation: - Required options **************** @@ -159,10 +152,10 @@ Choose Timezone return to the Main Menu. .. figure:: figures/bare-metal-install-beta-4.png - :scale: 100 % + :scale: 100% :alt: Select System Timezone - Figure 4: :guilabel:`Select System Timezone` + Figure 4: Select System Timezone Choose Language =============== @@ -182,11 +175,10 @@ Choose Language Select :guilabel:`Cancel` to restore the previously defined value and return to the Main Menu. .. figure:: figures/bare-metal-install-beta-5.png - :scale: 100 % + :scale: 100% :alt: Select System Language - Figure 5: :guilabel:`Select System Language` - + Figure 5: Select System Language Configure the Keyboard ====================== @@ -209,10 +201,10 @@ Configure the Keyboard Select :guilabel:`Cancel` to restore the previously defined value and return to the Main Menu. .. figure:: figures/bare-metal-install-beta-6.png - :scale: 100 % + :scale: 100% :alt: Select Keyboard menu - Figure 6: :guilabel:`Select Keyboard menu` + Figure 6: Select Keyboard menu Configure Media =============== @@ -226,10 +218,10 @@ Configure Media #. Navigate to the desired media until highlighted. .. figure:: figures/bare-metal-install-beta-7.png - :scale: 100 % + :scale: 100% :alt: Configure Media menu - Figure 7: :guilabel:`Configure Media menu` + Figure 7: Configure Media menu .. note:: @@ -250,12 +242,10 @@ Configure Media #. Select :kbd:`Enter` to :kbd:`Confirm`. -#. Choose one partitioning option and continue below: +#. Choose one partitioning method and continue below: - * :ref:`auto-partition` - * :ref:`add-partition` - -.. _auto-partition: + * `Auto Partition`_ + * `Add Partition`_ Auto Partition ============== @@ -272,20 +262,40 @@ Auto partition will configure the media to meet the minimum requirements. This action returns you to the Main Menu. .. figure:: figures/bare-metal-install-beta-8.png - :scale: 100 % + :scale: 100% :alt: Auto Partition - Figure 8: :guilabel:`Auto Partition` + Figure 8: Auto Partition -#. You may skip to the :ref:`telemetry-tui` section below. +#. You may skip to the `Telemetry`_ section below. -.. _add-partition: +Disk encryption +=============== + +For greater security, disk encryption is supported using LUKS for all +partitions **except boot** on |CL|. To encrypt a partition, see the example +in `root partition`_ below. Encryption is optional. + +Encryption Passphrase +--------------------- + +|CL| uses a single passphrase for all encrypted partitions. Therefore, if +you turn on encryption for one partition, the same passphrase is used for +all partitions. Additional or different keys may be configured +post-installation using the ``cryptsetup`` tool. + +.. note:: + + During installation, if you encrypt the `root` partition first and the + `swap` partition second, after you select encrypt for `swap`, the + :guilabel:`Encryption Passphrase` dialogue will show the same Passphrase that was assigned to `root`. Select :guilabel:`Confirm` and + press :kbd:`Enter` to use the same Passphrase. Add Partition ============= Minimum requirements -==================== +-------------------- To add partitions manually, assign partitions per the minimum requirements shown in Table 1: @@ -307,6 +317,7 @@ requirements shown in Table 1: - / - *Size depends upon use case/desired bundles.* + #. In the Configure Media menu, select :guilabel:`Add Partition`. .. note:: To change an existing partition, navigate to the partition, @@ -327,10 +338,10 @@ boot partition #. Select :guilabel:`Enter` to confirm. .. figure:: figures/bare-metal-install-beta-9.png - :scale: 100 % + :scale: 100% :alt: boot partition - Figure 9: :guilabel:`boot partition` + Figure 9: boot partition swap partition -------------- @@ -351,10 +362,10 @@ swap partition #. Select :guilabel:`Enter` to continue. .. figure:: figures/bare-metal-install-beta-10.png - :scale: 100 % + :scale: 100% :alt: swap partition - Figure 10: :guilabel:`swap partition` + Figure 10: swap partition root partition -------------- @@ -362,7 +373,39 @@ root partition #. In the :guilabel:`File System` menu, select :kbd:`Up/Down` arrows to select the file system type. See Figure 11. -#. In :guilabel:`Mount Point`, enter ``/root``. + #. Optional: Select :guilabel:`[X] Encrypt` to encrypt the partition. + + .. figure:: figures/bare-metal-install-beta-11.png + :scale: 100% + :alt: Encrypt partition + + Figure 11: Encrypt partition + + + #. The :guilabel:`Encryption Passphrase` dialogue appears. + + .. note:: + + Minimum length is 8 characters. Maximum length is 94 characters. + + .. figure:: figures/bare-metal-install-beta-12.png + :scale: 100% + :alt: Encryption Passphrase + + Figure 12: Encryption Passphrase + + #. Enter the same passphrase in the first and second field. + + #. Navigate to :guilabel:`Confirm` and press :kbd:`Enter`. + + .. note:: + + :guilabel:`Confirm` is only highlighted if passphrases match. + +#. Optional: In :guilabel:`[Optional] Label:`, enter your desired + label for the partition. + +#. In :guilabel:`Mount Point`, enter ``/``. See Figure 11. #. In :guilabel:`Size`, enter an appropriate size per Table 1. @@ -376,28 +419,21 @@ root partition You are returned to the :guilabel:`Configure media` menu. -#. Select :guilabel:`Confirm` to complete the media selection. +#. Select :guilabel:`Confirm` to complete the media selection. See Figure 13. - .. figure:: figures/bare-metal-install-beta-11.png - :scale: 100 % - :alt: root partition +#. You are returned to the :guilabel:`Configure media` menu. Your partitions + should be similar to those shown in Figure 13. - Figure 11: :guilabel:`root partition` - - You are returned to the :guilabel:`Configure media` menu. Your partitions should appear similar to those shown in Figure 12. - - .. figure:: figures/bare-metal-install-beta-12.png - :scale: 100 % + .. figure:: figures/bare-metal-install-beta-13.png + :scale: 100% :alt: Partitions - Figure 12: :guilabel:`Partitions` + Figure 13: Partitions #. Navigate to :guilabel:`Confirm` until highlighted. #. Select :guilabel:`Enter` to complete adding partitions. -.. _telemetry-tui: - Telemetry ========= @@ -413,29 +449,25 @@ For more detailed information, visit our :ref:`telemetry-about` page. #. Select :kbd:`Enter` to confirm. - .. figure:: figures/bare-metal-install-beta-13.png - :scale: 100 % + .. figure:: figures/bare-metal-install-beta-14.png + :scale: 100% :alt: Enable Telemetry - Figure 13: :guilabel:`Enable Telemetry` + Figure 14: Enable Telemetry Skip to finish installation =========================== After selecting values for all :guilabel:`Required options`, you may skip -directly to :ref:`finish-cl-installation` +to `Finish installation`_. -In the Main Menu, select the :guilabel:`Advanced options` if you wish to -configure network interfaces or proxy settings, add bundles, add/manage -users, and more. Continue to the next section. - -.. _advanced-options-installation: +Otherwise, continue below. In the Main Menu, select +:guilabel:`Advanced options` to configure network interfaces or proxy +settings, add bundles, add/manage users, add kernel arguments, and more. Advanced Options **************** -.. _configure-network-interfaces: - Configure Network Interfaces ============================ @@ -459,22 +491,22 @@ interface settings are automatically applied. .. note:: Multiple network interfaces may appear. - .. figure:: figures/bare-metal-install-beta-14.png - :scale: 100 % + .. figure:: figures/bare-metal-install-beta-15.png + :scale: 100% :alt: Configure Network Interfaces - Figure 14: :guilabel:`Configure Network Interfaces` + Figure 15: Configure Network Interfaces #. Notice :guilabel:`Automatic / dhcp` is selected by default (at bottom). Optional: Navigate to the checkbox :guilabel:`Automatic / dhcp` and select :kbd:`Spacebar` to deselect. - .. figure:: figures/bare-metal-install-beta-15.png - :scale: 100 % + .. figure:: figures/bare-metal-install-beta-16.png + :scale: 100% :alt: Network interface configuration - Figure 15: :guilabel:`Network interface configuration` + Figure 16: Network interface configuration #. Navigate to the appropriate fields and assign the desired network configuration. @@ -496,7 +528,7 @@ interface settings are automatically applied. #. Navigate to and select :guilabel:`Main Menu`. -Optional: :ref:`Skip to finish installation `. +Optional: Skip to `Finish installation`_. Proxy ===== @@ -510,11 +542,11 @@ instruction. #. Navigate to the field :guilabel:`HTTPS Proxy`. - .. figure:: figures/bare-metal-install-beta-16.png - :scale: 100 % + .. figure:: figures/bare-metal-install-beta-17.png + :scale: 100% :alt: Configure the network proxy - Figure 16: :guilabel:`Configure the network proxy` + Figure 17: Configure the network proxy #. Enter the desired proxy address and port using conventional syntax, such as: \http://address:port. @@ -524,9 +556,7 @@ instruction. #. To revert to previous settings, navigate to :guilabel:`Cancel` and select :guilabel:`Cancel`. -Optional: :ref:`Skip to finish installation `. - -.. _test-network-settings: +Optional: Skip to `Finish installation`_. Test Network Settings ===================== @@ -534,20 +564,20 @@ Test Network Settings To manually assure network connectivity before installing |CL|, select :guilabel:`Test Network Settings` and select :guilabel:`Enter`. -A progress bar appears as shown in Figure 17. +A progress bar appears as shown in Figure 18. -.. figure:: figures/bare-metal-install-beta-17.png - :scale: 100 % +.. figure:: figures/bare-metal-install-beta-18.png + :scale: 100% :alt: Testing Networking dialogue - Figure 17: :guilabel:`Testing Networking dialogue` + Figure 18: Testing Networking dialogue .. note:: Any changes made to network settings are automatically tested during configuration. -Optional: :ref:`Skip to finish installation `. +Optional: Skip to `Finish installation`_. Bundle Selection ================ @@ -558,19 +588,17 @@ Bundle Selection #. Select :kbd:`Spacebar` to select the checkbox for each desired bundle. - .. figure:: figures/bare-metal-install-beta-18.png - :scale: 100 % + .. figure:: figures/bare-metal-install-beta-19.png + :scale: 100% :alt: Bundle Selection - Figure 18: :guilabel:`Bundle Selection` - -..TODO:Add new screenshot that shows more bundles. + Figure 19: Bundle Selection #. Select :kbd:`Confirm` or :kbd:`Cancel`. You are returned to the :guilabel:`Advanced options` menu. -Optional: :ref:`Skip to finish installation `. +Optional: Skip to `Finish installation`_. User Manager ============ @@ -580,13 +608,13 @@ Add New User #. In Advanced Options, select :guilabel:`User Manager`. -#. Select :guilabel:`Add New User` as shown in Figure 19. +#. Select :guilabel:`Add New User` as shown in Figure 20. - .. figure:: figures/bare-metal-install-beta-19.png - :scale: 100 % + .. figure:: figures/bare-metal-install-beta-20.png + :scale: 100% :alt: Add New User, User Name - Figure 19: :guilabel:`Add New User` + Figure 20: Add New User #. Optional: Enter a :guilabel:`User Name`. @@ -594,11 +622,11 @@ Add New User The User Name must be alphanumeric and can include spaces, commas, or hyphens. Maximum length is 64 characters. - .. figure:: figures/bare-metal-install-beta-20.png - :scale: 100 % + .. figure:: figures/bare-metal-install-beta-21.png + :scale: 100% :alt: User Name - Figure 20: :guilabel:`User Name` + Figure 21: User Name #. Enter a :guilabel:`Login`. @@ -610,7 +638,7 @@ Add New User .. note: - Minimum length is 8 characters. Maximum length is 255 characters. + Minimum length is 8 characters. Maximum length is 255 characters. #. In :guilabel:`Retype`, enter the same password. @@ -621,11 +649,11 @@ Add New User Selecting this option enables sudo privileges for the user. - .. figure:: figures/bare-metal-install-beta-21.png - :scale: 100 % + .. figure:: figures/bare-metal-install-beta-22.png + :scale: 100% :alt: Administrative rights - Figure 21: :guilabel:`Administrative rights` + Figure 22: Administrative rights #. Select :kbd:`Confirm`. @@ -641,15 +669,15 @@ Modify / Delete User -------------------- #. In User Manager, select :guilabel:`Tab` to highlight the user, as shown - in Figure 22. + in Figure 23. #. Select :kbd:`Enter` to modify the user. - .. figure:: figures/bare-metal-install-beta-22.png - :scale: 100 % + .. figure:: figures/bare-metal-install-beta-23.png + :scale: 100% :alt: Modify User - Figure 22: :guilabel:`Modify User` + Figure 23: Modify User #. Modify user details as desired. @@ -666,7 +694,7 @@ Modify / Delete User You are returned to the User Manager menu. -Optional: :ref:`Skip to finish installation `. +Optional: Skip to `Finish installation`_. Kernel Command Line =================== @@ -683,11 +711,11 @@ new kernel. #. To add or remove arguments, choose one of the following options. - .. figure:: figures/bare-metal-install-beta-23.png - :scale: 100 % + .. figure:: figures/bare-metal-install-beta-24.png + :scale: 100% :alt: kernel command line - Figure 23: :guilabel:`kernel command line` + Figure 24: kernel command line #. To add arguments, enter the argument in :guilabel:`Add Extra Arguments`. @@ -696,29 +724,27 @@ new kernel. #. Select :kbd:`Confirm`. -Optional: :ref:`Skip to finish installation `. +Optional: Skip to `Finish installation`_. Kernel Selection ================ #. Select a kernel option. By default, the latest kernel release is - selected. + selected. Native kernel is shown in Figure 25. - .. note:: +#. To select a differnt kernel, navigate to it using :guilabel:`Tab`. - To choose a different kernel, such as Long Term Support (LTS), shown in Figure 24, navigate to it using :guilabel:`Tab`. - - .. figure:: figures/bare-metal-install-beta-24.png - :scale: 100 % + .. figure:: figures/bare-metal-install-beta-25.png + :scale: 100% :alt: Kernel selection - Figure 24: :guilabel:`Kernel selection` + Figure 25: Kernel selection #. Select :kbd:`Spacebar` to select the desired option. #. Select :kbd:`Confirm`. -Optional: :ref:`Skip to finish installation `. +Optional: Skip to `Finish installation`_. Swupd Mirror ============ @@ -731,13 +757,13 @@ If you have your own custom mirror of |CL|, you can add its URL. #. Select :kbd:`Confirm`. - .. figure:: figures/bare-metal-install-beta-25.png - :scale: 100 % + .. figure:: figures/bare-metal-install-beta-26.png + :scale: 100% :alt: Swupd Mirror - Figure 25: :guilabel:`Swupd Mirror` + Figure 26: Swupd Mirror -Optional: :ref:`Skip to finish installation `. +Optional: Skip to `Finish installation`_. Assign Hostname =============== @@ -752,18 +778,18 @@ Assign Hostname alphanumeric character but may also contain hyphens. Maximum length of 63 characters. - .. figure:: figures/bare-metal-install-beta-26.png - :scale: 100 % + .. figure:: figures/bare-metal-install-beta-27.png + :scale: 100% :alt: Assign Hostname - Figure 26: :guilabel:`Assign Hostname` + Figure 27: Assign Hostname #. Navigate to :kbd:`Confirm` until highlighted. #. Select :kbd:`Confirm`. -Optional: :ref:`Skip to finish installation `. +Optional: Skip to `Finish installation`_. Automatic OS Updates ==================== @@ -775,16 +801,14 @@ follow the onscreen instructions. #. Select the desired option. - .. figure:: figures/bare-metal-install-beta-27.png - :scale: 100 % + .. figure:: figures/bare-metal-install-beta-28.png + :scale: 100% :alt: Automatic OS Updates - Figure 27: :guilabel:`Automatic OS Updates` + Figure 28: Automatic OS Updates You are returned to the :guilabel:`Main Menu`. -.. _finish-cl-installation: - Finish installation ******************* @@ -793,7 +817,7 @@ Finish installation .. note:: - Whenever installation is finished, a ``reboot`` button appears. + When installation is finished, a ``reboot`` button appears. #. Select ``reboot``. @@ -803,6 +827,11 @@ Finish installation You have successfully installed |CL| on bare metal using the new installer. +Next steps +********** + +:ref:`enable-user-space` + .. _Navigate to the image directory: https://download.clearlinux.org/image/ .. _Autoproxy: https://clearlinux.org/features/autoproxy .. _telemetry: https://clearlinux.org/features/telemetry diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-10.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-10.png index 66fbdfd9..888b9c2a 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-10.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-10.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-11.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-11.png index 75fb4a89..9a6b61c7 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-11.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-11.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-12.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-12.png index 96471d91..89ca1936 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-12.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-12.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-13.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-13.png index 3850e6b6..6ac1f059 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-13.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-13.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-14.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-14.png index 52444039..3e7fbb8a 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-14.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-14.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-15.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-15.png index d67b1cef..1eaa499e 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-15.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-15.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-16.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-16.png index 682427ad..d2c2a031 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-16.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-16.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-17.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-17.png index 853d1c9f..7e1d6cc9 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-17.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-17.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-18.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-18.png index f5b3c725..4948cbe6 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-18.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-18.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-19.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-19.png index d12f6e17..720d06dd 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-19.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-19.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-20.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-20.png index 0ed795ed..39f9a644 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-20.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-20.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-21.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-21.png index 63540471..0ce16ab7 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-21.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-21.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-22.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-22.png index 1a1e69ab..3a028f4e 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-22.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-22.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-23.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-23.png index 75efb1a4..f7fe354f 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-23.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-23.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-24.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-24.png index ab197a44..02a5cc26 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-24.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-24.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-25.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-25.png index 0694faf3..e726b95e 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-25.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-25.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-26.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-26.png index 21ec0031..9e1b42d5 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-26.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-26.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-27.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-27.png index c76ee8f1..14dec55a 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-27.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-27.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-28.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-28.png new file mode 100644 index 00000000..4e3acf29 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-28.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-3.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-3.png index 4cdc59d7..21121e06 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-3.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-3.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-4.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-4.png index 62950c98..dcce7ec9 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-4.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-4.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-5.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-5.png index f06d6aed..dac8525d 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-5.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-5.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-6.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-6.png index e01f71a0..a9b249b6 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-6.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-6.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-7.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-7.png index dfc59890..75d7898a 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-7.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-7.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-8.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-8.png index cc5b10b9..267278b4 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-8.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-8.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-9.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-9.png index 5134a989..0dca46e6 100644 Binary files a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-9.png and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-9.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst b/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst index 560e56e3..47cd92c1 100644 --- a/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst +++ b/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst @@ -1,36 +1,46 @@ .. _bare-metal-install: -Install |CL-ATTR| on bare metal (automatic) -########################################### +Install |CL-ATTR| on bare metal +############################### These instructions guide you through the installation of |CL-ATTR| on bare metal using a bootable USB drive. -Before you begin, check that your system meets the requirements to install |CL|: +.. contents:: + :local: + :depth: 1 + +System requirements +******************* + +Assure that your target system supports the installation: * :ref:`system-requirements` * :ref:`compatibility-check` - Download the latest |CL| installer image **************************************** -Get the latest |CL| installer image from the `image`_ directory. -Look for the :file:`clear-[version number]-installer.img.xz` file. You can also use this command: +Get the latest |CL| installer image from the `downloads page`_. See Figure 1. +Look for the :file:`clear-[version number]-installer.img.xz` file. + +.. figure:: figures/bare-metal-install-1.png + :scale: 50% + :alt: Visit Downloads + + Figure 1: Visit Downloads + +Optionally, you can use this command: .. code-block:: bash curl -O https://download.clearlinux.org/image/$(curl https://download.clearlinux.org/image/latest-images | grep "installer") -Once you have downloaded the image, verify and decompress the file. +#. Follow your OS instructions to create a bootable USB drive. -.. include:: ../../guides/maintenance/download-verify-decompress-linux.rst - :Start-after: incl-decompress-image: - :end-before: incl-decompress-image-end: + * :ref:`bootable-usb-beta-all` -.. include:: ../bootable-usb/bootable-usb-linux.rst - :Start-after: copy-usb-linux: - :end-before: usb-next +#. After downloading the image, verify and decompress the file per your OS. .. _install-on-target: @@ -57,269 +67,21 @@ Follow these steps to install |CL| on the target system: #. Reboot the target system. -#. The |CL| boot menu will start as shown in figure 1. - Select :guilabel:`Clear Linux OS` and press the - :kbd:`Enter` key or wait five seconds to automatically select it. - - .. figure:: figures/bare-metal-install-1.png - :scale: 50 % - :alt: Boot menu - - Figure 1: :guilabel:`Boot menu` - -#. This will take you into the |CL| installer menu as shown in figure 2 and explains how to - navigate through the |CL| installer setup menus. +#. This action launches the |CL| installer boot menu, shown in figure 2. .. figure:: figures/bare-metal-install-2.png - :scale: 50 % - :alt: Installer menu + :scale: 100% + :alt: Clear Linux OS Installer boot menu - Figure 2: :guilabel:`Installer menu` + Figure 2: Clear Linux OS Installer boot menu - Press the :kbd:`Enter` key. +#. With :guilabel:`Clear Linux OS` highlighted, select :kbd:`Enter`. -#. The :guilabel:`Keyboard selection` menu shown in figure 3 allows you to set - up the keyboard layout that you will be using to navigate within the |CL| - installer setup menus. +Your system will display the |CL| Installer. - .. figure:: figures/bare-metal-install-3.png - :scale: 50 % - :alt: Keyboard Selection +.. include:: ../bare-metal-install-beta/bare-metal-install-beta.rst + :start-after: incl-bare-metal-beta-start: - Figure 3: :guilabel:`Keyboard Selection` - For this guide we will select :menuselection:`Keyboard Selection --> - < * us >` for the keyboard mapping, which should already be highlighted. - Press the :kbd:`Enter` key to continue to the next menu. - -Network requirements -==================== - -The :guilabel:`Network Requirements` menu, the first step of the |CL| -installer setup process, will attempt to connect to the |CL| update server -where the installer image is located. Once the connection to the |CL| update -server is established, you will see a screen similar to the one shown in -figure 4. - -.. figure:: figures/bare-metal-install-4.png - :scale: 50 % - :alt: Network Requirements - - Figure 4: :guilabel:`Network Requirements` - -If you need to configure any :guilabel:`Proxy Settings` to gain access to the -update server, enter the appropriate address and port of your proxy server in -the :guilabel:`HTTPS proxy:` field. Select the :guilabel:`< Set proxy -configuration >` button and press :kbd:`Enter`. You will then see the -connection to the update server established. - -Optionally, set up a :guilabel:`static IP configuration` to your |CL| -installer image. Enter the required information in the :guilabel:`Interface`, -:guilabel:`IP address`, :guilabel:`Subnet mask`, :guilabel:`Gateway` and -:guilabel:`DNS` fields and then select the :guilabel:`< Set static IP -configuration >` button and press the :kbd:`Enter` key. - -The information displayed in the lower right quadrant of the screen shows the -current IP configuration for the |CL| update server where the installer image -is located. - -.. note:: - - If you are having difficulty establishing a connection to the update server - and you see the message :guilabel:`none detected, install will fail`, you - can press the :kbd:`Tab` key to highlight the :guilabel:`< Refresh >` - button and press :kbd:`Enter` to attempt to reconnect to the |CL| update - server. If this fails to establish a connection after multiple attempts, - reboot your system and return to this step. - -Once the connection to the |CL| udpate server is established, use the -:kbd:`Tab` key to advance to the :guilabel:`< Next >` button and press -:kbd:`Enter` to advance to the next |CL| installer setup menu. - -Choose |CL| installer action -============================ - -The :guilabel:`Choose Action` menu is where you can choose to install, repair, -open a shell, or exit the |CL| installer. This menu is shown in figure 5. - -.. figure:: figures/bare-metal-install-5.png - :scale: 50 % - :alt: Choose Action - - Figure 5: :guilabel:`Choose Action` - -#. Select the :menuselection:`Choose action --> Install` menu item to continue - the installation process. - - The :menuselection:`Choose action --> Repair` menu option will run the - :command:`swupd --fix` command to correct any issues found with the system - software that has already been installed on your system and correct any - issues found by overwriting the incorrect file content, adding missing - files, fixing permissions and any additional changes required to return the - file to it's original content and permissions. - - The :menuselection:`Choose action --> Shell` menu item opens a terminal - session on your system as the root user and you will be able to manage your - system from this console. When you are finished, type :command:`exit` to - return to the :guilabel:`Choose Action` menu. - - The :menuselection:`Choose action --> Exit` menu option terminates the |CL| - installation process and the system will shut down. - -#. You will be prompted to join the :guilabel:`Stability Enhancement Program` - as shown in figure 6. Press the :kbd:`Spacebar` or :kbd:`Enter` key until - the cursor appears in the :guilabel:`[ ] Yes.` button. Press tab to highlight :guilabel:`< Next >`, and select Enter to advance. - - .. figure:: figures/bare-metal-install-6.png - :scale: 50 % - :alt: Stability Enhancement Program - - Figure 6: :guilabel:`Stability Enhancement Program` - - If you choose not to enable this functionality during this step, you can - install the ``telemetrics`` software bundle at a later time. As stated in - the menu, this feature only collects anonymous information about your - system to help improve system stability and no personally identifiable - information is collected. Please visit our website to - `learn more about telemetry.`_ - -Choose |CL| installation type -***************************** - -Figure 7 shows the next step of the |CL| installer: -:guilabel:`Choose installation Type`. Chose whether to install |CL| -**automatically** or **manually**. To end the installer process and shut down -the system, select the :guilabel:`< Exit >` button. - -.. figure:: figures/bare-metal-install-7.png - :scale: 50 % - :alt: Choose installation type - - Figure 7: :guilabel:`Choose installation Type` - -If you select :guilabel:`< Automatic >` as the installation type, the |CL| -Installer will add the minimum amount of functionality required for a fully -functional |CL| system. You will not be able to modify the disk layout, add -a user or any other tasks that the manual installation process will allow. - -With the :guilabel:`< Manual(Advanced) >` option, you can do the following -additional tasks during |CL| Installer setup: - -* Modify the disk layout using the cgdisk utility. -* Add additional command-line parameters to the kernel. -* Create a hostname for your system. -* Create an administrative user. -* Add additional software bundles to enhance the functionality of your initial - |CL| installation. -* Optionally, set up a static IP address for your system. - -If you want to perform any of these additional tasks, select the -:guilabel:`< Manual(Advanced) >` menu item and follow the steps in our -:ref:`bare-metal-manual-install` to complete the |CL| manual installation -process. Otherwise, you can follow the |CL| automatic installation steps. - -|CL| automatic installation -*************************** - -#. To install the minimum components for your |CL| implementation, select the - :guilabel:`< Automatic >` menu item shown in figure 7 and press the - :kbd:`Enter` key. - - The :guilabel:`Choose target device for installation` screen shown in figure 8 appears. - -#. Move the cursor to the desired target and press the :kbd:`Enter` - key. - - .. figure:: figures/bare-metal-install-8.png - :scale: 50 % - :alt: Choose target device for installation - - Figure 8: :guilabel:`Choose target device for installation` - - In this example, we selected the single primary partition from our hard drive. - - With all the |CL| installer setup information gathered for the automatic - installation option, the |CL| Installer prompts you to begin the actual - installation as shown in figure 9. - - .. figure:: figures/bare-metal-install-9.png - :scale: 50 % - :alt: Begin installation - - Figure 9: :guilabel:`Begin installation` - -#. When you are satisfied with the information you have entered, select the - :guilabel:`< Yes >` button and press :kbd:`Enter` to begin installing |CL|. - - |CL| Installation begins and each step shows its status as it progresses - through the automated installation process. - - Once all steps have completed, you will see the :guilabel:`Successful - installation` status message and the :guilabel:`< Ok >` button is highlighted as shown in figure 10. - -#. Press the :kbd:`Enter` key to continue. - - .. figure:: figures/bare-metal-install-10.png - :scale: 50 % - :alt: Installation complete - - Figure 10: :guilabel:`Installation complete` - - Figure 11 shows the final installer screen, showing that the - installation completed successfully and the system will reboot. - -#. Press the :kbd:`Enter` key and remove the USB media while the system - restarts. - - .. figure:: figures/bare-metal-install-11.png - :scale: 50 % - :alt: Successful installation - - Figure 11: :guilabel:`Successful Installation` - -Set up your root account -======================== - -Once the |CL| installation is complete and the system boots, a full screen -console requests your login as shown in figure 12: - -.. figure:: figures/bare-metal-install-12.png - :scale: 50 % - :alt: Login screen - - Figure 12: :guilabel:`Login screen` - -#. At the initial login prompt, enter: ``root`` - -#. Once prompted, enter a new password. - -#. Re-enter the password to verify it. - -You have now set your root password and are logged in with root privileges. - -**Congratulations!** - -You have successfully installed |CL| on a bare metal system using the -automatic installation method and set the password for the ``root`` user. - -Next steps -********** - -The automatic installation of |CL| is designed to install with minimal -software overhead. Some housekeeping and package installations could be -needed before you can take full advantage of the |CL| operating system. - -See the :ref:`enable-user-space` guide for additional information and -instructions. - - -.. _`information about stateless`: - https://clearlinux.org/features/stateless - -.. _`learn more about telemetry.`: - https://clearlinux.org/features/telemetry - -.. _`NUC6i5SYH product page`: - http://www.intel.com/content/www/us/en/nuc/nuc-kit-nuc6i5syh.html - -.. _image: https://download.clearlinux.org/image +.. _Autoproxy: https://clearlinux.org/features/autoproxy +.. _downloads page: https://clearlinux.org/downloads \ No newline at end of file diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-1.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-1.png index f38b5413..3b5f1d4e 100644 Binary files a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-1.png and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-1.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-10.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-10.png deleted file mode 100644 index b0cb9b0b..00000000 Binary files a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-10.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-11.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-11.png deleted file mode 100644 index b0cc483f..00000000 Binary files a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-11.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-12.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-12.png deleted file mode 100644 index 34e676a1..00000000 Binary files a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-12.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-2.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-2.png index 94be46fe..2e94163e 100644 Binary files a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-2.png and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-2.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-3.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-3.png deleted file mode 100644 index 4f6c3bb3..00000000 Binary files a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-3.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-4.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-4.png deleted file mode 100644 index 1d4c4a50..00000000 Binary files a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-4.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-5.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-5.png deleted file mode 100644 index 217690c2..00000000 Binary files a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-5.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-6.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-6.png deleted file mode 100644 index 2d879976..00000000 Binary files a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-6.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-7.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-7.png deleted file mode 100644 index 9515eb20..00000000 Binary files a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-7.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-8.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-8.png deleted file mode 100644 index 0a0b3e25..00000000 Binary files a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-8.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-9.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-9.png deleted file mode 100644 index 35911d99..00000000 Binary files a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-9.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-1.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-1.png new file mode 100644 index 00000000..e3c8ff31 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-1.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-10.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-10.png new file mode 100644 index 00000000..888b9c2a Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-10.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-11.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-11.png new file mode 100644 index 00000000..9a6b61c7 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-11.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-12.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-12.png new file mode 100644 index 00000000..89ca1936 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-12.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-13.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-13.png new file mode 100644 index 00000000..6ac1f059 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-13.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-14.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-14.png new file mode 100644 index 00000000..3e7fbb8a Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-14.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-15.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-15.png new file mode 100644 index 00000000..1eaa499e Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-15.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-16.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-16.png new file mode 100644 index 00000000..d2c2a031 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-16.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-17.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-17.png new file mode 100644 index 00000000..7e1d6cc9 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-17.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-18.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-18.png new file mode 100644 index 00000000..4948cbe6 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-18.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-19.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-19.png new file mode 100644 index 00000000..720d06dd Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-19.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-2.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-2.png new file mode 100644 index 00000000..d3d4cbb6 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-2.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-20.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-20.png new file mode 100644 index 00000000..39f9a644 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-20.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-21.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-21.png new file mode 100644 index 00000000..0ce16ab7 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-21.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-22.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-22.png new file mode 100644 index 00000000..3a028f4e Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-22.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-23.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-23.png new file mode 100644 index 00000000..f7fe354f Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-23.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-24.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-24.png new file mode 100644 index 00000000..02a5cc26 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-24.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-25.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-25.png new file mode 100644 index 00000000..e726b95e Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-25.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-26.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-26.png new file mode 100644 index 00000000..9e1b42d5 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-26.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-27.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-27.png new file mode 100644 index 00000000..14dec55a Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-27.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-28.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-28.png new file mode 100644 index 00000000..4e3acf29 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-28.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-3.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-3.png new file mode 100644 index 00000000..21121e06 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-3.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-4.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-4.png new file mode 100644 index 00000000..dcce7ec9 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-4.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-5.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-5.png new file mode 100644 index 00000000..dac8525d Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-5.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-6.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-6.png new file mode 100644 index 00000000..a9b249b6 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-6.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-7.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-7.png new file mode 100644 index 00000000..75d7898a Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-7.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-8.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-8.png new file mode 100644 index 00000000..267278b4 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-8.png differ diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-9.png b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-9.png new file mode 100644 index 00000000..0dca46e6 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-install-beta-9.png differ diff --git a/source/clear-linux/get-started/bare-metal-manual-install/bare-metal-manual-install.rst b/source/clear-linux/get-started/bare-metal-manual-install/bare-metal-manual-install.rst deleted file mode 100644 index d5849e12..00000000 --- a/source/clear-linux/get-started/bare-metal-manual-install/bare-metal-manual-install.rst +++ /dev/null @@ -1,288 +0,0 @@ -.. _bare-metal-manual-install: - -Install |CL-ATTR| on bare metal (manual) -############################################# - -This section contains the steps for a |CL-ATTR| manual installation. It -picks up where the :ref:`bare-metal-install` left off. - -To perform additional tasks during the |CL| Installer setup, select the -:guilabel:`< Manual(Advanced) >` menu option (figure 1). - -* :ref:`Modify the disk layout using the cgdisk utility` -* Add additional command-line parameters to the kernel -* Create a hostname for your system -* Create an administrative user -* Add additional software bundles to enhance the functionality of your - initial |CL| installation -* Optionally set up a static IP address for your system - -Begin the manual installation process -************************************* - -#. Move the cursor to the :guilabel:`< Manual(Advanced) >` menu item - and press the :kbd:`Enter` key. - - .. figure:: figures/bare-metal-manual-install-1.png - :scale: 50 % - :alt: Choose installation Type - - Figure 1: :guilabel:`Choose installation Type` - -#. The screen :guilabel:`Choose partitioning method` will - appear (figure 2). - - .. figure:: figures/bare-metal-manual-install-2.png - :scale: 50 % - :alt: Choose partitioning method - - Figure 2: :guilabel:`Choose partitioning method` - - If your hard drive has already been partitioned for a Linux system, you - can select the :guilabel:`< Use default partition and mount scheme on - target device >` menu item and press :kbd:`Enter` to move to the next - step of the installer setup process. - - .. _cgdisk-manual-setup: - - Otherwise, to set up your hard drive partitions manually before moving to - the next step, select the :guilabel:`< Manually configure mounts and - partitions >` menu item and follow the instructions for :ref:`using CGDISK - to set up your Clear Linux hard drive`. - -.. _choose-target-device: - -Choose target device for installation -===================================== - -The :guilabel:`Choose target device for installation` menu, shown in figure -3, displays the current device and partition information. In -this example, ``/dev/sda`` is the only drive on the system with three -partitions defined and assigned. The menu cursor highlights the partition -to install |CL| onto. - -#. Select the :guilabel:`< Partition /dev/sda >` button and press the - :kbd:`Enter` key. - - .. note:: - - To return to the previous menu, press the :kbd:`Tab` key - to highlight the :guilabel:`< Previous >` button and press :kbd:`Enter` - to return to the previous menu. - - .. figure:: figures/bare-metal-manual-install-3.png - :scale: 50 % - :alt: Choose target device for installation - - Figure 3: :guilabel:`Choose target device for installation` - -#. Next, you will be presented with a warning screen (figure 4) with - :guilabel:`< No >` highlighted by default. If this is the device onto - which you wish to install |CL|, press :kbd:`Tab` to highlight - the :guilabel:`< Yes >` button. - -#. Press :kbd:`Enter` to proceed. - - .. figure:: figures/bare-metal-manual-install-4.png - :scale: 50 % - :alt: Device installation warning - - Figure 4: :guilabel:`Device installation warning` - -.. _incl-additional-manual-installer-settings: - -Additional manual installer settings -==================================== - -The next steps of the manual installer setup process allows you to: - -* Set up any additional command-line parameters to the kernel. -* Create a hostname for your system. -* Set up an administrative user. -* Install additional software bundles. -* Optionally create a static IP address for your system. - -#. The :guilabel:`Append to kernel cmdline` menu shown in figure 5 allows you - to add more options to the kernel command-line to further customize - your installation. Normally this is not required; however, if there are - specific options that need to be set in the Linux kernel, you can enter - them here. For a complete list of command-line parameters for the Linux - kernel you can visit the official documentation of the `latest kernel's - command-line parameters`_. - - Add any additional command-line parameters in the :guilabel:`Append to - cmdline:` field and then press the :kbd:`Tab` key to move to the - :guilabel:`< Next >` button and press :kbd:`Enter`. - - .. figure:: figures/bare-metal-manual-install-5.png - :scale: 50 % - :alt: Append to kernel cmdline - - Figure 5: :guilabel:`Append to kernel cmdline` - -#. The :guilabel:`Configuring Hostname` menu shown in figure 6 suggests - a hostname string prefaced with "clr". You can make your hostname anything - meaningful and unique. Once complete, press the :kbd:`Tab` key to move to - the :guilabel:`< Next >` button and press :kbd:`Enter`. - - .. figure:: figures/bare-metal-manual-install-6.png - :scale: 50 % - :alt: Configure Hostname - - Figure 6: :guilabel:`Configure Hostname` - - To learn more about hostname naming conventions and restrictions, you can - check this `wiki page about hostnames`_. - -#. The :guilabel:`User configuration` menu shown in figure 7 allows you to - create a userid with administrative privileges. If you do not want to - create a user at this time, select - :guilabel:`< No user creation (login as root) >` to skip this step and - proceed to the :guilabel:`Bundle selector` menu. - - .. figure:: figures/bare-metal-manual-install-7.png - :scale: 50 % - :alt: User configuration - - Figure 7: :guilabel:`User configuration` - - #. To create a userid, select the :guilabel:`< Create an administrative - user >` field and press :kbd:`Enter` to go to the the next screen. - #. You will be presented with the second :guilabel:`User configuration` - menu shown in figure 8. You are only required to fill in the - :guilabel:`Username`, :guilabel:`Password`, and :guilabel:`Confirm - password` fields. - #. To give a user administrative privileges, press :kbd:`Tab` until - cursor appears in the field :guilabel:`Add user to the sudoers?` and - select. This adds the user to the ``wheel`` group and allows entry of - the :command:`sudo` command. - - After entering all data, press :kbd:`Tab` until :guilabel:`< Next >` - is highlighted. Then press :kbd:`Enter`. - - .. figure:: figures/bare-metal-manual-install-8.png - :scale: 50 % - :alt: User configuration - create user - - Figure 8: :guilabel:`User configuration - create user` - -#. In the menu :guilabel:`Bundle selector` (figure 9), you can add - software bundles to your initial |CL| installation. Press the :kbd:`Tab` - key to highlight additional bundles, and then press :kbd:`Spacebar` or - :kbd:`Enter` to select each bundle. This menu will also list the - additional :guilabel:`--- required ---` software bundles that will be - installed during the |CL| installation. - - .. figure:: figures/bare-metal-manual-install-9.png - :scale: 50 % - :alt: Bundle selector - - Figure 9: :guilabel:`Bundle selector` - -For a complete description of the content of these additional bundles, go to -the :ref:`software bundle list ` and select the name for a -specific bundle to show the contents within the bundle. - -.. _incl-additional-manual-installer-settings-end: - -Target system network configuration -=================================== - -Before the actual |CL| installation begins, we must set up the -:guilabel:`Network configuration` shown in figure 10. Select -:guilabel:`< Use DHCP >` to have an IP address automatically assigned when -the system boots up. - -.. figure:: figures/bare-metal-manual-install-10.png - :scale: 50 % - :alt: Network configuration - - Figure 10: :guilabel:`Network configuration` - -You can optionally set up a static IP address for your system. Select the -:guilabel:`< Use static IP configuration >` menu item and fill in the -required fields. - -Begin installation -****************** - -The |CL| installer is now ready to use the information you provided on the -previous sections to begin the actual installation. Figure 11 shows the -installer's prompt to begin the installation. - -.. figure:: figures/bare-metal-manual-install-11.png - :scale: 50 % - :alt: Begin installation - - Figure 11: :guilabel:`Begin installation` - -When you are satisfied with the information entered, select the -:guilabel:`< Yes >` button and press :kbd:`Enter` to begin installing |CL|. - -The |CL| Installation begins and each step shows its status as it progresses -through the manual installation process as shown in figure 12. - -.. figure:: figures/bare-metal-manual-install-12.png - :scale: 50 % - :alt: Installation status - - Figure 12: :guilabel:`Installation status` - -Once all steps have completed, you will see the ``Successful installation`` -status message and the :guilabel:`< Ok >` button is highlighted as shown in -figure 13. Press the :kbd:`Enter` key to continue. - -.. figure:: figures/bare-metal-manual-install-13.png - :scale: 50 % - :alt: Installation complete - - Figure 13: :guilabel:`Installation complete` - -Congratulations! The installation completed successfully and the system will -reboot. Figure 14 shows the installer's final prompt. Press the :kbd:`Enter` -key and remove the USB media while the system restarts. - -.. figure:: figures/bare-metal-manual-install-14.png - :scale: 50 % - :alt: Successful Installation - - Figure 14: :guilabel:`Successful Installation` - -Once the system boots, the Gnome Desktop sign-in screen shown in figure 15 -appears: - -.. figure:: figures/bare-metal-manual-install-15.png - :scale: 50 % - :alt: Gnome sign-in screen - - Figure 15: :guilabel:`Gnome sign-in screen` - -Click on the :guilabel:`username` you created, enter the password, and you -will be logged into the system. The Gnome 3 desktop appears as shown in -figure 16: - -.. figure:: figures/bare-metal-manual-install-16.png - :scale: 50 % - :alt: Gnome Desktop Manager - - Figure 16: :guilabel:`Gnome Desktop Manager` - -**Congratulations!** - -You have successfully installed |CL| on a bare metal system using the -manual installation method. - -Visit our :ref:`tutorials ` section for examples on using your -|CL| system. - -.. _`information about stateless`: - https://clearLinux.org/features/stateless - -.. _`wiki page about Hostnames`: - https://en.wikipedia.org/wiki/Hostname - -.. _`learn more about telemetry.`: - https://clearLinux.org/features/telemetry - -.. _`latest kernel's command-line parameters`: - https://www.kernel.org/doc/html/latest/admin-guide/kernel-parameters.html diff --git a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-1.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-1.png deleted file mode 100644 index cb023cf5..00000000 Binary files a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-1.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-10.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-10.png deleted file mode 100644 index d8a3f5f3..00000000 Binary files a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-10.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-11.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-11.png deleted file mode 100644 index 107febc4..00000000 Binary files a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-11.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-12.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-12.png deleted file mode 100644 index 66751565..00000000 Binary files a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-12.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-13.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-13.png deleted file mode 100644 index 9a14d9e1..00000000 Binary files a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-13.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-14.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-14.png deleted file mode 100644 index 50fdc0ed..00000000 Binary files a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-14.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-15.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-15.png deleted file mode 100644 index 7b538705..00000000 Binary files a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-15.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-16.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-16.png deleted file mode 100644 index df61163b..00000000 Binary files a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-16.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-2.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-2.png deleted file mode 100644 index b52d3f3b..00000000 Binary files a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-2.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-3.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-3.png deleted file mode 100644 index 2c5ff918..00000000 Binary files a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-3.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-4.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-4.png deleted file mode 100644 index a5897712..00000000 Binary files a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-4.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-5.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-5.png deleted file mode 100644 index 54acbe3e..00000000 Binary files a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-5.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-6.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-6.png deleted file mode 100644 index 0d2fe7f2..00000000 Binary files a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-6.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-7.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-7.png deleted file mode 100644 index a98d99b8..00000000 Binary files a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-7.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-8.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-8.png deleted file mode 100644 index 8401cf67..00000000 Binary files a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-8.png and /dev/null differ diff --git a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-9.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-9.png deleted file mode 100644 index 4b7fa392..00000000 Binary files a/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-9.png and /dev/null differ diff --git a/source/clear-linux/get-started/bootable-usb/bootable-usb-beta-all.rst b/source/clear-linux/get-started/bootable-usb/bootable-usb-beta-all.rst index 6f26d650..5c5d3014 100644 --- a/source/clear-linux/get-started/bootable-usb/bootable-usb-beta-all.rst +++ b/source/clear-linux/get-started/bootable-usb/bootable-usb-beta-all.rst @@ -3,19 +3,19 @@ Create a bootable USB on your OS ################################ -Follow these instructions to create a bootable |CL-ATTR| USB drive based on +Follow these instructions to create a bootable |CL-ATTR| USB drive based on your OS. * :ref:`bootable-usb-linux-all` * :ref:`bootable-usb-mac-all` * :ref:`bootable-usb-windows-all` -Return to :ref:`install-from-live-image` +Return to :ref:`get-started` -Requirements: +Requirements: ************* -* Use a **16GB** or larger USB drive. +* Use a **16GB** or larger USB drive. .. _bootable-usb-linux-all: @@ -43,8 +43,8 @@ Burn the |CL| image onto a USB drive #. Plug in the USB drive. #. Identify the USB drive using the :command:`lsblk` command. This shows all drives attached to the system, including the primary hard disk. In the - example output below, there are 4 drives - (`/dev/sda`, `/dev/sdb`, `/dev/sdc`, and `/dev/sdd`) attached, where + example output below, there are 4 drives + (`/dev/sda`, `/dev/sdb`, `/dev/sdc`, and `/dev/sdd`) attached, where `/dev/sda` is primary drive in this case. The remaining are 3 USB drives. The output also shows the mounted partitions (under the `MOUNTPOINT` column) for each drive. @@ -132,7 +132,7 @@ Burn the |CL| image onto a USB drive diskutil umountDisk /dev/disk2 -#. Burn the image onto the drive using the :command:`dd` command. The +#. Burn the image onto the drive using the :command:`dd` command. The command-line example below burns an uncompressed image onto `/dev/disk2`: .. code-block:: console @@ -140,9 +140,9 @@ Burn the |CL| image onto a USB drive sudo dd if=./clear-[version number]-[image type] of=/dev/rdisk2 bs=4m - Adding an ‘r’ in front of the disk identifier should help speed up the + Adding an ‘r’ in front of the disk identifier should help speed up the imaging process. - + You can press :kbd:`-T` to check imaging progress. #. Eject the USB drive. @@ -178,7 +178,7 @@ Burn the |CL| image onto a USB drive Figure 1: Rufus utility - Click the SELECT button -#. Find and select the previously extracted |CL| image file. +#. Find and select the previously extracted |CL| image file. Then, click the :guilabel:`Open` button. See Figure 2. .. figure:: figures/bootable-usb-windows-2.png @@ -186,18 +186,18 @@ Burn the |CL| image onto a USB drive :alt: Rufus utility - Show and select |CL| image file Figure 2: Rufus utility - Show and select |CL| image file - + #. Click the :guilabel:`START` button. See Figure 3. .. figure:: figures/bootable-usb-windows-3.png :scale: 80 % :alt: Rufus utility - Click the START button - + Figure 3: Rufus utility - Click START button Return to install from live image ********************************* -Return to :ref:`install-from-live-image` +Return to :ref:`get-started` .. _Rufus: https://rufus.ie/ diff --git a/source/clear-linux/get-started/cgdisk-manual-install/cgdisk-manual-install.rst b/source/clear-linux/get-started/cgdisk-manual-install/cgdisk-manual-install.rst deleted file mode 100644 index 5f00c804..00000000 --- a/source/clear-linux/get-started/cgdisk-manual-install/cgdisk-manual-install.rst +++ /dev/null @@ -1,313 +0,0 @@ -.. _cgdisk-manual-install: - -Create partitions for |CL-ATTR| using CGDISK -############################################ - -These instructions guide you through the initial setup of your hard drive -partitions using the :command:`cgdisk` utility . If you do not wish to continue -creating your own partitions, :ref:`return to the bare metal manual installation -`. - -Prerequisites -************* - -This guide assumes that you have followed the :ref:`bare-metal-install` -guide and intend to :ref:`install Clear Linux manually -` by choosing the :guilabel:`< Manual(Advanced) >` -menu item on the :guilabel:`Choose Installation Type` |CL| Installer setup -menu as shown in figure 1: - -.. figure:: figures/cgdisk-manual-install-1.png - :scale: 50 % - :alt: Choose installation Type - - Figure 1: :guilabel:`Choose installation Type` - -Partition using CGDISK -********************** - -We use the :command:`cgdisk` application to create a -:abbr:`GPT (GUID Partition Table)` since |CL| only supports the -:abbr:`UEFI (Unified Extensible Firmware Interface)` specification. For a -complete description of the :command:`cgdisk` utility and how to use it, -visit Rod Smith's website for a `GPT fdisk tutorial`_. - -In this guide, we intend to use an unpartitioned hard drive for the |CL| -installation. - -#. To manually partition your hard drive, select - :guilabel:`< Manually configure mounts and partitions >` in the menu - :guilabel:`Choose partitioning method`, shown in figure 2. - - .. figure:: figures/cgdisk-manual-install-2.png - :scale: 50 % - :alt: Choose partitioning method - - Figure 2: :guilabel:`Choose partitioning method` - - Next, the current device available to partition is shown. In this - example, shown in figure 3, :file:`/dev/sda` is available but - does not have any partitions defined. - -#. Select the :guilabel:`< Partition /dev/sda >` menu item and press - :kbd:`Enter` to begin the process of modifying this disk. - - .. figure:: figures/cgdisk-manual-install-3.png - :scale: 50 % - :alt: Choose a drive to partition using cgdisk tool - - Figure 3: :guilabel:`Choose a drive to partition using cgdisk tool` - - The :command:`cgdisk` application starts and displays the settings for - :file:`/dev/sda` as shown in figure 4. - - .. figure:: figures/cgdisk-manual-install-4.png - :scale: 50 % - :alt: cgdisk - - Figure 4: :guilabel:`cgdisk` - -Linux partition setup -********************* - -In order to properly set up the |CL| partitioning scheme, we create three -partitions using the :command:`cgdisk` utility in the following order: - -#. EFI boot partition -#. Linux swap partition -#. Linux root partition - -For a complete understanding of these partitions, you can review the -`Linux partitioning scheme`_ information. - -Create the EFI boot partition -============================= - -#. With the free space highlighted in the :command:`cgdisk` utility, - you can either select the :guilabel:`[ New ]` button and press :kbd:`Enter` - or press the :kbd:`N` key to define a new partition. - - The utility prompts you to enter the first sector. Press the :kbd:`Enter` - key to accept the default value shown. - - .. note:: - In this example, the first sector starts at 2048. For more information - about alignment using the cgdisk tool, see - `Rod Smith's Partitioning Advice about alignment`_. - -#. The program then prompts you for the size of the partition. To create a - 512MB partition, enter 512M and press :kbd:`Enter` as shown in figure 5: - - .. figure:: figures/cgdisk-manual-install-5.png - :scale: 50 % - :alt: cgdisk - New - - Figure 5: :guilabel:`cgdisk - New partition` - -#. To define the type of partition, the :command:`cgdisk` utility has - pre-defined partition types. Press the :kbd:`L` key to show the hex codes - you can use. Use these codes to set the correct - :abbr:`GUID (Globally unique identifier)` for *GPT partition types* as - shown in figure 6: - - .. figure:: figures/cgdisk-manual-install-6.png - :scale: 50 % - :alt: cgdisk - hex codes for partition types - - Figure 6: :guilabel:`cgdisk - hex codes for partition types` - - We need to use the following three codes for our partitions: - - * ef00 - EFI System - * 8200 - Linux swap - * 8300 - Linux filesystem - -#. To create the EFI boot partition, enter ``ef00`` as the hexcode for this - partition and press :kbd:`Enter`. - -#. To name the partition, enter ``boot`` and press :kbd:`Enter` to finish - setting up the EFI boot partition. The utility shows the first partition as - an ``EFI System`` 512MiB partition named ``boot`` as shown in figure 7: - - .. figure:: figures/cgdisk-manual-install-7.png - :scale: 50 % - :alt: cgdisk - boot partition defined - - Figure 7: :guilabel:`cgdisk - boot partition defined` - -Create the Linux swap partition -=============================== - -Next, we must create the Linux swap partition. In figure 7, notice the two -areas defined as free space. We created the first 1007.0 KiB free space area -when we started the EFI boot partition at sector 2048. For more information -about it, review `Rod Smith's Partitioning advice about alignment`_. - -#. Move your cursor to highlight the larger free space of 334.8 GiB at the - bottom of the partition list before you begin to create the Linux swap - partition as shown in figure 8: - - .. figure:: figures/cgdisk-manual-install-8.png - :scale: 50 % - :alt: cgdisk - free space selection - - Figure 8: :guilabel:`cgdisk - free space selection` - -#. To create the Linux swap partition, with the largest free space - highlighted, select the :guilabel:`[ New ]` button or press the :kbd:`N` - key and enter the following values for the Linux swap partition: - - .. code-block:: console - - First sector: press :kbd:`Enter` to select the default value - Size in sectors: 4G - Hex code or GUID: 8200 - Enter new partition name: swap - - Your :command:`cgdisk` partition list should now look like figure 9. - - .. figure:: figures/cgdisk-manual-install-9.png - :scale: 50 % - :alt: cgdisk - swap partition defined - - Figure 9: :guilabel:`cgdisk - swap partition defined` - -Create the Linux filesystem partition -===================================== - -Lastly, we must create the the Linux filesystem partition to use it as the -root mount point for you |CL| installation. - -#. Highlight the largest free space entry at the bottom of the list and select - the :guilabel:`[ New ]` button or press the :kbd:`N` key and enter the - following values to create the Linux filesystem partition: - - .. code-block:: console - - First sector: press :kbd:`Enter` to select the default value - Size in sectors: press :kbd:`Enter` to select the default value, which - is the remainder of available space on the disk - Hex code or GUID: 8300 - Enter new partition name: root - - With all the partitions now defined, you should see a list similar to what - is shown in figure 10: - - .. figure:: figures/cgdisk-manual-install-10.png - :scale: 50 % - :alt: cgdisk - defined partitions - - Figure 10: :guilabel:`cgdisk - defined partitions` - -#. If you are satisfied that the partition scheme is correct, you need to - write this GPT to the hard drive. Select the :guilabel:`[ Write ]` button - or press the :kbd:`W` key and the :command:`cgdisk` program prompts with: - - .. code-block:: console - - Are you sure you want to write the partition table to disk? (yes or no) - -#. Enter ``yes`` and press :kbd:`Enter` to write this data to the hard drive - and then select the :guilabel:`[ Quit ]` button or press :kbd:`Q` to exit - the :command:`cgdisk` utility. - -#. You see the partitions that were created as shown in figure 11. Move your - cursor to the :guilabel:`< Next >` button and press :kbd:`Enter`. - - .. figure:: figures/cgdisk-manual-install-11.png - :scale: 50 % - :alt: defined partitions - - Figure 11: :guilabel:`defined partitions` - -Set the mount points -******************** - -The :guilabel:`Set mount points` menu sets the mount points that the |CL| -installer uses for your |CL| installation, shown in figure 12. - -.. figure:: figures/cgdisk-manual-install-12.png - :scale: 50 % - :alt: Set mount points - - Figure 12: :guilabel:`Set mount points` - -In this menu you need to set the mount points for the boot and root -partitions and select to format them. - -#. Highlight the EFI System partition type menu entry and press the - :kbd:`Enter` key to edit this item. The :guilabel:`Set mount point of - sda1` menu is shown. - - #. For :guilabel:`Enter mount point:` type `/boot` and press - :kbd:`Enter`. - #. Press Tab to enter the :guilabel:`[ ] Format` field. - #. Press Enter/Spacebar to select :guilabel:`[ ] Format`, which allows - formatting of the partition. - - Figure 13 shows the information entered. Select :guilabel:`< Next >` - and press :kbd:`Enter`. - - .. figure:: figures/cgdisk-manual-install-13.png - :scale: 50 % - :alt: Set mount point of sda1 - - Figure 13: :guilabel:`Set mount point of sda1` - -#. Do the same for the Linux filesystem partition by highlighting the - :guilabel:`Linux filesystem` menu entry and entering the information shown - in figure 14 to set the :guilabel:`Enter mount point:` to :file:`/` and - enable formatting: - - .. figure:: figures/cgdisk-manual-install-14.png - :scale: 50 % - :alt: Set mount point of sda3 - - Figure 14: :guilabel:`Set mount point of sda3` - -#. Optional: Select :guilabel:`Encrypt Root Partition`, if - desired, as shown in figure 15. - - .. note:: - `Set mount points` now show as completed. - - .. figure:: figures/cgdisk-manual-install-15.png - :scale: 50 % - :alt: Encrypt root partition - - Figure 15: :guilabel:`Encrypt root partition` - -#. Type a confirmation passphrase as directed. - - .. note: - - It is recommended to record the passphrase for safekeeping. - - .. figure:: figures/cgdisk-manual-install-16.png - :scale: 50 % - :alt: Type confirmation passphrase - - Figure 16: :guilabel: `Type confirmation passphrase` - -#. Select the :guilabel:`< Next >` button and press :kbd:`Enter`. - - You have completed the process of manually partitioning your target - system. - -#. Now, :ref:`return to the bare metal manual installation - ` to complete installation of |CL|. - - Continue at the section :ref:`Additional manual installer settings - `. - -.. _`GPT fdisk tutorial`: - http://www.rodsbooks.com/gdisk/ - -.. _`Rod Smith's Partitioning Advice about alignment`: - http://www.rodsbooks.com/gdisk/advice.html#alignment - -.. _`information about swupd`: - https://clearlinux.org/features/software-update - -.. _`Linux partitioning scheme`: - https://wiki.archlinux.org/index.php/partitioning#Partition_scheme diff --git a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-1.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-1.png deleted file mode 100644 index cb023cf5..00000000 Binary files a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-1.png and /dev/null differ diff --git a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-10.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-10.png deleted file mode 100644 index 8d977f83..00000000 Binary files a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-10.png and /dev/null differ diff --git a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-11.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-11.png deleted file mode 100644 index 3e73dc50..00000000 Binary files a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-11.png and /dev/null differ diff --git a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-12.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-12.png deleted file mode 100644 index 542c3101..00000000 Binary files a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-12.png and /dev/null differ diff --git a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-13.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-13.png deleted file mode 100644 index 7393ad38..00000000 Binary files a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-13.png and /dev/null differ diff --git a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-14.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-14.png deleted file mode 100644 index a558b8ec..00000000 Binary files a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-14.png and /dev/null differ diff --git a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-15.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-15.png deleted file mode 100644 index 6b824a1f..00000000 Binary files a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-15.png and /dev/null differ diff --git a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-16.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-16.png deleted file mode 100644 index 77ff7d05..00000000 Binary files a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-16.png and /dev/null differ diff --git a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-2.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-2.png deleted file mode 100644 index 4120d770..00000000 Binary files a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-2.png and /dev/null differ diff --git a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-3.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-3.png deleted file mode 100644 index 97303025..00000000 Binary files a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-3.png and /dev/null differ diff --git a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-4.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-4.png deleted file mode 100644 index d81b6d95..00000000 Binary files a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-4.png and /dev/null differ diff --git a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-5.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-5.png deleted file mode 100644 index 75163ffa..00000000 Binary files a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-5.png and /dev/null differ diff --git a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-6.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-6.png deleted file mode 100644 index 1528b667..00000000 Binary files a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-6.png and /dev/null differ diff --git a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-7.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-7.png deleted file mode 100644 index f9b007fc..00000000 Binary files a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-7.png and /dev/null differ diff --git a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-8.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-8.png deleted file mode 100644 index 7c41a266..00000000 Binary files a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-8.png and /dev/null differ diff --git a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-9.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-9.png deleted file mode 100644 index b5b351c3..00000000 Binary files a/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-9.png and /dev/null differ diff --git a/source/clear-linux/get-started/get-started.rst b/source/clear-linux/get-started/get-started.rst index f39766c2..15ebfb9b 100644 --- a/source/clear-linux/get-started/get-started.rst +++ b/source/clear-linux/get-started/get-started.rst @@ -3,39 +3,29 @@ Get started ########### -The Get Started section will get you up and running fast with |CL-ATTR|. Use -these step-by-step instructions to guide you through the installation of |CL| +The Get Started section will get you up and running fast with |CL-ATTR|. Use +these step-by-step instructions to guide you through the installation of |CL| from bare metal to a live image. - + Pre-install *********** -* :ref:`system-requirements` -* :ref:`compatibility-check` -* :ref:`bootable-usb` - - - -Install |CL| -************ - -* :ref:`bare-metal-install` -* :ref:`bare-metal-manual-install` -* :ref:`virtual-machine-install` -* :ref:`live-image` -* :ref:`bare-metal-install-beta` +* :ref:`system-requirements` .. toctree:: - :maxdepth: 2 - :hidden: + :maxdepth: 1 - bare-metal-install/bare-metal-install - bare-metal-manual-install/bare-metal-manual-install - cgdisk-manual-install/cgdisk-manual-install - virtual-machine-install/virtual-machine-install - live-image compatibility-check bootable-usb/bootable-usb - - bare-metal-install-beta/bare-metal-install-beta bootable-usb/bootable-usb-beta-all + +Install |CL| +************ + +.. toctree:: + :maxdepth: 1 + + bare-metal-install/bare-metal-install + virtual-machine-install/virtual-machine-install + live-image + bare-metal-install-beta/bare-metal-install-beta \ No newline at end of file diff --git a/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst b/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst index 7e9ae469..34f93ac9 100644 --- a/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst +++ b/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst @@ -35,4 +35,5 @@ appropriate set of step-by-step instructions to proceed. vmw-player vmw-player-preconf hyper-v + ../../guides/maintenance/increase-virtual-disk-size.rst diff --git a/source/clear-linux/guides/maintenance/swupd-guide.rst b/source/clear-linux/guides/maintenance/swupd-guide.rst index ea0bab61..0200ba2a 100644 --- a/source/clear-linux/guides/maintenance/swupd-guide.rst +++ b/source/clear-linux/guides/maintenance/swupd-guide.rst @@ -24,7 +24,8 @@ This guide assumes: .. _man_swupd: -For a full listing of commands and options please see the man page in |CL| +For a full listing of commands and options please see the man page found in +the `swupd` `source code`_ or on |CL| itself. .. code-block:: bash @@ -181,3 +182,4 @@ Dependencies common to other bundles will not be removed sudo swupd bundle-remove dev-utils-dev +.. _source code: https://github.com/clearlinux/swupd-client/blob/master/docs/swupd.1.rst \ No newline at end of file diff --git a/source/clear-linux/guides/network/ipxe-install.rst b/source/clear-linux/guides/network/ipxe-install.rst index ad58f584..f16ca06b 100644 --- a/source/clear-linux/guides/network/ipxe-install.rst +++ b/source/clear-linux/guides/network/ipxe-install.rst @@ -122,7 +122,7 @@ To set up |CL| manually, perform the steps below. .. code-block:: console sudo cat > $ipxe_root/ipxe_boot_script.ipxe << EOF - sudo!ipxe + #!ipxe kernel linux quiet init=/usr/lib/systemd/systemd-bootchart \ initcall_debug tsc=reliable no_timer_check noreplace-smp rw \ initrd=initrd diff --git a/source/clear-linux/reference/bundles/bundles.html.txt b/source/clear-linux/reference/bundles/bundles.html.txt index c9b36448..9f44f5bd 100644 --- a/source/clear-linux/reference/bundles/bundles.html.txt +++ b/source/clear-linux/reference/bundles/bundles.html.txt @@ -11,34 +11,59 @@ - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -46,9 +71,21 @@ - - - + + + @@ -58,13 +95,15 @@ @@ -77,9 +116,11 @@ @@ -88,21 +129,61 @@ - + - - - + + + - + + + + + + + + + + + + + + + @@ -113,13 +194,32 @@ + + + + + + + @@ -128,12 +228,29 @@ - + + + + + + + + - + @@ -164,9 +281,19 @@ @@ -178,33 +305,66 @@ - + + + + + + + + - + + + + + + + + + + + + + + + @@ -217,21 +377,25 @@ @@ -244,11 +408,15 @@ @@ -261,23 +429,25 @@ @@ -290,23 +460,27 @@ @@ -315,7 +489,7 @@ - + @@ -326,17 +500,19 @@ @@ -348,6 +524,14 @@ @@ -358,11 +542,15 @@ @@ -375,13 +563,87 @@ @@ -394,9 +656,11 @@ @@ -409,15 +673,97 @@ @@ -426,7 +772,7 @@ - + @@ -437,9 +783,11 @@ @@ -452,9 +800,92 @@ + + + + + + + @@ -463,14 +894,21 @@ - + - + + + + + + + + @@ -481,9 +919,13 @@ @@ -496,13 +938,85 @@ @@ -515,27 +1029,37 @@ @@ -548,15 +1072,23 @@ @@ -569,23 +1101,27 @@ @@ -598,9 +1134,17 @@ @@ -613,9 +1157,11 @@ @@ -628,9 +1174,11 @@ @@ -643,15 +1191,193 @@ @@ -664,9 +1390,11 @@ @@ -679,9 +1407,11 @@ @@ -694,17 +1424,27 @@ @@ -717,11 +1457,15 @@ @@ -734,9 +1478,11 @@ @@ -748,6 +1494,14 @@ @@ -758,15 +1512,43 @@ @@ -779,13 +1561,1634 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -794,7 +3197,7 @@ - + @@ -810,21 +3213,45 @@ - + - + + + + + + + + - + + + + + + + + @@ -835,11 +3262,13 @@ @@ -848,21 +3277,35 @@ - + + + + + + + + - + + + + + + + + - + @@ -873,13 +3316,15 @@ @@ -892,13 +3337,79 @@ @@ -911,23 +3422,27 @@ @@ -940,15 +3455,17 @@ @@ -961,15 +3478,17 @@ @@ -982,15 +3501,17 @@ @@ -1003,15 +3524,17 @@ @@ -1038,35 +3561,35 @@ - + - + - + - + - + @@ -1077,11 +3600,15 @@ @@ -1089,17 +3616,53 @@ + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + @@ -1110,11 +3673,27 @@ @@ -1127,13 +3706,159 @@ @@ -1142,21 +3867,21 @@ - + - + - + @@ -1167,11 +3892,15 @@ @@ -1180,22 +3909,31 @@ - + + + + + + + + @@ -1208,13 +3946,75 @@ @@ -1223,14 +4023,21 @@ - + - + + + + + + + + @@ -1249,6 +4056,14 @@ @@ -1259,15 +4074,23 @@ @@ -1280,9 +4103,11 @@ @@ -1291,42 +4116,56 @@ - + - + - + - + + + + + + + + - + - + + + + + + + + @@ -1337,9 +4176,11 @@ @@ -1348,28 +4189,49 @@ - + + + + + + + + - + + + + + + + + + + + + + + + - - + + - + @@ -1380,15 +4242,19 @@ @@ -1401,9 +4267,11 @@ @@ -1416,15 +4284,17 @@ @@ -1433,35 +4303,42 @@ - + - + - + - + + + + + + + + - + @@ -1472,9 +4349,11 @@ @@ -1496,9 +4375,11 @@ @@ -1511,9 +4392,11 @@ @@ -1526,9 +4409,11 @@ @@ -1541,9 +4426,11 @@ @@ -1552,7 +4439,7 @@ - + @@ -1563,9 +4450,11 @@ @@ -1578,9 +4467,11 @@ @@ -1593,9 +4484,11 @@ @@ -1608,9 +4501,11 @@ @@ -1623,9 +4518,11 @@ @@ -1633,14 +4530,44 @@ + + + + + + + + + + + + + + @@ -1653,9 +4580,11 @@ @@ -1668,9 +4597,11 @@ @@ -1679,7 +4610,7 @@ - + @@ -1690,13 +4621,21 @@ @@ -1709,9 +4648,11 @@ @@ -1724,13 +4665,149 @@ @@ -1743,11 +4820,13 @@ @@ -1755,16 +4834,25 @@ + + + + + + + @@ -1773,14 +4861,21 @@ - + - + + + + + + + + @@ -1795,6 +4890,27 @@ + + + + + + + + + + + + + + + + + + + + + - + - + + + + + + + + + + + + + + + - + @@ -1843,26 +4973,35 @@ + + + + + + + @@ -1875,9 +5014,11 @@ @@ -1890,11 +5031,13 @@ @@ -1907,15 +5050,17 @@ @@ -1928,9 +5073,13 @@ @@ -1943,13 +5092,103 @@ @@ -1958,14 +5197,52 @@ - + + + + + + + + + + + + + + + - + @@ -1976,9 +5253,13 @@ @@ -1991,21 +5272,23 @@ @@ -2014,21 +5297,56 @@ - + - + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + @@ -2039,19 +5357,29 @@ @@ -2064,15 +5392,89 @@ @@ -2085,9 +5487,19 @@ @@ -2100,9 +5512,13 @@ @@ -2111,19 +5527,33 @@ - + - + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + @@ -2171,7 +5617,7 @@ - + @@ -2182,11 +5628,17 @@ @@ -2208,13 +5660,15 @@ @@ -2227,9 +5681,11 @@ @@ -2242,17 +5698,19 @@ @@ -2265,11 +5723,13 @@ @@ -2282,11 +5742,13 @@ @@ -2308,53 +5770,87 @@ @@ -2367,31 +5863,209 @@ @@ -2413,9 +6087,69 @@ @@ -2428,9 +6162,13 @@ @@ -2443,13 +6181,98 @@ + + + + + + + @@ -2462,13 +6285,21 @@ @@ -2481,11 +6312,29 @@ @@ -2498,15 +6347,59 @@ + + + + + + + + + + + + + + @@ -2519,39 +6412,77 @@ @@ -2564,27 +6495,61 @@ @@ -2597,27 +6562,61 @@ @@ -2630,25 +6629,39 @@ @@ -2661,13 +6674,171 @@ @@ -2676,7 +6847,7 @@ - + @@ -2687,17 +6858,25 @@ @@ -2710,11 +6889,15 @@ @@ -2723,35 +6906,61 @@ - + - + + + + + + + + + + + + + + + @@ -2773,13 +6982,69 @@ @@ -2792,9 +7057,11 @@ @@ -2811,9 +7078,25 @@ + + + + + + + - - + + + + + + + + + @@ -2828,14 +7111,14 @@ - + - + @@ -2846,11 +7129,19 @@ @@ -2859,7 +7150,7 @@ - + @@ -2870,9 +7161,13 @@ @@ -2885,13 +7180,15 @@ @@ -2904,13 +7201,97 @@ @@ -2923,11 +7304,15 @@ @@ -2940,11 +7325,13 @@ @@ -2957,9 +7344,11 @@ @@ -2972,9 +7361,11 @@ @@ -2986,6 +7377,14 @@ @@ -2996,13 +7395,153 @@ @@ -3010,16 +7549,25 @@ + + + + + + + @@ -3032,11 +7580,15 @@ @@ -3049,9 +7601,11 @@ @@ -3064,11 +7618,13 @@ @@ -3077,7 +7633,14 @@ - + + + + + + + + @@ -3088,9 +7651,11 @@ @@ -3112,11 +7677,13 @@ @@ -3129,11 +7696,19 @@ @@ -3141,16 +7716,27 @@ + + + + + + + @@ -3163,13 +7749,81 @@ @@ -3181,19 +7835,42 @@ + + + + + + + @@ -3206,13 +7883,151 @@ @@ -3225,11 +8040,13 @@ @@ -3237,16 +8054,27 @@ + + + + + + + @@ -3258,6 +8086,24 @@ @@ -3268,13 +8114,91 @@ @@ -3283,7 +8207,7 @@ - + @@ -3299,21 +8223,21 @@ - + - + - + @@ -3324,11 +8248,13 @@ @@ -3341,15 +8267,55 @@ @@ -3362,13 +8328,87 @@ @@ -3381,13 +8421,19 @@ @@ -3400,15 +8446,17 @@ @@ -3416,6 +8464,13 @@ + + + + + + + @@ -3450,14 +8507,21 @@ - + + + + + + + + - + @@ -3473,28 +8537,35 @@ - + - + - + + + + + + + + - + @@ -3505,27 +8576,29 @@ @@ -3538,29 +8611,183 @@ @@ -3569,7 +8796,14 @@ - + + + + + + + + @@ -3580,11 +8814,13 @@ @@ -3597,11 +8833,32 @@ + + + + + + + @@ -3610,7 +8867,7 @@ - + @@ -3621,11 +8878,13 @@ @@ -3637,27 +8896,37 @@ - + - + - + @@ -3668,11 +8937,13 @@ @@ -3681,7 +8952,7 @@ - + @@ -3692,11 +8963,13 @@ @@ -3709,9 +8982,15 @@ @@ -3720,7 +8999,7 @@ - + @@ -3731,11 +9010,13 @@ @@ -3744,21 +9025,56 @@ - + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + - + diff --git a/source/clear-linux/reference/bundles/bundles.rst b/source/clear-linux/reference/bundles/bundles.rst index 257ff43f..6fa87835 100644 --- a/source/clear-linux/reference/bundles/bundles.rst +++ b/source/clear-linux/reference/bundles/bundles.rst @@ -3,7 +3,9 @@ Available bundles ################# -This document provides a current list of `available bundles`_. To learn more about how |CL-ATTR| uses bundles for software deployment, visit :ref:`bundles-about`. +This document provides a current list of available bundles. To learn more about how |CL-ATTR| uses bundles for software deployment, visit :ref:`bundles-about`. + +To view bundles or packages on GitHub, select the :file:`Name` in column one. Bundle list =========== @@ -11,4 +13,3 @@ Bundle list .. raw:: html :file: bundles.html.txt -.. _available bundles: https://github.com/clearlinux/clr-bundles diff --git a/source/clear-linux/reference/collaboration/collaboration.rst b/source/clear-linux/reference/collaboration/collaboration.rst index 341d5c91..fb7b5369 100644 --- a/source/clear-linux/reference/collaboration/collaboration.rst +++ b/source/clear-linux/reference/collaboration/collaboration.rst @@ -1,17 +1,83 @@ .. _collaboration: -Collaboration guidelines +Documentation guidelines ######################## -Thank you for your interest in collaborating with the |CL-ATTR|. This guide -details the best ways to collaborate with the |CL| team. -Additionally, this guide provides the guidelines our documentation follows. -Thus, you can help improve our documents with your use case tutorials, -examples, or task focused guides. Read the information carefully before -submitting any work for review to ensure your contribution can be added as -quickly as possible. +See a missing topic in the documentation? Find an existing document that could +be improved? Help us out by contributing! If you haven't contributed before, +take a moment to review our `Contribution guidelines`_. + +Do you have questions about the documentation that were not answered by these +guidelines? Send your question to the `mailing list`_. + +Contribution guidelines +*********************** + +The |CL| documentation is hosted in GitHub and is written using +reStructuredText. Use our guidelines and best practices to write consistent, +readable documentation. .. toctree:: :maxdepth: 1 - documentation/documentation + Writing guide: Describes the style we use to keep our documents clear and concise. + Structure and formatting guide: Explains how we organize and format content, using reStructuredText and Sphinx. + +How to contribute +***************** + +There are multiple ways to contribute and help improve our documentation: + +* **Make a suggestion**: Have a documentation suggestion but no time to write it + yourself? Send your suggestion to the `mailing list`_. +* **Log an issue**: If you find a problem in our documentation (such as typos or + out-of-date information), log an issue in the `documentation repository`_. +* **Contribute directly via GitHub**: Whether you've found a typo, have better + instructions or examples, or have a new page to add, submit your improvement + or addition as a pull request on the `documentation repository`_. +* **Test documentation**: Step through our instructional guides and tutorials to + verify the instructions. Log or correct any out-of-date information. + +All contributions must follow our `code of conduct`_. + +Contribute via GitHub +********************* + +Our documentation is hosted in GitHub and we follow the standard `GitHub flow`_: + +#. Clone the `documentation repository`_. + +#. Create your own fork of the repository. + +#. Create a branch for your contribution. + +#. Add your commits. + +#. Open a pull request. + +#. Discuss, review, and update your contributions. + +#. Once the maintainer approves, your contribution is merged and published as + part of the documentation. + +.. _references: + +References +********** + +We use the following references to guide the grammar, style, and formatting of +our documentation: + +* `Microsoft Writing Style Guide`_ +* `Merriam-Webster Dictionary`_ +* The Chicago Manual of Style (15th edition), The University of Chicago Press +* Microsoft Press Computer Dictionary, Microsoft Press +* Read Me First!, Oracle Technical Publications + + +.. _`code of conduct`: https://clearlinux.org/community/code-of-conduct +.. _mailing list: https://lists.clearlinux.org/mailman/listinfo/dev +.. _GitHub flow: https://guides.github.com/introduction/flow/ +.. _documentation repository: https://github.com/clearlinux/clear-linux-documentation +.. _Microsoft Writing Style Guide: https://docs.microsoft.com/en-us/style-guide/welcome/ +.. _Merriam-Webster Dictionary: https://www.merriam-webster.com/ \ No newline at end of file diff --git a/source/clear-linux/reference/collaboration/documentation/basic.rst b/source/clear-linux/reference/collaboration/documentation/basic.rst deleted file mode 100644 index 021c345b..00000000 --- a/source/clear-linux/reference/collaboration/documentation/basic.rst +++ /dev/null @@ -1,130 +0,0 @@ -.. _basic: - -Basic contribution guide -######################## - -This list compiles the most common format, markup, structure, and grammar -rules for your convenience. You can find more detailed information in the -referenced sections. - -.. contents:: - :local: - :backlinks: entry - -Format -****** - -* Limit line length to 78 characters. The GitHub web interface forces this - limitation for readability. - -* Remove trailing white space from your documents. - -* Use short sentences and paragraphs. Keep sentence length under 20 words. - -* Use only lower case letters for filenames. - -* Separate multiple words in filenames using dashes. - -Markup -****** - -* Use the appropriate :abbr:`ReST (ReStructuredText)` roles for your content. - See the `ReST primer`_ for the complete list of roles. - -* Use the :abbr: role to define the first instance of an abbreviation, for - example: :abbr:\`CL (Clear Linux)\`. - -* Use hash-tags to underline the file's main title. - -* Use asterisks to underline the file's first level headings. - -* Use equal signs to underline the file's second level of headings. - -* Use dashes to underline the file's third level of headings. - -* Use labels to reference documentation sections. Do not reference - sections with URLs. See :ref:`cross` for details. - -* Don't use explicit URLs as links, for example https://clearlinux.org/. - -* Always include descriptive link text. For example: - Visit the `Clear Linux website`_. Do not use "here", "this", or similar - references for link text. - -Structure -********* - -* All files must have a main title and up to three levels of headings. - Restructure the content in multiple files as needed to comply. - -* Use descriptive headings. - -* Follow all headings with at least one paragraph of content. There should - never be two consecutive headings. - -* Separate the link and the target definition. All target definitions must be - included at the end of the file. See :ref:`cross` for details. - -* Use parallelism in headings, sentences, and lists. See our - :ref:`parallelism` for details. - -* Put conditional phrases first in cautions and warnings. For example: - "If you do X, then Y will occur." See our :ref:`notices` guide. - -* Place figures and tables immediately after related text. - -* Place code or commands immediately after the leading text in a new line, - see our :ref:`code`. - -* Reference figures, code examples, and tables by number. - For example, use "Figure 1," instead of "The figure above or below". See - :ref:`cross` and :ref:`images`. - -* Include at least one direct reference to any table or figure you add. See - :ref:`tables`. - -Grammar -******* - -* Include only one main idea in a sentence. See :ref:`simple`. - -* Limit the number of clauses you use to no more than two. See :ref:`simple`. - -* Limit the number of sentences per paragraph to about six. See :ref:`simple`. - -* Use strong verbs. See :ref:`simple`. - -* Use action verbs. See :ref:`simple`. - -* Avoid weak verbs like be, have, make, and do. See :ref:`simple`. - -* Use short direct commands and avoid niceties such as the word - "please". - -* Use the present tense wherever possible and avoid past and future - tense verbs. See :ref:`simple`. - -* Use Active voice. Write, "Someone does something"; don't write, - "Something is done by someone" or "Something is done." See :ref:`simple`. - -* Use "we" for recommendations. Write "We recommend..." as opposed to - "It is recommended...." See :ref:`simple`. - -* Use "you" rather than "the user" in your instructions. - -* Use short common English words whenever possible, see our :ref:`simple` - guide. - -* Avoid contractions. See :ref:`grammar`. - -* Use articles such as 'a', 'an', and 'the' to reduce ambiguity. - -Additional information -********************** - -Learn more about the accepted rules of grammar, punctuation, and word use in -our :ref:`language`. If you are looking for tips on how to write shorter, -clearer, and more concise content, visit our :ref:`simple` guide. - -.. _Clear Linux website: https://clearlinux.org/ -.. _ReST primer: http://docutils.sourceforge.net/docs/user/rst/quickstart.html diff --git a/source/clear-linux/reference/collaboration/documentation/code.rst b/source/clear-linux/reference/collaboration/documentation/code.rst deleted file mode 100644 index 870faeba..00000000 --- a/source/clear-linux/reference/collaboration/documentation/code.rst +++ /dev/null @@ -1,161 +0,0 @@ -.. _code: - -Code blocks -########### - -Contributing to the |CL-ATTR| is all about code. Therefore, your -documentation must include as many code examples as possible. You can write -code examples directly in the documentation or include them from a source -file. Use these guidelines to insert code blocks to your documentation: - -* Include code examples from a source file. Only write the code example - directly into the documentation if the example is less than 10 lines long. - -* Use the ``:linenos:`` option of the `literalinclude` directive to add line - numbers to your example. - -* Specify the programing language of your example. Not only will it - add syntax highlighting but it also allows the reader to identify code - efficiently. Use `bash` for console commands, `asm` for assembly code and - `c` for C code. - -* Treat all console commands entered by users as code examples. - -Examples -******** - -This is a code example included from a file. Note how only certain lines of -the source file are included and how the lines are renumbered. - -This source: - -.. code-block:: rst - - .. literalinclude:: ./hello.c - :language: c - :lines: 97-110 - :linenos: - -Renders as: - -.. literalinclude:: ./hello.c - :language: c - :lines: 97-110 - :linenos: - - -This example shows a series of console commands. Line numbering is not -required. Specify that these are commands using `bash` as the programing -language. - -This source: - -.. code-block:: rst - - .. code-block:: bash - - $ mkdir ${HOME}/x86-build - - $ mkdir ${HOME}/arm-build - - $ mkdir ${HOME}/cross-src - -Renders as: - -.. code-block:: bash - - $ mkdir ${HOME}/x86-build - - $ mkdir ${HOME}/arm-build - - $ mkdir ${HOME}/cross-src - -.. note:: - You will find instances which use `console` instead of `bash`. We are - currently in the process of implementing a distinction between the two. - Moving forward, `bash` will be used for commands entered by readers, and - `console` will be used for the output users obtain in the command prompt. - -Finally, this is a code example that is not part of the |CL| code base. It is -not even valid code but it can illustrate the concept. - -This source: - -.. code-block:: rest - - .. code-block:: c - - static NANO_CPU_INT_STUB_DECL (deviceStub); - - void deviceDriver (void) - - { - - . - . - . - - nanoCpuIntConnect (deviceIRQ, devicePrio, deviceIntHandler, - deviceStub); - - . - . - . - - } - -Renders as: - -.. code-block:: c - - static NANO_CPU_INT_STUB_DECL (deviceStub); - - void deviceDriver (void) - - { - - . - . - . - - nanoCpuIntConnect (deviceIRQ, devicePrio, deviceIntHandler, - deviceStub); - - . - . - . - - } - -Templates -********* - -We included templates for a basic ``.. code-block::`` directive -and for a ``.. literalinclude::`` directive. - -Use ``code-block`` for console commands, brief examples, and examples -outside the |CL| code base. - -.. code-block:: rst - - .. code-block:: language - - source - -Use ``litteralinclude`` to insert code from a source file. Keep in -mind that you can include the entire contents of the file or just -specific lines. - -.. code-block:: rst - - .. literalinclude:: ../path/to/file/file_name.c - :language: c - :lines: 5-30, 32, 70-100 - :emphasize-lines: 3 - :linenos: - -.. caution:: - The ``:emphasize-lines:`` option uses the line numbering provided - by ``:linenos:``. The emphasized line in the template will be the - third one of the example but the eighth one of the source file. - diff --git a/source/clear-linux/reference/collaboration/documentation/contents.rst b/source/clear-linux/reference/collaboration/documentation/contents.rst deleted file mode 100644 index 248053b4..00000000 --- a/source/clear-linux/reference/collaboration/documentation/contents.rst +++ /dev/null @@ -1,40 +0,0 @@ -.. _contents: - - -Contents directive -################## - -For |CL-ATTR| documentation that has three or more sections, use the `contents::` -directive as shown in the example below. This directive automatically captures the headings (and -subheadings if used) as specified in the value given after `:depth:`. Adding this directive to -longer documents allows users to quickly navigate to the desired section. - -.. contents:: :local: - :depth: 2 - -.. code-block:: bash - - .. contents:: :local: - :depth: 2 - -.. note:: - - Assure that you add `:local:` as the value. For more resources on this directive, - visit the `reStruturedText Directives`_ - -EXAMPLE: - -Guide Example -************* - -Introduction -============ - -Step-by-Step -============ - -Launch -====== - - -.. _reStruturedText Directives: http://docutils.sourceforge.net/0.4/docs/ref/rst/directives.html#table-of-contents diff --git a/source/clear-linux/reference/collaboration/documentation/cross.rst b/source/clear-linux/reference/collaboration/documentation/cross.rst deleted file mode 100644 index 6780dde1..00000000 --- a/source/clear-linux/reference/collaboration/documentation/cross.rst +++ /dev/null @@ -1,153 +0,0 @@ -.. _cross: - -Cross-references -################ - -Sphinx provides different methods to create both internal and -external cross-references. Use only the following methods to increase the -consistency of the documents. - -.. _internal-cross: - -Internal cross-references -************************* - -An internal cross-reference is a reference to a location within the |CL-ATTR| -documentation. Use explicit markup labels and the ``:ref:`` role to create -cross references to headings, figures, and code examples as needed. Every -file must have a label before the title, which is identical to the file's -name, in order to be be cross-referenced within the entire documentation. - -Labels' naming conventions: - -* Ensure the label is unique throughout the documentation - -* Use only full words. - -* Use \- to link multiple words. - -* Use only as many words as necessary. - -These are some examples of proper labels: - -.. code-block:: rst - - .. _quick-start: - - .. _gerrit-access: - - .. _building-clear-linux: - -Do not use labels like these: - -.. code-block:: rst - - .. _QuickStart: - - .. _How to Gain Access to Gerrit: - - .. _building: - -As an example, this is an internal reference to the beginning of the :ref:`rest`. - -Observe that the ``:ref:`` role is replaced with the title's text. -Similarly, it will be replaced with the figure's caption. If a different -text is needed the ``:ref:`` role can still be used, for example: - -This is an internal reference to the beginning of -:ref:`this section `. - -Use the following templates to insert internal cross references properly. - -.. code-block:: rst - - .. _label-of-target: - - This is a heading - ----------------- - - This creates a link to the :ref:`label-of-target` using the text of the - heading. - - This creates a link to the :ref:`target ` using the word - 'target' instead of the heading. - -The template renders as: - -.. _label-of-target: - -This is a heading ------------------ - -This creates a link to the :ref:`label-of-target` using the text of the -heading. - -This creates a link to the :ref:`target ` using the word -'target' instead of the heading. We use the term 'target' here similar to -the way'anchor' is used in HTML. - -.. note:: - - This type of internal cross reference works across multiple files, is - independent of changes in the text of the headings, and works on all - Sphinx builders. - -External References -******************* - -External references or hyperlinks can be added easily with reST. Only -hyperlinks with a separated target definition are allowed. - -Do not use explicit hyperlinks consisting entire URLs. For example, links -like this one, https://clearlinux.org/ must be avoided. - -Hyperlinks with a separated target definition allow us to place the URL after -label. They are easier to update and independent of the text, for example: - -`Gitg`_ is a great tool to visualize a GIT tree. - -.. _Gitg: https://wiki.gnome.org/Apps/Gitg/ - -Follow these guidelines when inserting hyperlinks: - -* The labels for hyperlinks must be grammatically correct and unique within - the file. - -* Do not create labels for hyperlinks using: link, here, this, there, etc. - -* Add all target definitions at the end of the file containing the - hyperlinks. - -Use this template to add a hyperlink with a separated definition: - -.. code-block:: rst - - The state of `Oregon`_ offers a wide range of recreational activities. - -The include directive -********************* - -|CL| documentation also uses the ``.. include::`` -directive to include a portion of another reST file. - -Use the ``.. include::`` directive to show a select portion of a file. - -.. code-block:: console - - .. include:: rest.rst - :start-after: incl-restructured-text-overview: - :end-before: incl-restructured-text-overview-end: - -In this example, note that you must: - -* Create a `target` that appears directly above a header (ease of inclusion) -* Ensure that the target is unique, as explained in :ref:`target ` -* Use a `:` at the end of the value of `start-after` and `end-before`. - -Use of the ``.. inclusion::`` for :ref:`rest` is shown below. - -.. include:: rest.rst - :start-after: incl-restructured-text-overview: - :end-before: incl-restructured-text-overview-end: - -.. _Oregon: http://traveloregon.com/ diff --git a/source/clear-linux/reference/collaboration/documentation/documentation.rst b/source/clear-linux/reference/collaboration/documentation/documentation.rst deleted file mode 100644 index 15056a84..00000000 --- a/source/clear-linux/reference/collaboration/documentation/documentation.rst +++ /dev/null @@ -1,139 +0,0 @@ -.. _documentation: - -Documentation contribution guidelines -##################################### - -The |CL-ATTR| documentation contribution guidelines provide detailed information -about the scope and purpose of the documentation, the accepted writing style, -and the markup used. - -The |CL| documentation is hosted in GitHub and welcomes community -contributions. This guide provides rules to write -:ref:`clear, concise`, and :ref:`consistent content`. Our -documentation is written using ReStructuredText and we provide -:ref:`examples, templates, and best practices` for that markup. - -To contribute, follow the standard `GitHub flow`_: - -#. Clone the `Clear Linux documentation repository`_. - -#. Create your own fork of the repository. - -#. Create a branch for your contribution. - -#. Add your commits. - -#. Open a pull request. - -#. Discuss, review, and update your contributions. - -#. Once the maintainer approves, your contribution is merged and published as - part of the `documentation section`_. - -The |CL| technical content is written in simple American English and our -:ref:`language` contains detailed information on that standard. - -This guide includes the following sections: - -.. toctree:: - :maxdepth: 3 - - basic - structures - rest - language - - -Scope -***** - -The |CL| documentation is divided in five sections: - -* **Get started:** Information about installing Clear Linux. -* **Concepts:** Detailed technical information about our features. -* **Guides:** Step-by-step instructions to complete common tasks and - configuration. -* **Tutorials:** Step-by-step instructions to complete the installation and - configuration of the tools needed for a specific use case. -* **Reference:** Information providing additional context or details. - -If you are unsure on which section to use for your contribution, send an -email to our `mailing list`_ at: dev@lists.clearlinux.org Include the outline -of the contribution you are planning and a brief description of its intended -purpose and scope. - -This style guide applies to the following technical content: - -* Commit messages -* Technical presentations -* All documents in ReStructuredText within and without the documentation - repository -* In-code comments -* Release notes - -We are always grateful to receive content contributions and are happy to help -via our mailing list or our IRC channel, #clearlinux. If you have found a -problem with one of our documents, please file a `bug report`_. - -Tone and audience -***************** - -The tone of the |CL| documentation should be clear, concise, confident, and -courteous. We write for our peers and want to be familiar. Use the second -person, you or we, and active voice, we configure or you run, for example. -Remain professional in your writing and carry an undertone of cordiality, -respect, and cooperation. - -Assume your audience has about the same level of technical understanding and -expertise as you did when you first started collaborating. Do not talk down -to our readers but do not assume they know everything about the subject. -Offer brief explanations or summaries of "common knowledge" if a -significant portion of readers might benefit. - -All contributions must follow our `code of conduct`_. - -Methodology -*********** - -This guide differs from other style guides and contains additional material -not found in those sources. - -To research a style question, look for the answer in this guide -first. If the question is not answered here, send your question to the -`mailing list`_ at: dev@lists.clearlinux.org. - -If the question is answered in the existing style guide or dictionary, -the solution is implemented and enforced as described. - -References -********** - -In creating and refining the policies in this document, we consulted the -following sources for guidance: - -* The Chicago Manual of Style (15th edition), The University of - Chicago Press; -* Merriam-Webster Dictionary; -* Microsoft Manual of Style for Technical Publications, Microsoft - Press; -* Microsoft Press Computer Dictionary, Microsoft Press; and -* Read Me First!, Oracle Technical Publications. - -These sources do not always concur on questions of style and usage; nor do we -always agree with these sources. In areas where there is disagreement, the -decisions are explained in the respective section. - -This guide takes precedence over all other style guides in all cases. In -cases where the guide does not address the issue at hand, please report the -issue to the `mailing list`_ using our `bug report`_. - -Use the Merriam-Webster's Collegiate Dictionary to determine correct -spelling, hyphenation, and usage. - -.. _mailing list: https://lists.clearlinux.org/mailman/listinfo/dev -.. _GitHub flow: https://guides.github.com/introduction/flow/ -.. _documentation section: https://clearlinux.org/documentation -.. _Clear Linux documentation repository: - https://github.com/clearlinux/clear-linux-documentation -.. _bug report: https://github.com/clearlinux/distribution/issues -.. _code of conduct: https://clearlinux.org/community/code-of-conduct diff --git a/source/clear-linux/reference/collaboration/documentation/figures/fibers-1.svg b/source/clear-linux/reference/collaboration/documentation/figures/fibers-1.svg deleted file mode 100644 index 288b2ca9..00000000 --- a/source/clear-linux/reference/collaboration/documentation/figures/fibers-1.svg +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - Fibers - - - - diff --git a/source/clear-linux/reference/collaboration/documentation/grammar.rst b/source/clear-linux/reference/collaboration/documentation/grammar.rst deleted file mode 100644 index 037ec965..00000000 --- a/source/clear-linux/reference/collaboration/documentation/grammar.rst +++ /dev/null @@ -1,342 +0,0 @@ -.. _grammar: - -Grammar guide -############# - -This guide provides valuable insight into the correct grammar for the -|CL-ATTR| documentation. It covers subjects such as capitalization, verbs, -hyphenation, possessives, and contractions. - -Capitalization -************** - -The preferred capitalization style for all documentation is sentence -case. - -Words should only be capitalized when: - -* They are proper nouns or adjectives. -* They refer to trademarked product names. - -.. note:: - Do not capitalize a word to indicate it has a greater status than other - words. Never change the case of variable, function or file names; always - keep the original case. - -Menu capitalization -=================== - -When referring to software menu items by name, replicate the -capitalization as it appears in the software menus the user will see. -It is acceptable to refer to these items generically by using -lowercase letters if it is clear that your reference is generic and -not a specific name of a window or field on a menu, for example: - -Click :guilabel:`Edit` to display the :guilabel:`Widget Configuration` window. - -The widget configuration window has several advanced widget configuration -options. - -The second sentence could have capitalized the term "Widget -Configuration window"; but there are times when you might want to -refer to something with a generic descriptor and not its name. Observe -the use of the ReST markup ``:guilabel:`` on the first sentence. - -A few other menu capitalization rules to keep in mind: - -* Use "Select :menuselection:`File --> New`." - -* Put the option to be selected last. "Select - :menuselection:`View --> Side Bar --> Hide Side Bar`" - -* Do not include more than 3 navigation steps in a menu selection. If - more than three steps are needed divide the steps using - ``:guilabel:`` or ``:menuselection:``. For example: "Go to - :guilabel:`File` and select - :menuselection:`Print --> Print Preview --> Set Up`." - -Software version capitalization -=============================== - -Do not capitalize the word version or letter v when listing software -or hardware version numbers. The v is lowercase and closed with the -number (no period). For example: - -* Widget Pro v5.0 -* Widget Master v2.1.12 - -Hyphenated or slashed-concatenated terms -======================================== - -For hyphenated or slash-concatenated terms, capitalize only the first -letter, even if they are headings. For example: - -* Day/night Menu -* Follow-up Action Items - -Plurals and possessives -*********************** - -Because English plurals and possessives use the same /s/ and /z/ -phonemes, they can create problems for even experienced writers. This -section deals with these issues. - -Singular vs. plural possessives -=============================== - -Here are some guidelines for singular and plural possessives: - -* Use only the apostrophe to show possession for a plural that ends in - s: The boys' books. - -* Use apostrophe + s to show possession for a plural that does not end - in s: The men's books. - -* Use apostrophe + s to show possession for a singular that ends in a - silent sibilant: Illinois's capital. - -* Use apostrophe + s to show - possession for a singular that ends in a sibilant; s, x, c, z, or - others. - -The following table provides some examples with the correct and -incorrect cases and the notes that accompanies them. - -+-------------------+------------------+---------------------------+ -| Correct | Incorrect | Notes | -+===================+==================+===========================+ -| the boys' books | the boy's books | The books that belong to | -| | | several boys. | -+-------------------+------------------+---------------------------+ -| the men's books | the mens' books | The books that belong to | -| | | several men. | -| | | | -+-------------------+------------------+---------------------------+ -| Arkansas's code | Arkansas' code | The s at the end of | -| | | Arkansas is silent and | -| | | Arkansas is not a plural. | -+-------------------+------------------+---------------------------+ -| the boss's office | the boss' office | We say: "the /BOSS-iz/ | -| | | office" not "the/BOSS/ | -| | | office." | -+-------------------+------------------+---------------------------+ -| the box's lid | the boxe's lid | One could say "the box | -| | the box' lid | lid," avoiding the | -| | | possessive. | -+-------------------+------------------+---------------------------+ -| Lopez's average | Lopez' average | We say "/LO-pez-iz/ | -| | | average," not "/LO-pez/ | -| | | average." | -+-------------------+------------------+---------------------------+ -| business's sales | business' sales | If you pronounce another | -| | | syllable to show | -| | | possession, it must have | -| | | the apostrophe-s. | -+-------------------+------------------+---------------------------+ - -Apostrophe-s anomalies -====================== - -If a company name ends in s, x, c, or a sibilant sound, use the -apostrophe-s ending for -possessives: - -Traktronix's oscilloscopes - -Exception: If the company name is intended as a plural, we allow the -apostrophe-only ending: - -Tejada Instruments' calculators - -In many cases, it is actually best to avoid the possessive form -altogether for s-ending singular possessives, such as for company -names and use the company name as a nonpossessive modifier instead: - -Traktronix oscilloscopes -Tejada Instruments calculators - -We say "Intel equipment" when discussing Intel-branded products, not -"Intel's equipment", which implies that we own it, not that we produce -it. "Intel's equipment" sounds like the equipment that Intel employees -use. - -Plural modifiers -================ - -Avoid plural modifiers. For example, it should be a system -administrator, not a systems administrator. It doesn't matter how many -systems this person manages, we don't typically use the plural of a word -to modify a noun. Here is a list of exceptions: - -* operations manager -* sales department -* graphics team - - -There are always exceptions, especially when the plural form is -generally considered to be singular: sales, physics, operations. It is -best to adhere to this rule and ask if you are unsure. - -Parenthetical plurals -===================== - -Do not parenthesize optional plurals, whether added to the end of a -word, typically with the letter s, or internally. In general, think in -plurals when you write, assume that the user understands that a plural -could mean a singular as well. A typical user who has only one unit -will not be confused if you say "connect the units." On the contrary, -using parenthetical plurals often creates more confusion. - -Correct - -Men, women, children, college alumni, moose, -and even desert plants such as cacti should not -use parentheses around plurals. - -Incorrect - -A m(e)n, wom(a)n, a child(ren), college alumn(i), (moose), and -even a desert plant(s) such as a cact(i) should not use a -parenthes(e)s around a plural(s). - -Internal plural acronyms -======================== - -Some abbreviated terms can cause trouble, particularly when the -pluralized portion does not fall at the end of the phrase. These -internal-plural words should follow standard English pluralization -rules when abbreviated: The plural goes at the end of the term. - -* Alarms acknowledged and logged: AAL, AALs. -* Attorneys-general: AG, AGs. -* Regions of interest: ROI, ROIs. - -Plurals of acronyms and capitalized product names -================================================= - -Pluralize acronyms, initialisms, and capitalized product names by -adding a lowercase s; do not use an apostrophe. If the term ends in a -sibilant (s, x, z, sometimes c and others), pluralize it by adding a -lowercase es. Examples: - -Use TVs, DVDs, CDs, DVMRs not TV's, DVD's, CD's, DVMR's. -Use OSes not OSs, OS's. -Use TRAXes, iBOXes not TRAXs, TRAX's, iBOX's, iBOXs. -Use FAACes not FAAC's, assuming it is pronounced "face". -Use FAACs not FAAC's Assuming it is pronounced "fake". - -Whenever you hear the extra syllable in the plural, add the -es suffix -for the plural; if you do not hear the extra syllable, add the -s -suffix for the plural. - -Latin plurals -============= - -Pluralize Latin terms in body text as shown: - -* Use appendixes not appendices. -* Use matrixes not matrices. -* Use indexes not indices. -* Use vertexes not vertices. - -.. note:: - Some Latin plurals, such as parentheses, phenomena, alumni, and - crises, are widely used and accepted in English. - -Contractions -************ - -Avoid the use of contractions since some of them might be ambiguous and -confusing to non-native English-speaking audiences. - -Some contractions can cause confusion for non-native English-speakers -because these contractions stand for more than one construction. For -example, there's can be a contraction of there is or there has. The -same applies to where's, it's, that's, and others. - -Also, avoid contractions of the word is, especially when combined with -company or product names: Say, WidgetPro is an awesome product; not -WidgetPro's an awesome product. - -Hyphenation -*********** - -The hyphen is often used to join words together to form a compound noun. -Compound nouns often go through this progressions: - -* open compound: health care -* hyphenated compound: health-care -* closed compound: healthcare - -The English language is trending away from hyphenated compounds to -closed compounds. - -Prefix hyphenation -================== - -Do not hyphenate the prefixes listed below. Join the prefix to the -term being modified, even if this results in a double vowel or double -consonant: - -ante, counter, intra, mini, pro, super, anti, extra, meta, non, -pseudo, trans, bi, by, infra, micro, post, re, ultra, bio, inter, mid, -pre, sub, un. - -Here are some words that are often inappropriately hyphenated; do not -hyphenate these words either: - -antitheft device, multicamera, multiscreen, prepackaged, reuse, -submenu, autofocus, multifamily, multiuser, pseudoscience, semiannual, -subtotal, autoiris, multimedia, nonprofit, reengineered, semicircle, -superuser, microarchitecture, multiposition, predefined, reevaluate, -subfolder, superscript, microorganism, multiprotocol, predrilled, -reinvent, submarine. - -.. note:: - Question whether the pre- prefix is needed at all and consider - leaving it off the word entirely if the meaning is the same. - -Exceptions ----------- - -One overriding exception to the prefix rule is when the prefix is -prepended to a proper and capitalized noun: - -* Non-European -* Mid-April (but: midweek) - -Another exception is when the second word of a compound is a numeral: - -* Pre-1914 - -Some prefixes, such as self-, half-, quasi-, and ex-, when meaning -"formerly", usually need a hyphen: - -* Self-control, half-truth, quasi-corporation, ex-governor - -Suffix hyphenation -================== - -In general, do not hyphenate suffixes. Here are some examples. -The suffix -wide is usually not hyphenated: - -* Nationwide, worldwide, systemwide, campuswide, statewide, - companywide, etc. - -The suffix -wise is usually not hyphenated: - -* Otherwise, businesswise, revenuewise, clockwise, counterclockwise - - -Quotation marks -*************** - -Follow these guidelines for quotation marks: - -* Restrict use of quotation marks to terms as terms. -* Do not use quotation marks for emphasis; use *italics* for emphasis. -* Avoid using single-quote marks. -* In terms of punctuation: commas and periods typically go inside the - end-quote; semicolons, colons, question marks, and exclamation points - typically go outside quotation marks. Unless they are part of the - actual quotation. \ No newline at end of file diff --git a/source/clear-linux/reference/collaboration/documentation/headings.rst b/source/clear-linux/reference/collaboration/documentation/headings.rst deleted file mode 100644 index 6f1d584d..00000000 --- a/source/clear-linux/reference/collaboration/documentation/headings.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. _headings: - -Headings -######## - -Descriptive and brief headings are crucial to the quality of the -documentation. Sphinx uses the headings within the -:abbr:`ReST (RestructuredText)` files to generate the navigation of the HTML -output and the outlines of the PDF files. The |CL-ATTR| publishes the -documentation as HTML making consistent heading levels extremely important. - -In addition to the title of the file, only three levels of headings are -accepted. The following example shows all accepted levels of headings: - -.. code-block:: rst - - Title - ##### - - Level 1 sections - **************** - - Level 2 sections - ================ - - Level 3 sections - ---------------- - -Headings must be written in sentence case. Learn more about the correct -capitalization in our :ref:`grammar guide`. diff --git a/source/clear-linux/reference/collaboration/documentation/hello.c b/source/clear-linux/reference/collaboration/documentation/hello.c deleted file mode 100644 index 079db353..00000000 --- a/source/clear-linux/reference/collaboration/documentation/hello.c +++ /dev/null @@ -1,188 +0,0 @@ -/** @file - @brief Hello World Demo - - A Hello World demo for the Nanokernel and the Microkernel. - */ - -/* - * Copyright (c) 2012-2014 Wind River Systems, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -/** CONFIG_MICROKERNEL - The microkernel hello world demo has two tasks that use semaphores - and sleeps to take turns printing a greeting message at a - controlled rate.*/ - -/** #else || CONFIG_NANOKERNEL - * The nanokernel hello world demo has a task and a fiber that use - * semaphores and timers to take turns printing a greeting message at - * a controlled rate. - */ - -/** - * @def SLEEPTICKS (SLEEPTIME * sys_clock_ticks_per_sec / 1000) - * @brief Compute equivalence in ticks. - */ -/** - * @def SLEEPTIME - * @brief Specify delay between greetings (in ms). - */ - -#if defined(CONFIG_STDOUT_CONSOLE) -#include -#define PRINT printf -#else -#include -#define PRINT printk -#endif - -#ifdef CONFIG_MICROKERNEL - -#include - -#define SLEEPTIME 500 -#define SLEEPTICKS (SLEEPTIME * sys_clock_ticks_per_sec / 1000) - -/** - * @brief A loop saying hello. - * - * @details - * Actions: - * -# Ouputs "Hello World!". - * -# Waits, then lets another task run. - - @param taskname The task's identification string. - @param mySem The task's semaphore. - @param otherSem The other task's semaphore. - */ -void helloLoop(const char *taskname, ksem_t mySem, ksem_t otherSem) -{ - while (1) - { - task_sem_take (mySem, TICKS_UNLIMITED); - - PRINT ("%s: Hello World!\n", taskname); /* Action 1 */ - - task_sleep (SLEEPTICKS); /* Action 2 */ - task_sem_give (otherSem); - } -} - -/** - * @brief Exchanges Hello messages with taskB. - * - * @details - * Actions: - * -# taskA gives its own semaphore, thus it says hello right away. - * -# Calls function helloLoop, thus taskA exchanges hello messages with taskB. - */ -void taskA(void) -{ - task_sem_give (TASKASEM); /* Action 1 */ - - helloLoop (__FUNCTION__, TASKASEM, TASKBSEM); /* Action 2 */ -} - -/** - * @brief Exchanges Hello messages with taskA. - * - * Actions: - * -# Calls function helloLoop, thus taskB exchanges hello messages with taskA. - */ -void taskB(void) -{ - helloLoop (__FUNCTION__, TASKBSEM, TASKASEM); /* Action 1 */ -} - -#else - -#include -#include - -#define SLEEPTIME 500 -#define SLEEPTICKS (SLEEPTIME * sys_clock_ticks_per_sec / 1000) - -#define STACKSIZE 2000 - -/** Declares a stack for a fiber with a size of 2000.*/ -char fiberStack[STACKSIZE]; - -/** Declares a nanokernel semaphore for a task. */ -struct nano_sem nanoSemTask; - -/** Declares a nanokernel semaphore for a fiber.*/ -struct nano_sem nanoSemFiber; - -/** - * @brief Defines the turns taken by the tasks in the fiber. - * - * Actions: - * -# Initializes semaphore. - * -# Initializes timer. - * -# Waits for task, then runs. - * -# Outputs "Hello World!". - * -# Waits, then yields to another task. - */ -void fiberEntry(void) { - struct nano_timer timer; - uint32_t data[2] = { 0, 0 }; - - nano_sem_init(&nanoSemFiber); /* Action 1 */ - - nano_timer_init(&timer, data); /* Action 2 */ - - while (1) { - - nano_fiber_sem_take(&nanoSemFiber, TICKS_UNLIMITED); /* Action 3 */ - - PRINT("%s: Hello World!\n", __FUNCTION__); /* Action 4 */ - - nano_fiber_timer_start(&timer, SLEEPTICKS); /* Action 5 */ - nano_fiber_timer_test(&timer, TICKS_UNLIMITED); - nano_fiber_sem_give(&nanoSemTask); - } -} - -/** - * @brief Implements the Hello demo. - * - * Actions: - * -# Outputs "hello". - * -# Waits, then signals fiber's semaphore. - * -# Waits on fiber to yield. - */ -void main(void) { - struct nano_timer timer; - uint32_t data[2] = { 0, 0 }; - - task_fiber_start(&fiberStack[0], STACKSIZE, (nano_fiber_entry_t) fiberEntry, - 0, 0, 7, 0); - - nano_sem_init(&nanoSemTask); - nano_timer_init(&timer, data); - - while (1) { - - PRINT("%s: Hello World!\n", __FUNCTION__); /* Action 1 */ - - nano_task_timer_start(&timer, SLEEPTICKS); /* Action 2 */ - nano_task_timer_test(&timer, TICKS_UNLIMITED); - nano_task_sem_give(&nanoSemFiber); - - nano_task_sem_take(&nanoSemTask, TICKS_UNLIMITED); /* Action 3 */ - } -} - -#endif diff --git a/source/clear-linux/reference/collaboration/documentation/images.rst b/source/clear-linux/reference/collaboration/documentation/images.rst deleted file mode 100644 index c631f15d..00000000 --- a/source/clear-linux/reference/collaboration/documentation/images.rst +++ /dev/null @@ -1,88 +0,0 @@ -.. _images: - -Images -###### - -Images or figures grab the reader's attention and convey information that -sometimes is difficult to explain using words alone. Well-planned graphics -reduce the amount of text required to explain information. Non-native English -readers rely heavily on graphics because graphics enhance their understanding of the text. - -Follow these guidelines when creating graphics for the |CL-ATTR|: - -* Save the image files in a :file:`figures` folder. The folder must be found - at the same level as the file containing the text. - -* Use only lower case letters for image filenames. - -* Separate multiple words in filenames using dashes. - -* Name figures with the filename of the file they appear on and add a number - to indicate their place in the file. For example: The third figure added to - the :file:`fibers.rst` file must be named :file:`fibers-3.png`. - -* Include a caption describing the figure's content and to use as a reference. - All figures must have a caption. - -* Use cross-references. Refer to your graphics in the main text flow. - Create a label using the filename of the image. Use the `:ref:` role to place - the cross reference, see :ref:`cross` for more details. - -* Place the figure immediately after its reference in the text flow or as - close as possible. - -* Keep figures simple. They should only contain the information the - reader needs. - -* Use figures judiciously. Don't use superfluous graphics and don't - use graphics as mere decorations. They must have purpose. You don't - need to show a screenshot of every single step or window in a software - installation procedure, for example. - -* Avoid volatility. Don't incorporate information into a graphic that - might change with each release, for example: product versions or - codename abbreviations. - -* Use only approved image formats. Use either PNG or JPEG bitmap files for - screenshots and SVG files for vector graphics. If a figure is not a - photograph or screenshot, use the vector graphic file format to ensure - the figure can be changed later. - - -Examples -******** - -These examples follow the guidelines and can be used as a reference. - -The fiber context is represented in the diagram either as a box -containing different objects or a :ref:`symbol `. - -.. _fibers-1.svg: - -.. figure:: figures/fibers-1.svg - :scale: 75 % - :alt: Fibers Execution Context Symbol - - The graphic representation of the fibers execution context. - - This symbol is used to illustrate the actions performed by the - abstract fibers execution context. - -Templates -********* - -Use this template to add a figure to your documentation according to -these guidelines. - -.. code-block:: rst - - .. _file-name-#.ext: - - .. figure:: figures/file-name-#.ext - :scale: 75% - :alt: Alternative text. - - Figure 1: Brief caption detailing the contents of the image. - - Any additional explanation, description or actions depicted in the - image. It can encompass multiple lines. diff --git a/source/clear-linux/reference/collaboration/documentation/inline.rst b/source/clear-linux/reference/collaboration/documentation/inline.rst deleted file mode 100644 index a4ccfe91..00000000 --- a/source/clear-linux/reference/collaboration/documentation/inline.rst +++ /dev/null @@ -1,162 +0,0 @@ -.. _inline: - -Inline Markup -************* - -Sphinx supports a large number of inline markup elements called roles. The -|CL-ATTR| documentation encourages the use of as many roles as -possible. Thus, you can use any additional roles supported by Sphinx -not listed here. Please refer to the `Sphinx reStructuredText Markup`_ -documentation for the full list of supported roles. - -The following markup is required in every instance unless otherwise -specified. Each item provides a syntax example followed by the rendered -result. - -Abbreviations - Use the `:abbr:` abbreviation role to define an acronym or an initialism. - Add the abbreviation markup only once per file. After the abbreviation, the - acronym can be used without further definition or markup. Do not use - abbreviation markup on headings. - - :: - - :abbr:`API (Application Program Interface)` - - .. parsed-literal:: - - :abbr:`API (Application Program Interface)` - -OS Commands - Use the `:command:` role when the name of a specific command is used in a - paragraph for emphasis. Use the ``.. code-block::`` directive for fully - actionable commands in a series of steps. - - :: - - :command:`make` - - .. parsed-literal:: - - :command:`make` - -Commandline Options - In most cases, use asterisks "*" to emphasize the name of a command - option. - - :: - - Use the *-p* option to print the file. - - .. parsed-literal:: - - Use the *-p* option to print the file. - - However, if you have defined an ``.. option::`` directive, you may - use the `:option:` role. Note that the result links back to the - option definition. - - .. code-block:: rest - - .. option: -o - - Description of the -o option - - The :command:`pandoc` command can be used without :option:`-o` - - .. option:: -o - - Description of the -o option - - .. parsed-literal:: - - The :command:`pandoc` command can be used without :option:`-o` - -Files - Use the `:file:` role to emphasize a filename or directory. Do not use the - role inside a code-block but use it inside all notices that contain files - or directories. Place variable parts of the path or filename in brackets - `{}`. - - .. code-block:: rest - - :file:`collaboration.rst` - - :file:`doc/{user}/collaboration/figures` - - .. parsed-literal:: - - :file:`collaboration.rst` - - :file:`doc/{user}/collaboration/figures` - -GUI Objects - Use the `:guilabel:` role to emphasize elements of a graphic - user interface within a description. It replaces the use of quotes - when referring to windows' names, button labels, options, or single - menu elements. Always follow the marked element with the appropriate - noun. For example: - - :: - - In the :guilabel:`Tools` menu, click :guilabel:`settings`. - - .. parsed-literal:: - - In the :guilabel:`Tools` menu, click :guilabel:`settings`. - -Menu Navigation - Use the `:menuselection:` role to indicate the navigation through a menu - ending with a selection. Every `:menuselection:` element can have up to two - menu steps before the selected item. If more than two steps are required, - it can be combined with a `:guilabel:` or with another `:menuselection:` - element. For example: - - :: - - Go to :guilabel:`File` and select :menuselection:`Import --> Data Base --> MySQL`. - - Go to :menuselection:`Window --> View` and select :menuselection:`Perspective --> Other --> C++` - - .. parsed-literal:: - - Go to :guilabel:`File` and select :menuselection:`Import --> Data Base --> MySQL`. - - Go to :menuselection:`Window --> View` and select :menuselection:`Perspective --> Other --> C++` - -Makefile Variables - Use the `:makevar:` role to emphasize the name of a Makefile variable. - The role can include only the name of the variable or the variable - plus its value. - - :: - - :makevar:`PLATFORM_CONFIG` - - :makevar:`PLATFORM_CONFIG=basic_atom` - - .. parsed-literal:: - - :makevar:`PLATFORM_CONFIG` - - :makevar:`PLATFORM_CONFIG=basic_atom` - -Environment Variables - Use the `:envvar:` role to emphasize the name of environment - variables. Just as with `:makevar:`, the markup can include only the - name of the variable or the variable plus its value. - - :: - - :envvar:`ZEPHYR_BASE` - - :envvar:`QEMU_BIN_PATH=/usr/local/bin` - - .. parsed-literal:: - - :envvar:`ZEPHYR_BASE` - - :envvar:`QEMU_BIN_PATH=/usr/local/bin` - -.. _Sphinx reStructuredText Markup: - http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html \ No newline at end of file diff --git a/source/clear-linux/reference/collaboration/documentation/language.rst b/source/clear-linux/reference/collaboration/documentation/language.rst deleted file mode 100644 index ba2abe49..00000000 --- a/source/clear-linux/reference/collaboration/documentation/language.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. _language: - -Language reference guide -######################## - -This section describes acceptable usage of the English language in the -|CL-ATTR| documentation. It includes information about words use, -punctuation, and grammar. This guide does not replace a professional -writer's review but is intended to help collaborators submit consistent -contributions. - -To make translations easier and to make the content accessible to non-native -speakers, |CL-ATTR| uses Simple English. However, we have not implemented any -controlled language standards. - -.. toctree:: - :maxdepth: 2 - - simple - grammar - punctuation - - - - - diff --git a/source/clear-linux/reference/collaboration/documentation/lists.rst b/source/clear-linux/reference/collaboration/documentation/lists.rst deleted file mode 100644 index 6f43ec77..00000000 --- a/source/clear-linux/reference/collaboration/documentation/lists.rst +++ /dev/null @@ -1,112 +0,0 @@ -.. _lists: - -Lists -##### - -We use two types of lists: numbered lists and bulleted lists. Use a -numbered, or ordered, list when the order or priority of the items is -important. Use a bulleted, or unordered, list when the order of the -items is not important. - -For both kinds of list, strive to keep all items in the list parallel. -See :ref:`parallelism`. Use a sentence style, making all the list items -sentences. - -Numbered Lists -************** -Numbered (ordered) lists are most frequently used for procedures. Use -numbered lists to show sequence for the items. Here are some guidelines -for numbered lists: - -* Make sure the list is sequential in nature and not simply a - collection of items. -* Introduce a numbered list with a sentence setup text. End the setup - fragment or sentence with a colon. Example: To configure the unit, do - the following: -* Each item in the list should be parallel. -* Without exception, treat numbered list items as full sentences and - end each list entry with a period, a colon, or a comma - when the entries - are complete sentences or a mixture of fragments and sentences. In - cases where the entries are short imperative sentences introducing - commands or code, end them with colons. -* You may interrupt numbered lists with other paragraph styles, if the - interruption is some explanatory text, commands, or code. -* Second-level steps are acceptable; avoid third-level steps. -* Avoid single-step procedures; the minimum number of steps in a - procedure is two. -* Do not create numbered lists that emulate flowcharts. The reader - should be able to execute the list of steps from first to last - without branching or looping. -* Avoid over-using numbered lists, except in procedural documents such as - tutorial and step-by-step guides. -* Use the `#` symbol for all list items. Use a three-space indentation for - second-level items and for the explanatory text, commands, or code. Example: - -#. Open the door. - -#. Enter the room. - - The room you enter may be dark. If it is not equipped with a motion - sensor that triggers a light, you might want to turn on a light to - avoid tripping over furniture. - -#. Make a call. - - #. Pick up the receiver. - - #. Dial a number. - - #. Talk to the other party or leave a message. - - #. Hang up. - -#. Turn off the light. - -#. Leave the room. - -Bulleted Lists -************** -Use bulleted, or unordered, lists to reduce wordiness and paragraph -density, particularly when a sequence is not required. Here are some -guidelines for bulleted lists: - -* Introduce a bulleted list with a sentence. End the setup text with a - colon. Example: To repair the unit, you will need the following: -* Each item in the list should complete the setup sentence staying - parallel. -* Avoid interrupting bulleted lists with other paragraph styles. -* Second-level bullets are acceptable; avoid third-level bullets. - -Use sentence style bullet lists. - -Sentence style bullet lists are punctuated like sentences because all -items in the list are sentences. End all bullets with a period or a -colon if the bullet introduces a second level list. For example: - -**Incorrect** - -When setting the user code remember: - -* make the user code easy to remember. Use a number that has a meaning - for you -* change the code once a month -* do not disclose the user code to anyone else. This includes the - security company - -**Correct** - -When setting the user code, it is important to remember a few things: - -* Use a number that has a meaning for you. -* Change the code once a month. -* Do not disclose the user code to anyone else. This includes the security - company. - -Fragment style bullet lists and presentation style bullet lists are not -acceptable for either in-code documentation or stand alone -documentation. They can only be used for presentations. - -Presentation style bullets have little or no punctuation. They are -typically short phrases or even single words. They often start with a -capital and end with no punctuation, unless they are full sentences. -Use only for presentations. diff --git a/source/clear-linux/reference/collaboration/documentation/notices.rst b/source/clear-linux/reference/collaboration/documentation/notices.rst deleted file mode 100644 index e58cbb83..00000000 --- a/source/clear-linux/reference/collaboration/documentation/notices.rst +++ /dev/null @@ -1,73 +0,0 @@ -.. _notices: - -Notices: notes, cautions, warnings, and dangers -############################################### - -We use four special types of notices: notes, cautions, warnings, and -dangers. Here are some specific rules and tips with regard to these -notices: - -* Do not use a notice directly after a heading. Notices must follow a - variant of body text. -* Avoid back-to-back notices. -* To improve readability, rewrite content to eliminate multiple - notices in a single module. -* If there is no clean way to avoid using back-to-back notices, use a - different style or multiple paragraphs, for example, combine two - notes into one or separate them with body text. - -Notes -***** - -Use notes sparingly. Avoid having more than one note per subsection. If -you exceed this number consistently, consider rewriting the notes as -main body text. Example: - -.. note:: - A note is supposed to provide supplemental information, not - emphasized information. - - - -Cautions, Warnings, and Dangers -******************************* - -Tell readers what will happen if they do not heed cautions or warnings, -circuits will fry, electrical shock may kill you, etc. - -* Use "Caution" to identify hazards resulting in property damage - accidents, including data loss. Also use "Caution" to alert against - unsafe practices. -* Use "Warning" and "Danger" for property damage accidents only if - personal injury risk appropriate to these levels is also involved. - -These are examples of typical notices, the correct syntax and the -conditions for their usage: - -.. note:: - Notes are ancillary bits of information, subordinate to the main - flow. Reserve the note tag for information that does not readily - flow with the main text but which you want to set apart for one - reason or another. Notes should be relatively short. If there is - more than enough information to warrant a short paragraph, - consider rewriting the note as body text. - -.. caution:: - Cautions are low-level hazard messages that alert the user of - possible equipment, product, and software damage, including loss - of data. Cautions typically appear as a yellow triangle with a - black exclamation point. - -.. warning:: - Warnings are mid-level hazards (more serious than cautions) that - are likely to cause product damage as well as bodily injury to - humans. Warnings may appear in a black triangle with orange hazard- - specific graphics for warnings (or with the colors reversed). The - most common warning is for electrical hazards, but there are many - other hazard-specific graphics. - -.. danger:: - Dangers are high-level hazards that are likely to cause product - damage as well as bodily injury and even death to humans. Dangers - use a red triangle with white (and black) hazard-specific - graphics, the same as found on warnings. \ No newline at end of file diff --git a/source/clear-linux/reference/collaboration/documentation/parallelism.rst b/source/clear-linux/reference/collaboration/documentation/parallelism.rst deleted file mode 100644 index 611cd5e4..00000000 --- a/source/clear-linux/reference/collaboration/documentation/parallelism.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. _parallelism: - -Parallelism -########### - -Parallelism refers to the practice of using similar patterns of grammar, and -sometimes length, to coordinate words, phrases, and clauses. - -Parallel construction is especially important in bulleted lists. The table -shows some unparallel structures and how they can be made parallel with a -little rewording. - -+----------------------------------+----------------------------------+ -| Parallel (do) | Unparallel (don't) | -+==================================+==================================+ -| 1. Mount the panel. | 1. Mount the panel. | -| 2. Install the battery. | 2. Battery installation. | -| 3. Wire the keypad. | 3. Wiring the keypad. | -+----------------------------------+----------------------------------+ -| The system sends a message to | The system sent a message to the | -| the call center, which calls the | call center, which calls the | -| customer and tells about the | customer and will tell about the | -| burglary. | burglary. | -+----------------------------------+----------------------------------+ -| The system tried to send alarm | The system tried to send alarm | -| messages that were precise and | messages that had precision and | -| accurate. | were accurate. | -+----------------------------------+----------------------------------+ -| You need to install the panel, | You need to install the panel, | -| wire the sensors, and test the | wire the sensors, and you | -| phone line. | must test the phone line. | -+----------------------------------+----------------------------------+ diff --git a/source/clear-linux/reference/collaboration/documentation/punctuation.rst b/source/clear-linux/reference/collaboration/documentation/punctuation.rst deleted file mode 100644 index f019b1c3..00000000 --- a/source/clear-linux/reference/collaboration/documentation/punctuation.rst +++ /dev/null @@ -1,86 +0,0 @@ -.. _punctuation: - -Punctuation guide -################# - -This section contains all the information regarding the correct use of -punctuation for the |CL-ATTR| documentation. - -Commas, Semicolons, and Colons -****************************** -Here are the most common problems encountered with commas, semicolons, -and colons. Please refer to Merriam-Webster's Collegiate Dictionary -when in doubt. - -Serial Commas -============= - -When writing a series of items, use the serial comma before the -coordinating conjunctions *and* and *or* to avoid confusion and ambiguity. -For example: - -* Mom, Dad, and I are going to the game. -* Mom, Dad and I are going to the game. - -The first example uses the serial comma. It is clear in this sentence -that three people are going to the game. The second example does NOT -have a comma preceding the and. The reader may interpret this as -meaning the same thing as the first sentence, namely that three people -are going to the game, or that the speaker is addressing "Mom" and -telling her that only two people are going to the game. - -Commas in Numbers -================= - -Use commas to divide large numbers into sets of three digits. Use -periods for decimal points. Do not divide decimal digits into sets of -three. - -Do not use a comma to separate four-digit bit/byte numbers. - -Do not use a comma to separate four-digit page numbers. - -Do not use a comma or other punctuation to separate decimals. - - -Semicolons ";" -============== - -Here are some rules governing the use of semicolons: - -* Use semicolons in long, sentence-style bulleted phrase lists. - -* Use semicolons when two equal clauses are joined because of - similarity of construction or meaning. - -* Use semicolons in a series of items when at least one of the items - itself includes a comma. - -Examples of semicolon usage: - -Similar construction: The prewidget comes before the widget; the -postwidget comes after it. - -Comma-inclusive series: We traveled through Casper, Wyoming; Boise, -Idaho; and Eugene, Oregon. - -Colons ":" -========== - -If the text following a colon is a sentence, capitalize the -first word after the colon. If the subsequent text is not a sentence, -do not capitalize the first term unless it is a title. For example: - -* This is a capitalization example: Donuts do not cause holes. - -* These is a noncapitalization example: colons, semicolons, and commas. - -* In a title, use title case following the colon. Example: Tires: How - to Fix a Flat. - -* Use a colon at the end of a sentence or phrase that introduces - examples, a list, a path, user input, or code. - -* Don't use a colon to introduce graphics, tables, or sections. - -* Don't use a colon at the end of a task title or any heading. diff --git a/source/clear-linux/reference/collaboration/documentation/rest.rst b/source/clear-linux/reference/collaboration/documentation/rest.rst deleted file mode 100644 index a64f6a78..00000000 --- a/source/clear-linux/reference/collaboration/documentation/rest.rst +++ /dev/null @@ -1,49 +0,0 @@ -.. _rest: - -RestructuredText guide -###################### - -.. incl-restructured-text-overview: - -Overview -******** - -The |CL-ATTR| uses Sphinx and RestructuredText as authoring tools for its -documentation. This section contains the preferred methods for using the -:abbr:`ReST (RestructuredText)` markup on your documents. Please refer to the -`Sphinx documentation`_ for the complete list of available markup and use -as much markup as possible. - -.. _Sphinx documentation: http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html - -Remember: **Changing incorrect markup is easier than adding markup from -scratch.** - -We provide templates, examples, and use scenarios to help you write and edit -documents easily. Use only the templates provided to ensure your content is -consistent with the rest of the documentation. - -Contributions with incorrect use of markup will not be merged until the -markup is fixed. If you have any questions regarding markup, send an email to -our mailing list at dev@lists.clearlinux.org and we will gladly help. - -To allow for easy copy and paste of the provided templates, -they are provided using either the "\`\`" parenthesis, for single line -templates, or the code-block directive, for multi-lined templates. - -Every use case is explained, examples provided and, lastly, -templates supplied. - -.. incl-restructured-text-overview-end: - -.. toctree:: - :maxdepth: 3 - - headings - inline - tables - cross - images - code - contents - diff --git a/source/clear-linux/reference/collaboration/documentation/simple.rst b/source/clear-linux/reference/collaboration/documentation/simple.rst deleted file mode 100644 index b8ea9773..00000000 --- a/source/clear-linux/reference/collaboration/documentation/simple.rst +++ /dev/null @@ -1,305 +0,0 @@ -.. _simple: - -Simple English -############## - -Simple English is a generic term for communication that emphasizes -clarity, brevity, and avoiding unnecessarily complicated or -technical terms. It encourages writers to create content that is clear -and appropriate to the audience's reading skills and knowledge. - -Simple English improves the clarity of procedural technical writing, -makes translation easier, and improves comprehension for people whose -first language is not English. - -|CL-ATTR| does not use controlled language, which restricts the writer's -vocabulary to a list of approved words. However, we do strongly recommend -using the language principles described below. - -Short sentences and paragraphs -****************************** - -Clear writing should average 15 to 20 words per sentence. This does not -mean every sentence should be the same length. Vary your writing by -mixing short sentences with longer ones, but stick to the basic -principle of one main idea in a sentence, plus one additional point if -needed. - -Similarly, restrict your paragraph length to about six sentences. -Remember the basic structure of a paragraph: Introduction, body, and -conclusion. Both the introduction and the conclusion should be one -sentence long. The body of a paragraph should never exceed four -sentences. Here less is more. - -Simple words -************ - -Choosing simple words increases reader comprehension and reduces -ambiguity. Here are some guidelines on making good simple word choices: - -* Avoid jargon. Jargon is a type of language that is only understood - by a particular group of people, such as an industry or a club. You - can use jargon when writing for an audience who will understand, but - avoid over using it, especially on the general public. -* Be consistent. Use one term for each concept or action and use it - consistently. Don't use a different term for the same object or - action when you refer to it subsequently. -* Keep your style plain but avoid dullness. Avoid clichés, idioms, and - metaphors. Many of these devices are not easily understood across - different cultures and can lead to confusion. -* Avoid "fancy" words and phrases. The goal is to get the information - across, not to impress the reader with your vocabulary, so avoid - bureaucratic, flowery or literary style. Here are some examples of - "formal" words to avoid and preferred "informal" alternatives in - parentheses: - -* commence (start, begin) -* consequently (so) -* in excess of (more than) -* in the event of (if) -* prior to (before) -* should you wish (if you want) -* utilize (use) -* instance (example) - -Strong verbs -************ -The stronger and clearer you can make your verbs, the more directly you -communicate information to your audience. - -Keep these basic guidelines in mind as you check your verbs: - -* Use imperatives. -* Use active voice not passive voice. -* Avoid linking verbs; is, seems, becomes. -* Convert weak verbs and nominalizations to strong verbs. -* Be concise. -* Avoid "there are" and "it is" constructions. - -.. note:: - The examples in the following sections offer two versions of the same - information. The incorrect version always comes first and is formatted *in - italics*. The correct version always comes second and is formatted **in - bold**. - -Imperatives -=========== - -Commands, officially called imperatives, are the fastest and most direct -way of giving someone instructions. Imperatives are an extension of the -second-person pronoun you. The word you is implied. - -Be concise. - -Example: - -*I would appreciate it if you would send it to me.* - -**Send it to me.** - - -Present Tense vs. Future Tense -============================== - -Use simple present tense instead of future tense for most text. Future -tense is acceptable for conditional statements, for example in a -caution or a warning. - -*The system will operate at a nominal temperature of 180 degrees Fahrenheit.* - -**The system operates at a nominal temperature of 180 degrees Fahrenheit.** - -Action Verbs vs. Nominalizations -================================ - -Avoid nominalizations, which are nouns formed from verbs. For example: - -===================== ===================== -Verbs Nominalizations -===================== ===================== -complete completion -introduce introduction -provide provision -fail failure -arrange arrangement -install installation -===================== ===================== - -The problem with nominalizations is that they are often used instead of -the verbs they come from. Because they are merely the names of things, -they sound as if nothing is actually happening in the sentence. Like -passive verbs, too many of them make writing very dull and heavy-going. - -Here are some examples. - -*We had a discussion about the matter.* - -**We discussed the matter.** - -*The blizzard will cause a stoppage of the trains.* - -**The blizzard will stop the trains.** - -*IT has completed the installation of the software.* - -**IT has installed the software.** - -Infinitives vs. Participles -=========================== - -* Avoid present participial forms and gerunds, words ending in -ing, - unless they are part of a technical name. -* Use infinitives instead of participials in this type of - construction. For example: - -*There is no way of verifying this.* - -**There is no way to verify this.** - - -Active Voice vs. Passive Voice -============================== -Use active voice whenever possible to show clearly who or what is -performing an action. - -* Active voice follows standard English word order: - SUBJECT–VERB–OBJECT (optional). Modifiers come before or immediately - following the terms they modify. -* Passive voice reverses the order and weakens the verb: OBJECT–be - VERB–by SUBJECT (optional). -* Writing sentences in the passive voice, we often have to use the - verb to be and sometimes the preposition "by". - -Examples: - - -*A mistake was made.* (By whom?) - -**I made a mistake.** - -*The sheriff was shot by me.* - -**I shot the sheriff.** - -*Version 2.0 was released in June.* - -**We released version 2.0 in June.** - -.. note:: - Sometimes it is okay to use passive voice. For example, you may - use passive voice to avoid gender-specific pronouns, to avoid - blaming someone, or to address situations where the subject, who - did the action, is unknown or irrelevant. - -Noun phrases -************ -Avoid long strings of nouns. Even native English speakers might have -difficulty determining which term modifies one or another in long -strings. - -Similarly, avoid long noun phrases with multiple adjectives. Try to -limit the number of modifiers in any noun phrase to two terms maximum. - -Often the best way to split up these long noun strings is to separate -them into digestible prepositional phrases. This tends to lengthen them -but makes them much easier to understand. - -Examples of some long noun phrases and possible rewording: - -*Power management mechanism integration policies* - -**Integration policies for power management mechanisms** - -*Signal integrity test deck requirements* - -**Requirements for test desks that measure signal integrity** - -*Building radon source location method* - -**Method for locating the source of radon in buildings** - -*Employee compensation level evaluation procedures* - -**Procedures for evaluating an employee's compensation level** - -Pronouns -******** - -First Person -============ - -We recommend using we or |CL|, if you want to sound more formal, to provide -an agent, someone who does the action in a sentence, and avoid passive -constructions such as "It is recommended...." For example: - - -*5 MB is recommended.* - -**We recommend 5 MB.** - -*It is recommend that you set the value as low as possible.* - -**We recommend setting the value as low as possible.** - -*This setting has not been validated.* - -**Intel has not validated this setting.** - -Second Person -============= - -Write directly to the reader and use the second-person pronoun "you" -rather than "the user". For example: - -*If the widget is to be compressed....* - -**If you want to compress the widget...** - -*If reduced costs are wanted...* - -*If the user wants to reduce costs...* - -**If you want to reduce costs...** - - -Third Person -============ - -Third person pronouns tend to create subject-verb agreement errors -because writers often introduce a gender-neutral third person plural -they. Rewrite these sentences using a third person plural antecedent. -Avoid third person singular pronouns, especially the gender-specific -pronouns he and she, and, if necessary, rewrite these sentences using -plurals to avoid a gender-specific references in gender-indeterminate -situations. - -The preferred hierarchy of third-person pronoun usage is: - -*Wrong* - -*If a user needs to update their account...* - -Do not use the third person plural for a singular subject. - -*Avoid* - -*If a user forgets her password...* - -Do not force the feminine pronoun set (she) unless there is a specific, -approved feminine antecedent or there is some other very strong, -circumstantial reason to do so. - -Acceptable - -If a user needs to update his account... - -In traditional English usage, it is acceptable to use the masculine -pronoun set (he) when the gender is neutral or indeterminate. -This is often the rule in romance languages and other languages. - -**Preferred** - -**If users need to update their accounts...** - -Often the best solution is to use the plural form to avoid pronoun -problems. diff --git a/source/clear-linux/reference/collaboration/documentation/steps.rst b/source/clear-linux/reference/collaboration/documentation/steps.rst deleted file mode 100644 index 9301e570..00000000 --- a/source/clear-linux/reference/collaboration/documentation/steps.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. _steps: - -Step-by-step instructions -######################### - -* Provide a sequence of numbered steps, see :ref:`lists`. Do not provide a - paragraph of sentences. - -* Describe one action per step. - -* If the user needs to do the same thing for several procedures, refer to - earlier steps rather than repeating them. - -* When steps and diagrams flow down a page side-by-side, put text on the left - and diagrams on the right. - -* When steps include commands or code blocks, put the commands or code blocks - after the step that includes them. - -* If directions can appear in only one place, either text or figure, put them - in the text; don't hide directions in diagrams. - -* When a series of steps is supported by one figure, refer to the figure in - the introductory text: "See Figure 15 and do the following:" - -* When a series of steps is supported by two or more figures, avoid referring - to a range of figures. Rather, refer to a specific figure in the relevant - step and show the figure immediately after the reference. **Do not write**: - "See figures 15 through 22 and do the following:" \ No newline at end of file diff --git a/source/clear-linux/reference/collaboration/documentation/structures.rst b/source/clear-linux/reference/collaboration/documentation/structures.rst deleted file mode 100644 index 04cf1bc7..00000000 --- a/source/clear-linux/reference/collaboration/documentation/structures.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _structures: - -Consistent content structures guide -################################### - -This section guides you through the different content structures used in the -|CL-ATTR| documentation. This section serves as an example of the correct use -of markup. Refer to our :ref:`rest` to learn more about using -restructuredText to author your content. - -.. toctree:: - :maxdepth: 2 - - lists - steps - notices - parallelism diff --git a/source/clear-linux/reference/collaboration/documentation/tables.rst b/source/clear-linux/reference/collaboration/documentation/tables.rst deleted file mode 100644 index 814de470..00000000 --- a/source/clear-linux/reference/collaboration/documentation/tables.rst +++ /dev/null @@ -1,106 +0,0 @@ -.. _tables: - -Tables -###### - -Tables must only be used for information that is either too numerous or too -related for a list to be appropriate. The smallest acceptable table is 2x2 -not counting the table header. The |CL-ATTR| uses special ReStructuredText -markup to make including tables easier. If you plan on adding a table -consider transforming it into a list before you embark on creating a table. -Follow these general guidelines: - -* Use tables sparingly. - -* Stick to the 72-78 characters line length limit. - -* Indent the contents correctly. This allows the content to be read even if - it is not rendered. - -* Only create a table if the body of the table contains six or more cells, - which is a minimum table size of at least 2x3 or 3x2. - -ReST supports several types of tables. |CL| uses grid and -:abbr:`CSV-tables (Comma Separated Values tables)`. Grid tables are only -suited for very short content since they must be fully drawn. CSV-tables -support multi-lined cells, are easy to update and allow more layout -options. - -Use grid tables for small tables where the layout needs to be determined -manually. For example: - -+-----------------+------------------------+--------------+------------+ -| Name | Purpose | Known | References | -| (or brand name) | | Applications | | -+=================+========================+==============+============+ -| Super Glue | Glues things together | Small car | Quick Fix, | -| | with extra strength. | repairs. | 2010. | -+-----------------+------------------------+--------------+------------+ -| Masking Tape | Stops paint from | Painting | Master | -| | covering a surface | walls. | Painter, | -| | allowing for sharp | | 2007. | -| | edges. | | | -+-----------------+------------------------+--------------+------------+ - -Use '=' between the table heading and the rows to define the table header. Do -not add emphasis to the contents of the table header using \*\*. - - -This template can help you create grid tables: - -.. code-block:: rst - - +------------------------+------------+----------+----------+ - | Header row, column 1 | Header 2 | Header 3 | Header 4 | - | (header rows optional) | | | | - +========================+============+==========+==========+ - | body row 1, column 1 | column 2 | column 3 | column 4 | - +------------------------+------------+----------+----------+ - | body row 2 | ... | ... | | - +------------------------+------------+----------+----------+ - -CSV-tables are more flexible than grid tables. They can be updated easily and -support several layout options. For example: - -.. csv-table:: Frozen Delights! - :header: "Treat", "Quantity", "Description" - :widths: 15, 10, 30 - - "Albatross", 2.99, "On a stick!" - "Crunchy Frog", 1.49, "If we took the bones out, it wouldn't be - crunchy, now would it?" - "Gannet Ripple", 1.99, "On a stick!" - -Some of the options available with CSV-tables are table titles, an optional -header row separate from the rest of the table, and customizable column width. -See the Sphinx `CSV-tables documentation`_ to learn all the possible options -available. - -This template can help you create CSV-tables: - -.. code-block:: rst - - .. csv-table:: Table title (optional) - :header: The header, values, for each column - :widths: 15, 10, 30 - - If the values, in the, "table go beyond the line length, use quotes to - keep the content together." - Numbers like, 10, are never surrounded by quotes. - Text can, "be", in quotes but it is only needed for longer lines. - -The template renders as: - -.. csv-table:: Table title (optional) - :header: The header, values, for each column - :widths: 15, 10, 30 - - If the values, in the, "table go beyond the line length, use quotes to keep - the content together." - Numbers like, 10, are never surrounded by quotes. - Text can, "be", in quotes but it is only needed for longer lines. - - - -.. _CSV-tables documentation: - http://docutils.sourceforge.net/docs/ref/rst/directives.html#csv-table \ No newline at end of file diff --git a/source/clear-linux/reference/collaboration/structure-formatting.rst b/source/clear-linux/reference/collaboration/structure-formatting.rst new file mode 100644 index 00000000..6391dccb --- /dev/null +++ b/source/clear-linux/reference/collaboration/structure-formatting.rst @@ -0,0 +1,482 @@ +.. _structure-formatting: + +Structure and formatting +######################## + +Content should be organized to support scanning. Consistent organization, +formatting, and writing style helps readers quickly find what they need and to +understand the content more effectively. This document describes our +organization and formatting guidelines. + +Refer to :ref:`writing-guide` to learn how we keep our documents clear and +concise. + +.. contents:: :local: + :depth: 1 + +Markup +****** + +Our documentation is written in the reStructuredText markup language, using +Sphinx roles and directives. We use Sphinx to generate the final documentation. +You can read more about reStructuredText and Sphinx on their respective +websites: + +* `Sphinx documentation`_ +* `reStructuredText Primer`_ + +You can view the content directly in the .rst markup files, or generate the HTML +content by installing and building the documentation locally. To run the +documentation locally, follow the instructions found in the +`documentation repository`_ README. + +New pages +========= + +There are a few additional steps to consider when adding a new page to the +documentation. First, identify where your new page should be located within the +existing `Documentation organization`_. Second, make sure the new page is picked +up in the Sphinx build and easily linkable from other content. + +Each page must be included in a `Sphinx toctree`_ in order to be included in the +documentation content tree. Typically, pages are added to the section landing +page toctree. + +For example, the :ref:`collaboration` page toctree looks like: + +.. code-block:: rest + + .. toctree:: + :maxdepth: 1 + + writing-guide + structure-formatting + +Additionally, each page must include a uniquely named reST label directly before +the page title, to enable the `Sphinx ref role`_ for linking to a page. + +For example, this page "Structure and formating" has the label +``.. _structure-formatting``: + +.. code-block:: rest + + .. _structure-formatting: + + Structure and formatting + ######################## + +This page can then be referenced from other pages in the documentation using the +`:ref:` role: + +.. code-block:: rest + + :ref:`structure-formatting` + +Documentation organization +************************** + +The documentation is organized into five general sections: + +#. **Concepts**: Introduction and overview of |CL| specific concepts or + features. +#. **Get started**: Information about getting started with |CL|. +#. **Guides**: Detailed information and instruction on using |CL| features. +#. **Tutorials**: Step-by-step instruction for using |CL| in specific use cases. +#. **Reference**: Supplementary and reference information for |CL|. + +Page structure +============== + +Each page in the documentation should follow the basic format of: + +* Overview: 1-2 sentences describing what this page shows and why it matters +* Prerequisites: Describe any pre-work necessary to the content (if appropriate) +* Content +* Next steps: List links to next steps (if appropriate) +* Related topics: List links to related content (if appropriate) + +Headings +======== + +Use headings to section and organize your content for better readability and +clarity. + +* All files must have a top level heading, which is the title for the page. +* Up to three additional levels of headings are allowed under the title heading. +* Each heading should be followed by at least one paragraph of content. Avoid + two or more consecutive headings. + +Refer to the :ref:`writing-guide` for tips on using headings to create +:ref:`scannable content `. + +To mark up headings in the .rst file: + +* Use hash-tags to underline the file's main title: + + .. code-block:: rest + + Main title + ########## + +* Use asterisks to underline the file's first level headings: + + .. code-block:: rest + + First level heading + ******************* + +* Use equal signs to underline the file's second level of headings: + + .. code-block:: rest + + Second level heading + ==================== + +* Use dashes to underline the file's third level of headings: + + .. code-block:: rest + + Third level heading + ------------------- + +In-page navigation +================== + +If a page has three or more sections, provide quick links to each section. Place +the quick links after the overview section. + +Use the standard `reST contents directive`_ with depth: 1 for quick links. + +Inline text formatting +********************** + +We use the `Microsoft Writing Style Guide`_ as our starting point for text +formatting. We apply the formatting using reST and Sphinx markup. + +Use our quick reference for the most commonly used inline text elements: + ++--------------------------------+---------------------------------------+-----------------------------+ +| **Element** | **Convention** | **reST/Sphinx** | ++--------------------------------+---------------------------------------+-----------------------------+ +| Acronyms | Define acronym when first used. After | Use the ``:abbr:`` role, in | +| | first use and definition, use the | the following format: | +| | acronym only. | | +| | | ``:abbr:`Acronym (Def)``` | ++--------------------------------+---------------------------------------+-----------------------------+ +| Bundle names | Bold | Use the ``:command:`` role. | ++--------------------------------+---------------------------------------+-----------------------------+ +| Callouts | | Use ``.. note::`` | ++--------------------------------+---------------------------------------+-----------------------------+ +| Code/command examples | Monospace, visually distinct | Use ``.. code-block::`` | +| | from rest of text. Use an | with the correct language | +| | indented call-out box. | setting. | ++--------------------------------+---------------------------------------+-----------------------------+ +| Commands | Bold | Use the ``:command:`` role. | ++--------------------------------+---------------------------------------+-----------------------------+ +| Command flags | Bold | Use the ``:command:`` role. | ++--------------------------------+---------------------------------------+-----------------------------+ +| Console output | Monospace, visual distinction | Use ``.. code-block::`` | +| | from rest of text. Use an | with console as the | +| | indented call-out box. | language setting. | ++--------------------------------+---------------------------------------+-----------------------------+ +| Emphasis | Italic | ``*strong*`` | ++--------------------------------+---------------------------------------+-----------------------------+ +| Environment variables | Use the case format of the | Use ``:envvar:`` | +| | environment variable. | | ++--------------------------------+---------------------------------------+-----------------------------+ +| Example commands with | Use angle brackets for swapping | | +| optional or replaceable | in the specific name, | | +| parts | e.g. . | | +| | | | +| | Use square brackets for optional | | +| | parts, | | +| | e.g. [--build]. | | ++--------------------------------+---------------------------------------+-----------------------------+ +| Example URLs (not linked) | Plain text | | ++--------------------------------+---------------------------------------+-----------------------------+ +| File extensions | Lowercase | | ++--------------------------------+---------------------------------------+-----------------------------+ +| File names, directories, paths | Title style capitalization | Use the ``:file:`` role. | ++--------------------------------+---------------------------------------+-----------------------------+ +| GUI labels | | Use ``:guilabel:`` | ++--------------------------------+---------------------------------------+-----------------------------+ +| Inline comments | | Use ``..`` | ++--------------------------------+---------------------------------------+-----------------------------+ +| Keystrokes | | Use ``:kbd:`` | ++--------------------------------+---------------------------------------+-----------------------------+ +| Local navigation | | ``.. contents:: :local:`` | +| | | with a depth of 1 | ++--------------------------------+---------------------------------------+-----------------------------+ +| Menu selection | | Use ``:menuselection:`` | ++--------------------------------+---------------------------------------+-----------------------------+ +| New terms | Italic for first use, normal for all | ``*term*`` | +| | subsequent uses. | | +| | | | +| | If it is used outside of the source | | +| | of definition, link the term. | | ++--------------------------------+---------------------------------------+-----------------------------+ +| Product name | Follow correct trademark and | | +| | attribution guidelines. | | ++--------------------------------+---------------------------------------+-----------------------------+ +| Tool names | Correctly capitalized, no quotes, | | +| | bold, or italics as the basic rule. | | +| | | | +| | If the tool name is the command, like | | +| | most Linux tools, treat it like a | | +| | command. | | +| | | | +| | If the tool name is lowercase and | | +| | used at the start of a sentence, use | | +| | bold. | | ++--------------------------------+---------------------------------------+-----------------------------+ + +White space and line length +=========================== + +Limit line length to 78 characters. The GitHub web interface forces this +limitation for readability. + +Remove trailing whitespace from your documents. + +Code blocks and examples +************************ + +When providing example code or commands use the `Sphinx code-block directive`_. +Select the appropriate syntax highlighting for the example command or code. + +For example, if showing console output, use console highlighting: + +.. code-block:: rest + + .. code-block:: console + +Sphinx provides other ways of `marking up example code`_ if needed. + +Lists and instructions +********************** + +Use a numbered list when the order or priority of the items is important, such +as step-by-step instructions. + +Use a bulleted list when the order of the items is not important. + +For both list types, keep all items in the list parallel. See +:ref:`parallelism`. + +Use standard `reST list markup`_. + +Numbered lists +============== + +Numbered lists are most frequently used for procedures. Use numbered lists to +show sequence for the items. Follow our guidelines for numbered lists: + +* Make sure the list is sequential and not just a collection of items. +* Introduce a numbered list with a sentence. End the setup text with a + colon. Example: "To configure the unit, perform the following steps:" +* Each item in the list should be parallel. +* Treat numbered list items as full sentences with correct ending + punctuation. +* You may interrupt numbered lists with other content, if relevant, + e.g. explanatory text, commands, or code. +* Second-level steps are acceptable; avoid third-level steps. +* Avoid single-step procedures; the minimum number of steps in a procedure + is two. +* Do not create numbered lists that emulate flowcharts. The reader should be + able to execute the list of steps from first to last without branching or + looping. +* Avoid over-using numbered lists, except in procedural documents such as + tutorials and step-by-step guides. + +Bulleted lists +============== + +Use bulleted lists to reduce wordiness and paragraph density, especially when +a sequence is not required. Here are some guidelines for bulleted lists: + +* Introduce a bulleted list with a sentence. End the setup text with a + colon. Example: "To repair the unit, you will need the following items:" +* Each item in the list should be parallel. +* Avoid interrupting bulleted lists with other paragraph styles. +* Second-level bullets are acceptable; avoid third-level bullets. + +Use the correct ending punctuation for sentence style bullet lists. For example: + +**Use this:** + +:: + + When setting the user code, remember: + + * Use a number that has a meaning for you. + * Change the code once a month. + * Do not disclose the user code to anyone, including the security company. + +**Not this:** + +:: + + When setting the user code remember: + + * make the user code easy to remember. Use a number that has a meaning for you + * change the code once a month + * do not disclose the user code to anyone else. This includes the security + company + +Instructions +============ + +When presenting instructions, such as in a tutorial, present them in a numbered +list according to these guidelines: + +* Each step (list item) should describe one action. + +* If the same steps are repeated, refer to the earlier steps rather than + repeating them. + +* When a step includes a command or code block as an example, put the command + or code block after the step that includes them. + +* Use supporting images where appropriate. If the series of steps is supported + by one figure, refer to the figure in the introductory text. + + For example: "See Figure 15 and do the following:" + + When a series of steps is supported by two or more figures, refer to the + specific figure in the relevant step and show the figure immediately after + the reference. **Do not write**: "See figures 15 through 22 and do the + following:" + +Notices +******* + +We use four special types of notices: notes, cautions, warnings, and dangers. +Here are some specific rules and tips regarding use of these notices: + +* Do not use a notice directly after a heading. Notices must follow a variant of + body text. +* Do not include more than one notice in a single notice block. +* Avoid back-to-back notices. +* If back-to-back notices are not avoidable, make sure each distinct notice in + the notice block is clearly defined. + +Use the standard `reST admonition directive`_. + +Notes, cautions, and warnings +============================= + +Use notes sparingly. Avoid having more than one note per section. If you exceed +this number consistently, consider rewriting the notes as main body text. + +Use cautions and warnings to alert readers of potential problems or pitfalls. +Use conditional phrases in cautions and warnings, such as "If you do X, then Y +will occur." + +These are examples of typical notices and the conditions for their usage: + +.. note:: + Notes are extra bits of information that supplement the main content. Notes + should be relatively short. + +.. caution:: + Cautions are low-level hazard messages that alert the user of possible + equipment, product, and software damage, including loss of data. + +.. warning:: + Warnings are mid-level hazards that are likely to cause product damage. + +Links +***** + +Use the standard `reST markup for links`_. + +To add a cross-reference to another documentation page, use the `:ref:` role: + +.. code-block:: rest + + :ref:`structure-formatting` + +To add an external link, we use named references that refer to a defined +link/label at the bottom of the page. + +For example, an external link is defined at the bottom of the page like this: + +.. code-block:: rest + + .. _wiki about dogs: https://en.wikipedia.org/wiki/Dog + +The defined link is then used in the content like this: + +.. code-block:: rest + + Check out the great `wiki about dogs`_. + +Images +****** + +Use images or figures to convey information that may be difficult to explain +using words alone. Well-planned graphics reduce the amount of text required to +explain a topic or example. + +Follow these guidelines when using graphics in support of your documentation: + +* Keep it simple. Use images that serve a specific purpose in your document, + and contain only the information the reader needs. + +* Avoid graphics that will need frequent updating. Don't include information in + a graphic that might change with each release, such as product versions. + +* Use either PNG or JPEG bitmap files for screenshots and SVG files for vector + graphics. + +* Place the image immediately after the text it helps clarify, or as close as + possible. + +* Use the `Sphinx figure directive`_ to insert images and figures into the + document. Include both alt text, a figure name, and caption. + + For example: + + .. code-block:: rest + + .. figure:: figures/topic-1.png + :alt: An image supporting the topic. + + Figure 1: This is the figure 1 caption. + +* Include at least one direct reference to an image from the main text, using + the figure number. For example: + + **Use this:** :: + + Figure 1 + + **Not this:** :: + + The figure above or below + +Images should follow these naming and location conventions: + +* Save the image files in a :file:`figures` folder at the same level as the file + that will reference the image. +* Name image files according to the following rules: + + * Use only lower case letters. + * Separate multiple words in filenames using dashes. + * Name images using the filename of the file they appear on and add a number + to indicate their place in the file. For example, the third figure added to + the :file:`welcome.rst` file must be named :file:`welcome-3.png`. + +.. _Sphinx documentation: http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html +.. _reStructuredText Primer: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html +.. _documentation repository: https://github.com/clearlinux/clear-linux-documentation +.. _Sphinx toctree: https://www.sphinx-doc.org/en/master/usage/quickstart.html?highlight=toctree#defining-document-structure +.. _Sphinx ref role: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref +.. _reST contents directive: http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents +.. _Microsoft Writing Style Guide: https://docs.microsoft.com/en-us/style-guide/welcome/ +.. _Sphinx code-block directive: http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block +.. _marking up example code: http://www.sphinx-doc.org/en/1.6/markup/code.html +.. _reST list markup: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#lists-and-quote-like-blocks +.. _reST admonition directive: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives +.. _reST markup for links: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#hyperlinks +.. _Sphinx figure directive: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives diff --git a/source/clear-linux/reference/collaboration/writing-guide.rst b/source/clear-linux/reference/collaboration/writing-guide.rst new file mode 100644 index 00000000..f69a0344 --- /dev/null +++ b/source/clear-linux/reference/collaboration/writing-guide.rst @@ -0,0 +1,410 @@ +.. _writing-guide: + +Writing guide +############# + +We want our documentation to be easy to read and understand. This document +describes guidelines for writing documentation that is clear, concise, +confident, and courteous. + +Refer to :ref:`structure-formatting` for details on organizing content and how +we use reStructuredText and Sphinx. + +.. contents:: :local: + :depth: 1 + +Use simple English +****************** + +Write using simple English: Be brief and communicate only the information that +is needed. Be friendly and informative. Emphasize clarity and avoid +unecessary complicated or technical terms. Make the content accessible to +non-native speakers. + +Be brief +======== + +Use short sentences and paragraphs. Stick to the principle of one main +idea per sentence, plus one additional point if needed. Each paragraph +should address one main idea. Remember the basic structure of a paragraph: +Introduction, body, and conclusion. + +Be friendly +=========== + +We write for our peers and want to be familiar. Take a personal tone as if you +were speaking directly to the reader. Use "you" to address the reader and "we" +to refer to our view. Be professional, respectful, and cooperative. + +Assume your audience has the same level of technical understanding and expertise +as you did when you first started collaborating. Do not talk down to our +readers, but also do not assume they know everything about the subject. Offer +brief explanations or summaries of common knowledge if a significant portion of +readers might benefit. + +Use simple words +================ + +Use simple words to increase reader comprehension and reduce ambiguity. Follow +our tips for making good word choices: + +* **Avoid jargon**: Write for your audience, using everyday language where + possible, and technical terms where appropriate. Avoid clichés, idioms, and + metaphors. +* **Be consistent**: Use one term for each concept or action and use it + consistently. +* **Avoid "fancy" words and phrases**: If there is a simpler word or phrase, + use it. + + For example: + + =================== =================== + Use this Not this + =================== =================== + start, begin commence + so consequently + more than in excess of + if in the event of + before prior to + if you want should one wish + use utilize + example instance + =================== =================== + +Avoid overuse of product name +============================= + +Use product names only when necessary. Typically, you can rewrite sentences to +remove the product name with no change in meaning, which keeps the content +concise and scannable. + +Avoid using the product name in page titles and headings. + +.. _scannable-content: + +Make content scannable +********************** + +Organize your content to make it scannable for the reader, which helps them find +what they need quickly, and to understand the information more efficiently. + +* **Put the most important content first.** Make sure your introduction clearly + communicates what the reader can find on the page. Present the point of the + document first, and organize supporting information towards the end of the + page. +* **Write scannable headings.** Expect readers of documentation to skim and scan + the content, and to leave if they dont find what they need quickly. Good + headings add organization to your content and help the reader to find and + understand content more effectively. Follow our guidelines for writing + effective `Headings`_. +* **Write great link text.** Great link text tells the reader what they can + expect when they click on a link. It also helps make the page more scannable. + Follow our guidelines for writing `Link text`_. + +Headings +======== + +Use these guidelines to write effective headings: + +* **Be concise and descriptive.** Use only the words necessary to describe the + section. +* **Use sentence case.** Capitalize only the first word and proper nouns in a + heading. +* **Avoid punctuation.** Unless your heading is a question, don't use sentence + punctuation in headings. +* **Use parallel structure.** Headings at the same level should use the same + grammatical pattern. This provides structure to the document and helps users + find information more easily. See :ref:`parallelism`. +* **Use strong verbs.** Strong, active verbs get to the point. Avoid -ing verbs, + such as *Running*, *Testing*, etc. + +For example, two headings at the same level: + +**Use this:** :: + + Install software + + Configure software + +**Not this:** :: + + Installing the Software on the Platform + + Software Configuration. + +Link text +========= + +All links in content should follow these guidelines: + +* **Write descriptive link text**: Link text should describe where the link + goes, without having to read the surrounding text. +* **Keep link text concise**: Use only the words needed to accurately describe + the destination. +* **Use unique link text**: Each link on a page should be unique. If users see + the same link text twice on a page, they'll assume it goes to the same place. +* **Start link text with keywords**: Frontload the link text with the most + important words to help users scan the text. +* **Avoid generic text**: Don't use generic, uninformative link text such as + "click here" or "read more". + +For example: + +**Use this:** :: + + For more information about dogs, read the `dog wiki article`_. + +**Not this:** :: + + For more information about dogs, `click here`_. + +Use strong verbs +**************** + +Passive verbs make writing stuffy and formal. Use strong verbs to get to the +point and avoid unnecessary words and phrases. + +Use imperatives +=============== + +Commands, also called imperatives, are the fastest and most direct way of giving +someone instructions. For example: + +**Use this:** :: + + Send it to me. + +**Not this:** :: + + I would appreciate it if you would send it to me. + +Use present tense +================= + +Use simple present tense instead of future tense for most text. Search for the +words "will" or "shall" to find future tense instances. Future tense is +acceptable for conditional statements, such as in a caution or a warning. For +example: + +**Use this:** :: + + The system operates at a nominal temperature of 180 degrees Fahrenheit. + +**Not this:** :: + + The system will operate at a nominal temperature of 180 degrees Fahrenheit. + +Avoid nominalizations +===================== + +Avoid nominalizations, which are nouns formed from verbs. + +For example: + +===================== ===================== + Verb Nominalization +===================== ===================== + complete completion + provide provision + fail failure + install installation +===================== ===================== + +For example: + +**Use this:** :: + + We discussed the matter. + +**Not this:** :: + + We had a discussion about the matter. + +Or: + +**Use this:** :: + + IT has installed the software. + +**Not this:** :: + + IT has completed the installation of the software. + +Avoid words ending in -ing +========================== + +Avoid using words ending in -ing unless they are part of a technical name. For +example: + +**Use this:** :: + + There is no way to verify this. + +**Not this:** :: + + There is no way of verifying this. + +Use the active voice +==================== + +Use active voice whenever possible to show who or what is performing an +action. + +* Active voice follows standard English word order: SUBJECT–VERB–OBJECT + (where the OBJECT is optional). +* Passive voice reverses the order and weakens the verb: OBJECT–be VERB–by + SUBJECT (where the OBJECT is optional). + +For example: + +**Use this:** :: + + I made a mistake. + +**Not this:** :: + + A mistake was made. *(By whom?)* + +Or: + +**Use this:** :: + + We released version 2.0 in June. + +**Not this:** :: + + Version 2.0 was released in June. + +Avoid long noun phrases +*********************** + +Noun phrases (a noun and other words that describe or modify it) can be +difficult to understand. Try to limit the number of modifiers in a noun phrase +to two. For example: + +**Use this:** :: + + Integration policies for power management mechanisms. + +**Not this:** :: + + Power management mechanism integration policies. + +.. _parallelism: + +Parallelism +*********** + +Parallelism refers to the practice of using similar patterns of grammar, and +sometimes length, to coordinate words, phrases, and clauses. + +Use parallel construction in lists. The table below shows some unparallel +structures and how they can be made parallel with a little rewording. + ++----------------------------------+----------------------------------+ +| Parallel (do) | Unparallel (don't) | ++==================================+==================================+ +| 1. Mount the panel. | 1. Mount the panel. | +| 2. Install the battery. | 2. Battery installation. | +| 3. Wire the keypad. | 3. Wiring the keypad. | ++----------------------------------+----------------------------------+ +| I like practicing my accordion, | I like practicing my accordion, | +| reading sci-fi, and eating | reading sci-fi, and to eat | +| peanut butter and pickle | peanut butter and pickle | +| sandwiches. | sandwiches. | ++----------------------------------+----------------------------------+ +| For breakfast he likes coffee | For breakfast he likes coffee | +| and bacon. | and to fry bacon. | ++----------------------------------+----------------------------------+ +| Apples or bananas are a good | Apples or a banana are a good | +| snack. | snack. | ++----------------------------------+----------------------------------+ + +Grammar and punctuation +*********************** + +This section covers common grammatical topics relevant to our +documentation. For detailed explanations of correct grammar and punctuation, +use one of our :ref:`preferred references `. + +Capitalization +============== + +The capitalization style for all documentation is sentence case. Words should +only be capitalized when they are proper nouns or refer to trademarked product +names. + +.. note:: + Do not capitalize a word to indicate it is more important than other + words. Never change the case of variable, function or file names - always + keep the original case. + +Menu capitalization +------------------- + +When referring to software menu items by name, use the same capitalization as +seen in the actual menu. + +A few other tips when referring to menu items: + +* Reference the specific menu item using "Select :menuselection:`File --> New`." + +* Put the option to be selected last. "Select + :menuselection:`View --> Side Bar --> Hide Side Bar`" + +* Do not include more than 3 navigation steps in a menu selection. If + more than three steps are needed, divide the steps using + ``:guilabel:`` or ``:menuselection:``. + + For example: "Go to :guilabel:`File` and select + :menuselection:`Print --> Print Preview --> Set Up`." + +Software version capitalization +------------------------------- + +When listing software or hardware version numbers, the word “version” or letter +"v" are lowercase. The v is closed with the number (no period). + +For example: + +* Widget Pro version 5.0 +* Widget Master v2.1.12 + +Contractions +============ + +Avoid using contractions, such as it's, they're, and you're, because they may be +unclear to non-native English-speaking audiences. + +Quotation marks +=============== + +Follow these guidelines for quotation marks: + +* Restrict use of quotation marks to terms as terms. +* Do not use quotation marks for emphasis; use *italics* for emphasis. +* Avoid using single-quote marks. + +Commas and colons +================= + +This section addresses common use of commas, semicolons, and colons in our +documentation. Refer to one of our :ref:`preferred references ` +for further details. + +Use the serial comma +-------------------- + +When writing a series of items, use the serial comma before the final *and* and +*or* to avoid confusion and ambiguity. For example: + +**Use this:** :: + + Mom, Dad, and I are going to the game. + +**Not this:** :: + + Mom, Dad and I are going to the game. + +.. _click here: https://en.wikipedia.org/wiki/Dog +.. _dog wiki article: https://en.wikipedia.org/wiki/Dog diff --git a/source/clear-linux/tutorials/dlrs.rst b/source/clear-linux/tutorials/dlrs.rst index 4c21592b..af828320 100644 --- a/source/clear-linux/tutorials/dlrs.rst +++ b/source/clear-linux/tutorials/dlrs.rst @@ -66,26 +66,32 @@ For multi-node testing, replicate these steps for each node. These steps provide a template to run other benchmarks, provided that they can invoke TensorFlow. -#. Download and run either the `Eigen`_ or the `Intel MKL-DNN`_ docker image +#. Download either the `Eigen`_ or the `Intel MKL-DNN`_ docker image from `Docker Hub`_. +#. Run the image with Docker: + + .. code-block:: bash + + docker run --name --rm -i -t bash + .. note:: You will enter the following commands in the running container. - Replace with the name of the image. + Replace with the you specified above. #. Clone the benchmark repository: .. code-block:: bash - docker exec -t bash -c ‘git clone http://github.com/tensorflow/benchmarks -b cnn_tf_v1.12_compatible’ + docker exec -t bash -c 'git clone http://github.com/tensorflow/benchmarks -b cnn_tf_v1.12_compatible' #. Next, execute the benchmark script to run the benchmark. .. code-block:: bash - docker exec -i bash -c ‘python benchmarks/scripts/tf_cnn_benchmarks/tf_cnn_benchmarks.py --device=cpu --model=resnet50 --data_format=NHWC ’. + docker exec -i bash -c 'python benchmarks/scripts/tf_cnn_benchmarks/tf_cnn_benchmarks.py --device=cpu --model=resnet50 --data_format=NHWC '. .. note:: @@ -158,16 +164,17 @@ following these instructions from their `quick start guide`_. .. code-block:: bash export KUBEFLOW_SRC=$HOME/kflow - export KUBEFLOW_TAG=”v0.3.2” - export KFAPP=”kflow_app” - export K8S_NAMESPACE=”kubeflow” + export KUBEFLOW_TAG="v0.4.1" + export KFAPP="kflow_app" + export K8S_NAMESPACE="kubeflow" mkdir ${KUBEFLOW_SRC} cd ${KUBEFLOW_SRC} ks init ${KFAPP} cd ${KFAPP} ks registry add kubeflow github.com/kubeflow/kubeflow/tree/${KUBEFLOW_TAG}/kubeflow - ks pkg install kubeflow/core + ks pkg install kubeflow/common + ks pkg install kubeflow/tf-training Now you have all the required kubeflow packages, and you can deploy the primary one for our purposes: tf-job-operator. @@ -194,13 +201,23 @@ Run a TFJob ks pkg install dlrs-tfjob/dlrs-bench +#. Export the image name you'd like to use for the deployment: + + .. code-block:: bash + + export DLRS_IMAGE= + + .. note:: + + Replace with the image name you specified in previous steps. + #. Next, generate Kubernetes manifests for the workloads and apply them to create and run them using these commands .. code-block:: bash - ks generate dlrs-resnet50 dlrsresnet50 --name=dlrsresnet50 - ks generate dlrs-alexnet dlrsalexnet --name=dlrsalexnet + ks generate dlrs-resnet50 dlrsresnet50 --name=dlrsresnet50 --image=${DLRS_IMAGE} + ks generate dlrs-alexnet dlrsalexnet --name=dlrsalexnet --image=${DLRS_IMAGE} ks apply default -c dlrsresnet50 ks apply default -c dlrsalexnet diff --git a/source/clear-linux/tutorials/kubernetes.rst b/source/clear-linux/tutorials/kubernetes.rst index 5f491ad6..f05d4109 100644 --- a/source/clear-linux/tutorials/kubernetes.rst +++ b/source/clear-linux/tutorials/kubernetes.rst @@ -18,14 +18,17 @@ workloads or multi-tenant scenarios. Kata Containers can be allocated on a per-pod basis so you can mix and match both on the same host to suit your needs. +.. contents:: :local: + :depth: 1 + Prerequisites ************* -This tutorial assumes you have installed |CL| and updated to the latest -release on your host system. You can learn about the benefits of having an -up-to-date system for cloud orchestration on the :ref:`swupd-about` -page. For detailed instructions on installing |CL| on a bare metal system, -follow the :ref:`bare metal installation tutorial`. +This tutorial assumes you have already installed |CL|. For detailed +instructions on installing |CL| on a bare metal system, follow the +:ref:`bare metal installation tutorial`. Learn about the +benefits of having an up-to-date system for cloud orchestration on the +:ref:`swupd-about` page. Before you install any new packages, update |CL| with the following command: @@ -37,11 +40,19 @@ Install Kubernetes and CRI runtimes *********************************** Kubernetes, a set of supported :abbr:`CRI (Container Runtime Interface)` -runtimes, and networking plugins, are included in the `cloud-native-basic`_ and `containers-basic`_ bundles. To install this framework, enter the following command: +runtimes, and networking plugins, are included in the `cloud-native-basic`_ +bundle. + +.. note:: + + CRI-O’s default plugin_dir is :file:`/opt/bin/cni`. + CNI plugins are installed as part of ``cloud-native-basic``. + +To install this framework, enter the following command: .. code-block:: bash - sudo swupd bundle-add cloud-native-basic containers-basic + sudo swupd bundle-add cloud-native-basic Configure Kubernetes ******************** @@ -171,8 +182,6 @@ If you are using CRI-O and `flannel` and you want to use Kata Containers, edit t [crio.runtime] manage_network_ns_lifecycle = true -.. TODO: Should Weave and Calico be mentioned below, or is Flannel enought? - Create a symlink for the network overlays: .. code-block:: bash @@ -181,36 +190,22 @@ Create a symlink for the network overlays: .. note:: - |CL| installs CNI plugins that are part of the `cloud-native-basic` bundle to :file:`/usr/libexec/cni`. The directory is required because `swupd verify` uses it, if necessary, to repair a system to a known good state. + |CL| installs CNI plugins that are part of the `cloud-native-basic` + bundle to :file:`/usr/libexec/cni`. The directory is required because ` + swupd verify` may use it to repair a system to a known good state. -.. TODO: Verify whether to omit this section per mythi, eadamsintel. +**Notes about Weave Net add-on** -.. **Notes about Weave Net add-on** +If you choose the `Weave Net` add-on, you must make the following +changes because it installs itself in the :file:`/opt/cni/bin` directory. -.. If you choose the `Weave Net` add-on, then you must make the following -.. changes because it installs itself in the :file:`/opt/cni/bin` directory. +For using CRI-O and ``Weave Net``, complete the following step. -.. For using CRI-O and `Weave Net`, you must complete the following -.. steps. +Add the `loopback` CNI plugin to the plugin path with the command: -.. #. Edit the :file:`/etc/crio/crio.conf` file to change `plugin_dir` from: - -.. .. code-block:: bash - -.. plugin_dir = "/usr/libexec/cni/" - -.. to: - -.. .. code-block:: bash - -.. plugin_dir = "/opt/cni/bin" - -.. #. Add the `loopback` CNI plugin to the plugin path with the command: - -.. .. code-block:: bash - -.. sudo ln -s /usr/libexec/cni/loopback /opt/cni/bin/loopback +.. code-block:: bash + sudo ln -s /usr/libexec/cni/loopback /opt/bin/cni/loopback Use your cluster **************** @@ -225,7 +220,6 @@ period. The values are presented in a format similar to: kubeadm join : --token --discovery-token-ca-cert-hash - **Congratulations!** You've successfully installed and set up Kubernetes in |CL| using CRI-O and @@ -283,17 +277,17 @@ commands as a shell script to configure all of these services in one step: .. code-block:: bash - services=('crio') - for s in "${services[@]}"; do - sudo mkdir -p "/etc/systemd/system/${s}.service.d/" - cat << EOF | sudo tee "/etc/systemd/system/${s}.service.d/proxy.conf" - [Service] - Environment="HTTP_PROXY=${http_proxy}" - Environment="HTTPS_PROXY=${https_proxy}" - Environment="SOCKS_PROXY=${socks_proxy}" - Environment="NO_PROXY=${no_proxy}" - EOF - done + services=('crio') + for s in "${services[@]}"; do + sudo mkdir -p "/etc/systemd/system/${s}.service.d/" + cat << EOF | sudo tee "/etc/systemd/system/${s}.service.d/proxy.conf" + [Service] + Environment="HTTP_PROXY=${http_proxy}" + Environment="HTTPS_PROXY=${https_proxy}" + Environment="SOCKS_PROXY=${socks_proxy}" + Environment="NO_PROXY=${no_proxy}" + EOF + done Troubleshooting *************** @@ -335,6 +329,45 @@ Troubleshooting to set the proxy variables permanently, and how to make them available for all the types of access that you will use, such as remote SSH access. + If the result of the above commands is blank, you may need to add a + ``profile`` to the :file:`/etc` directory. To do so, follow these steps. + + #. Create a `profile` in :file:`/etc` + + .. code-block:: bash + + sudo touch profile + + #. With a preferred editor, open `profile`, and enter your proxy settings. + Example shown below. + + .. code-block:: bash + + export "HTTP_PROXY=http://proxy.example.com:443" + export "HTTPS_PROXY=http://proxy.example.com:445" + export "SOCKS_PROXY=http://proxy.example.com:1080" + export "NO_PROXY= site.com,.site.com,localhost,127.0.0.1, + + .. note:: + + can be obtained by running :command:`ifconfig`. + + #. Save and exit the `profile`. + + #. Run: + + .. code-block:: bash + + sudo source profile + + #. To ensure your system isn't running previous session variables, run: + + .. code-block:: bash + + sudo kubeadm reset --cri-socket=/run/crio/crio.sock + + #. Continue below while passing `-E` in the command as shown. + * Missing environment variables. If you are behind a proxy server, pass environment variables by adding *-E* @@ -342,9 +375,8 @@ Troubleshooting .. code-block:: bash - /* Kubernetes with CRI-O + kata-runtime */ - sudo -E kubeadm init --cri-socket=/run/crio/crio.sock - + /* Kubernetes with CRI-O + kata-runtime */ + sudo -E kubeadm init --cri-socket=/run/crio/crio.sock .. _Kubernetes container orchestration system: https://kubernetes.io/ @@ -352,8 +384,6 @@ Troubleshooting .. _Software Update documentation: https://clearlinux.org/documentation/clear-linux/concepts/swupd-about#updating -.. _containers-basic: https://github.com/clearlinux/clr-bundles/blob/master/bundles/containers-basic - .. _cloud-native-basic: https://github.com/clearlinux/clr-bundles/blob/master/bundles/cloud-native-basic .. _preflight check: https://kubernetes.io/docs/reference/setup-tools/kubeadm/implementation-details/#preflight-checks diff --git a/source/scripts/_python/Makefile b/source/scripts/_python/Makefile new file mode 100644 index 00000000..d7b5ffc2 --- /dev/null +++ b/source/scripts/_python/Makefile @@ -0,0 +1,9 @@ + +py: + python bundle_lister.py + cp bundles.html.txt ../../clear-linux/reference/bundles + rm -rf cloned_repo/* + rm bundles.html.txt + @echo "Python script finished successfully!" + + diff --git a/source/scripts/_python/README.md b/source/scripts/_python/README.md new file mode 100644 index 00000000..5903bdb3 --- /dev/null +++ b/source/scripts/_python/README.md @@ -0,0 +1,26 @@ +bundle_lister.py +---------------- + +`bundle_lister.py` is a Python (3.6.0) web scraper and html file generator. First, it clones the +[clr-bundles directory](https://github.com/clearlinux/clr-bundles). Second, it parses the content of all bundles in the clr-bundles/ directory and the `packages` file. Third, it uses Jinja2 template engine to output the result as: bundles.html.txt. This file is copied to reference/bundles location, and it is invoked in `bundles.rst`, which currently appears as [Available bundles](https://clearlinux.org/documentation/clear-linux/reference/bundles). + +`bundle_lister.py` automates clear linux documentation so it reflects +current bundles and packages per developer updates to the +[clr-bundles GitHub repository](https://github.com/clearlinux/clr-bundles). Therefore, it increases efficiency, automatically aligns documentation with Clear Linux Engineering development, and it eliminates potential for human error, and saves labor hours in contrast to the previous manual method. + +`bundle_lister.py` will be invoked in a bash script in the `source/Makefile` of clear-linux documentation. Therefore, `bundle_lister.py` will automatically create newly scraped and parsed data upon each build of the +[website](https://clearlinux.org) and output an accurate, up-to-date table showing all bundles and packages for interested developers and admins. + +See `requirements.txt` for dependencies necessary to run this application. + +Built in:`Python==3.6.0` + +To run `bundle_lister.py` in the terminal, enter: `python bundle_lister.py`. + +Note: The `cloned_repo` directory must remain in the parent directory in order for this code to work; the template.html must remain as +well. + +Note: A successful build will produce a file `bundles.html.txt` showing a table of current bundles and pundles (packages) alphabetized, with a (UTC) time and date stamp in the upper right corner. + + +`~$~` diff --git a/source/scripts/_python/bundle_lister.py b/source/scripts/_python/bundle_lister.py new file mode 100644 index 00000000..8440ab61 --- /dev/null +++ b/source/scripts/_python/bundle_lister.py @@ -0,0 +1,98 @@ +import io +import os +import re +import urllib +import jinja2 +from jinja2 import Environment, FileSystemLoader, Template +import git +from operator import itemgetter +from datetime import datetime + +GITHUB_BASE = "https://github.com/clearlinux/clr-bundles/tree/master/bundles/" +PUNDLES = "https://github.com/clearlinux/clr-bundles/blob/master/packages" + +PATTERN1 = re.compile(r"#\s?\[TITLE]:\w?(.*)") +PATTERN2 = re.compile(r"#\s?\[DESCRIPTION]:\w?(.*)") +PATTERN3 = re.compile(r"\(([^()]*|include)\)", re.MULTILINE) +PATTERN4 = re.compile(r"^((?:(?!#)\w+[^-\s][-])\w+|\w+[^\s-])", re.MULTILINE) +# ALT PATTERN4 = re.compile(r"^((?:(?!#)(\w+[^-\s])[-]\w+.)[^\s]{1,}[^\s]|\w+[^\s-])", re.MULTILINE) + +PATTERN5 = re.compile(r"^(?!=a)\w.+\s[#]\s(\w+.*)?", re.MULTILINE) +# Previous version: PATTERN5 = re.compile(r"^[^#].*(?<=\s\-\s)(\w+.*)?", re.MULTILINE) + +def extractor(lines): + bundle_title = "title" + data_desc = "description" + url = "url" + include_list = [] + + for i in lines: + title = PATTERN1.match(i) + desc = PATTERN2.match(i) + includes = PATTERN3.findall(i) + + if title: + bundle_title = title.groups(0)[0].strip() + if desc: + data_desc = desc.groups(0)[0].strip() + if url: + url = os.path.join(GITHUB_BASE, bundle_title) + + if includes: + include_text = includes[0].strip("()") + include_list.append(include_text) + return {"title": bundle_title, "data_desc": data_desc, "include_list": include_list, "url": url} + +def pundler(): + with io.open("./cloned_repo/clr-bundles/packages") as file_obj: + lines = file_obj.readlines() + pundle_title = "pundle_title" + pundle_desc = "pundle_desc" + purl = "purl" + pundle_list = [] + pun_desc = [] + pundle_master = [] + + for i in lines: + pundle = PATTERN4.findall(i) + pundle_plus = PATTERN5.findall(i) + + if pundle: + pundle_title = pundle[0] + pundle_list.append(pundle_title) + + if pundle_plus: + pundle_desc = pundle_plus[0].strip("[]") + pun_desc.append(pundle_desc) + + for pun, desc in zip(pundle_list, pun_desc): + pundle_master.append({"title": pun, "pun_desc": desc, "purl": PUNDLES}) + return pundle_master + +def bundler(): + data = [] + try: + git.Git("./cloned_repo/").clone("https://github.com/clearlinux/clr-bundles.git") + except: + pass + for root, dirs, files in os.walk("./cloned_repo/clr-bundles/bundles", topdown=False): + for name in files: + with open(os.path.join(root, name)) as file_obj: + lines = file_obj.readlines() + data.append(extractor(lines)) + + pundle_master = pundler() + data = data + pundle_master + filtered = list(filter(lambda x: x.get('title'), data)) + sortedData = sorted(filtered, key=lambda x:x['title'].lower()) + #ALT sortedData2 = sorted(sortedData, key=itemgetter('title')) + loader = jinja2.FileSystemLoader(searchpath='./') + env = jinja2.Environment(loader=loader) + template = env.get_template('template.html') + template.globals['now'] = datetime.utcnow + + output = template.render(data=sortedData, now=datetime.utcnow()) + with io.open('bundles.html.txt', 'w') as file: + file.write(output) + +bundler() diff --git a/source/scripts/_python/cloned_repo/.gitkeep b/source/scripts/_python/cloned_repo/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/source/scripts/_python/linkcheck/link-whitelist.txt b/source/scripts/_python/linkcheck/link-whitelist.txt new file mode 100644 index 00000000..a33863a4 --- /dev/null +++ b/source/scripts/_python/linkcheck/link-whitelist.txt @@ -0,0 +1,19 @@ +http://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html +https://software.intel.com/en-us/articles/intel-virtualization-technology-for-directed-io-vt-d-enhancing-intel-platforms-for-efficient-virtualization-of-io-devices +http://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html +https://software.intel.com/en-us/articles/intel-virtualization-technology-for-directed-io-vt-d-enhancing-intel-platforms-for-efficient-virtualization-of-io-devices +https://software.intel.com/en-us/articles/intel-virtualization-technology-for-directed-io-vt-d-enhancing-intel-platforms-for-efficient-virtualization-of-io-devices +https://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html +https://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html +https://github.com/clearlinux/common#build-rpms-for-a-package +https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html +http://ark.intel.com +https://clearlinux.org/documentation/clear-linux/concepts/bundles-about#related-concepts +https://software.intel.com/en-us/articles/OpenVINO-ModelOptimizer +https://github.com/kata-containers/documentation/blob/master/Upgrading.md#maintenance-warning +https://github.com/clearcontainers/runtime#configuration +https://github.com/kata-containers/runtime#configuration +https://kubernetes.io/docs/user-journeys/users/application-developer/foundational/#section-3 +https://kubernetes.io/docs/user-journeys/users/application-developer/foundational/#section-2 +https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html +http://www.intel.com/content/www/us/en/nuc/nuc-kit-nuc6i5syh.html \ No newline at end of file diff --git a/source/scripts/_python/linkcheck/parse-link-check.py b/source/scripts/_python/linkcheck/parse-link-check.py new file mode 100644 index 00000000..cc943731 --- /dev/null +++ b/source/scripts/_python/linkcheck/parse-link-check.py @@ -0,0 +1,87 @@ +#!/usr/bin/env python + +#*********************************************************** +# +# parse-link-check.py +# +# Arguments: +# 1. path to input file +# +# External file dependencies: +# 1. output.txt - the output of sphinx-build +# 2. link-whitelist.txt - broken links that should be ignored +# +# Output: +# 1. broken_links.html - provides count of broken and whitelist +# matches. Also provides links to all flagged links. Will +# appear in the same directory as output.txt +# 2. Error code 255 if unexpected broken links are found +# +#*********************************************************** + + +import sys +import re +import os + +fileName = "output.txt" +outFile = "broken_links.html" +whitelistFile = "link-whitelist.txt" + +if len(sys.argv) < 2: + print ("Enter path of input directory") + sys.exit() + +scriptPath = sys.argv[0] +outputPath = sys.argv[1] +fileNamePath = outputPath + "/" + fileName +outFilePath = outputPath + "/" + outFile + +whitelistFilePath = os.path.dirname(scriptPath) + "/" + whitelistFile + +with open (whitelistFilePath) as w: + whLines = w.readlines() + +whitelist = [] +for line in whLines: + link = line.rstrip() + whitelist.append(link) + +with open (fileNamePath) as f: + lines = f.readlines() + +numBrokenLinks = 0 +numWhiteListMatches = 0 +newLines = [""] +whiteListLines = [] + +for line in lines: + if "[broken]" in line: + strings = line.split(" ") + link = strings[2][:-1] + link = link.strip() + if link in whitelist: + whiteListLines.append("" + strings[0] + "\n
[whitelist] " + link + "
\n") + numWhiteListMatches += 1 + else: + newLines.append("" + strings[0] + "\n
[broken] " + link + "
\n") + numBrokenLinks += 1 + +newLines.insert(0,"

" + str(numBrokenLinks + numWhiteListMatches) + " broken links found in Sphinx link check

\n") +newLines.insert(1,"

" + str(numBrokenLinks) + " unmatched broken links

\n") +newLines.append("

" + str(numWhiteListMatches) + " links matched whitelist

\n") +for line in whiteListLines: + newLines.append(line) +newLines.append("") + +with open (outFilePath, "w") as outF: + for line in newLines: + outF.write(line) + +print("See ./" + outFilePath + " for a detailed breakdown of broken links.") + +if numBrokenLinks != 0: + print (str(numBrokenLinks) + " detected. Exiting with error code 255.") + sys.exit(-1) +else: + print ("No unexpected broken links detected.") diff --git a/source/scripts/_python/requirements.txt b/source/scripts/_python/requirements.txt new file mode 100644 index 00000000..7b142b78 --- /dev/null +++ b/source/scripts/_python/requirements.txt @@ -0,0 +1,2 @@ +Jinja2==2.10 +GitPython==2.1.11 diff --git a/source/scripts/_python/styles.css b/source/scripts/_python/styles.css new file mode 100644 index 00000000..5f18a5af --- /dev/null +++ b/source/scripts/_python/styles.css @@ -0,0 +1,48 @@ +table { + margin: 32px; + border: 1px solid #e0e0e0; + border-collapse: collapse; + width: auto; +} +th { + font-family: IntelClear-Regular,Helvetica,Arial,sans-serif; + align-content: center; + padding: 5px; + border: #ccc solid 1px; + background-color: #555; + color: #fff; + text-transform: uppercase; + font-size: 18px; +} +tr { + padding-top: 20px ; + padding-bottom: 10px; +} + tbody tr:nth-child(odd) { + background-color: #e0e0e0; +} + .bundlename { + font-family: IntelClear-Regular,Helvetica,Arial,sans-serif; + font-size: 16px; + font-weight: bolder; + padding-left: 6px; + line-height: 18px; + padding-top:7px ; + padding-bottom: 5px; +} +.bundledesc { + font-family: IntelClear-Regular,Helvetica,Arial,sans-serif; + font: italic; + font-size: 16px; + padding-left: 6px; + line-height: 18px; + padding-top: 7px ; + padding-bottom: 5px; +} + ul, li { + margin-left: 8px; + /* padding: 0; */ + padding-left: 5px; + padding-top: 2px; + line-height: 16px; +} diff --git a/source/scripts/_python/template.html b/source/scripts/_python/template.html new file mode 100644 index 00000000..416d4e73 --- /dev/null +++ b/source/scripts/_python/template.html @@ -0,0 +1,55 @@ + + + + + + + Bundles in Clear Linux* OS + + + +
- Updated: 11/14/18 05:24 UTC + + Updated: 01/28/19 19:15 UTC
Name Description
acl Tools to manipulate filesystem acls
acpica-unix2 Intel ACPI utilities
alsa-utils alsa management tools
amateur-radio Applications to support amateur radio operations

Includes bundle(s): - -

  • desktop-gnomelibs
    • - -
  • libX11client
    • - -
  • python3-basic
    • - +
      + +
    • desktop-gnomelibs
      • + +
    • libX11client
      • + +
    • python3-basic
      • + +

    ansible Automates software provisioning, configuration management, and application deployment.
    ansibleThe ansible tool for host management
    + +

    Includes bundle(s): +

      + +
    • ipmitool
      • + +
    • python3-basic
      • + +
    +

    + +
    Run an application server via HTTP

    Includes bundle(s): - -

  • c-basic
    • - -
  • python3-basic
    • - -
  • web-server-basic
    • - +
      + +
    • c-basic
      • + +
    • python3-basic
      • + +
    • web-server-basic
      • + +

    		The popular atom text editor

    Includes bundle(s): - -

  • desktop-gnomelibs
    • - +
      + +
    • desktop-gnomelibs
      • + +

    auditaudit system audit tools
    axel Download accelerator
    aws-greengrass-iotLibraries to support building IoT applications on AWS Greengrass
    + +

    Includes bundle(s): +

      + +
    • python3-basic
      • + +
    • python2-basic
      • + +
    • cloud-api
      • + +
    +

    + +
    bcaxel Download accelerator
    azure-iot-sdkLibraries to support building IoT applications on Azure
    + +

    Includes bundle(s): +

      + +
    • p11-kit
      • + +
    • python3-basic
      • + +
    +

    + +
    bc basic calculator, an arbitrary-precision calculator language
    Tools and frameworks for big data management

    Includes bundle(s): - -

  • R-basic
    • - -
  • java-basic
    • - -
  • python3-basic
    • - +
      + +
    • R-basic
      • + +
    • java-basic
      • + +
    • python3-basic
      • + +
    +

    + +
    blenderA 3D Modelling And Rendering Package
    + +

    Includes bundle(s): +

      + +
    • python3-basic
      • + +

    bmap-toolsbmap-tools Tools for creating the block map (bmap) for a file and copying files. Alternative to "dd" or "cp"
    boot-encryptedEnable booting encrypted root partition, swap, or other partitions
    + +

    Includes bundle(s): +

      + +
    • bootloader-extras
      • + +
    +

    + +
    bootloader Loads kernel from disk and boots the system
    @@ -153,7 +270,7 @@
    borgbackupborgbackup Deduplicating archiver with compression and authenticated encryption.
    Build and run C/C++ language programs

    Includes bundle(s): - -

  • perl-basic
    • - +
      + +
    • perl-basic
      • + +
    • nasm
      • + +
    • llvm
      • + +
    • make
      • + +
    • nasm
      • + +

    		c-basic-legacy Build and run 32bit C/C++ language programs
    +

    Includes bundle(s): +

      + +
    • make
      • + +
    • devpkg-zlib
      • + +
    +

    +
    casynccabextract Manipulate CAB archives
    casync Content Addressable Data Synchronizer, to distribute frequently-updated file system images over the Internet
    clamavccache cache compilations to avoid redoing the same computation and speed project build times
    clamav Clam AntiVirus is an anti-virus toolkit for Unix
    cloc Count lines of code for many programming languages
    cloud-api API helpers for cloud access

    Includes bundle(s): - -

  • python3-basic
    • - +
      + +
    • python3-basic
      • + +

    		Run a cloud orchestration server

    Includes bundle(s): - -

  • kvm-host
    • - -
  • network-basic
    • - -
  • openssl
    • - -
  • python3-basic
    • - -
  • cloud-api
    • - -
  • storage-cluster
    • - -
  • sudo
    • - +
      + +
    • cloud-api
      • + +
    • git
      • + +
    • kvm-host
      • + +
    • network-basic
      • + +
    • openssl
      • + +
    • python3-basic
      • + +
    • storage-cluster
      • + +
    • sudo
      • + +

    		Contains ClearLinux native software for Cloud

    Includes bundle(s): - -

  • containers-virt
    • - -
  • ethtool
    • - +
      + +
    • ethtool
      • + +
    • iproute2
      • + +
    • p11-kit
      • + +

    		Run all Clear Linux devops workloads

    Includes bundle(s): - -

  • os-installer
    • - -
  • os-core-update
    • - -
  • mixer
    • - -
  • java-basic
    • - -
  • rust-basic
    • - -
  • koji
    • - -
  • scm-server
    • - -
  • web-server-basic
    • - +
      + +
    • os-installer
      • + +
    • os-core-update
      • + +
    • mixer
      • + +
    • java-basic
      • + +
    • rust-basic
      • + +
    • koji
      • + +
    • scm-server
      • + +
    • web-server-basic
      • + +

    		Image creation and installation for Clear Linux OS

    Includes bundle(s): - -

  • curl
    • - -
  • iproute2
    • - -
  • kbd
    • - -
  • locales
    • - -
  • openssh-server
    • - -
  • telemetrics
    • - -
  • tzdata
    • - -
  • wpa_supplicant
    • - +
      + +
    • curl
      • + +
    • iproute2
      • + +
    • kbd
      • + +
    • locales
      • + +
    • openssh-server
      • + +
    • telemetrics
      • + +
    • tzdata
      • + +
    • wpa_supplicant
      • + +
    • less
      • + +

    cockpitcockpit Web based administration for GNU/Linux servers
    Build computer vision applications

    Includes bundle(s): - -

  • cloud-api
    • - -
  • computer-vision-models
    • - -
  • python-extras
    • - -
  • python-data-science
    • - -
  • python2-basic
    • - +
      + +
    • cloud-api
      • + +
    • computer-vision-models
      • + +
    • python-extras
      • + +
    • python-data-science
      • + +
    • python2-basic
      • + +

    		computer-vision-models Deep learning models for computer vision
    +

    Includes bundle(s): +

      + +
    • machine-learning-tensorflow
      • + +
    +

    +
    Run container applications from Dockerhub

    Includes bundle(s): - -

  • iproute2
    • - -
  • p11-kit
    • - +
      + +
    • git
      • + +
    • iproute2
      • + +
    • p11-kit
      • + +

    		All packages required to build the containers-basic bundle.

    Includes bundle(s): - -

  • containers-basic
    • - -
  • dev-utils
    • - -
  • os-core-dev
    • - +
      + +
    • containers-basic
      • + +
    • dev-utils
      • + +
    • os-core-dev
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • devpkg-glib
      • + +
    • devpkg-gtk3
      • + +
    • gzip
      • + +
    • devpkg-icu4c
      • + +
    • intltool
      • + +
    • kbd
      • + +
    • less
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libsecret
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • make
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • p11-kit
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-qtbase
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • strace
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • which
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • devpkg-zlib
      • + +

    		Run container applications from Dockerhub in lightweight virtual machines

    Includes bundle(s): - -

  • containers-basic
    • - +
      + +
    • containers-basic
      • + +

    		All packages required to build the containers-virt bundle.

    Includes bundle(s): - -

  • containers-basic-dev
    • - -
  • containers-virt
    • - -
  • dev-utils
    • - -
  • os-core-dev
    • - +
      + +
    • containers-basic-dev
      • + +
    • containers-virt
      • + +
    • dev-utils
      • + +
    • os-core-dev
      • + +
    • bc
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • devpkg-glib
      • + +
    • devpkg-gtk3
      • + +
    • gzip
      • + +
    • devpkg-icu4c
      • + +
    • intltool
      • + +
    • kbd
      • + +
    • less
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libpng
      • + +
    • devpkg-libsecret
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • make
      • + +
    • musl
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • p11-kit
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-pixman
      • + +
    • devpkg-qtbase
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • strace
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • which
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • devpkg-zlib
      • + +

    cpiocpio File archiver utility
    Encrypt, decrypt, sign and verify objects

    Includes bundle(s): - -

  • openssl
    • - +
      + +
    • openssl
      • + +

    		Manage the Trusted Platform Module (TPM)

    Includes bundle(s): - -

  • TPM
    • - +
      + +
    • TPM
      • + +
    +

    + +
    cryptoprocessor-management-devAll packages required to build the cryptoprocessor-management bundle.
    + +

    Includes bundle(s): +

      + +
    • cryptoprocessor-management
      • + +
    • dev-utils
      • + +
    • os-core-dev
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • devpkg-glib
      • + +
    • gzip
      • + +
    • intltool
      • + +
    • kbd
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • make
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • p11-kit
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • strace
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • which
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • devpkg-zlib
      • + +

    curlcurl Transfer data to/from a URL
    darktablecve-bin CVE scanning tool
    darktable Photography workflow application
    Run a SQL database

    Includes bundle(s): - -

  • python3-basic
    • - +
      + +
    • python3-basic
      • + +
    • postgresql
      • + +

    		All packages required to build the database-basic bundle.

    Includes bundle(s): - -

  • database-basic
    • - -
  • dev-utils
    • - -
  • os-core-dev
    • - +
      + +
    • database-basic
      • + +
    • dev-utils
      • + +
    • os-core-dev
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • devpkg-glib
      • + +
    • gzip
      • + +
    • devpkg-icu4c
      • + +
    • intltool
      • + +
    • kbd
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • make
      • + +
    • nasm
      • + +
    • devpkg-openmpi
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • p11-kit
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • strace
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • which
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • yasm
      • + +
    • devpkg-zlib
      • + +

    		Run the GNOME GUI desktop environment

    Includes bundle(s): - -

  • libX11client
    • - -
  • x11-server
    • - -
  • desktop-apps
    • - -
  • desktop-gnomelibs
    • - -
  • desktop-assets
    • - -
  • desktop-locales
    • - -
  • openssl
    • - -
  • sysadmin-basic
    • - -
  • which
    • - -
  • wpa_supplicant
    • - +
      + +
    • libX11client
      • + +
    • x11-server
      • + +
    • desktop-apps
      • + +
    • desktop-gnomelibs
      • + +
    • desktop-assets
      • + +
    • desktop-locales
      • + +
    • openssl
      • + +
    • sysadmin-basic
      • + +
    • which
      • + +
    • wpa_supplicant
      • + +
    • fuse
      • + +
    • tzdata
      • + +
    • alsa-utils
      • + +
    • fwupdate
      • + +

    		Applications for the desktop

    Includes bundle(s): - -

  • libX11client
    • - -
  • desktop-gnomelibs
    • - -
  • python3-basic
    • - -
  • xemacs
    • - +
      + +
    • libX11client
      • + +
    • desktop-gnomelibs
      • + +
    • python3-basic
      • + +
    • xemacs
      • + +
    • firefox
      • + +
    • libva-utils
      • + +
    • xemacs
      • + +

    		Larger set of applications for the desktop

    Includes bundle(s): - -

  • desktop-gnomelibs
    • - -
  • desktop-kde-apps
    • - -
  • python3-basic
    • - -
  • atom
    • - -
  • darktable
    • - -
  • gimp
    • - -
  • thunderbird
    • - -
  • vlc
    • - +
      + +
    • desktop-gnomelibs
      • + +
    • pidgin
      • + +
    • python3-basic
      • + +
    • virt-manager
      • + +
    • atom
      • + +
    • darktable
      • + +
    • thunderbird
      • + +
    • vlc
      • + +
    • gimp
      • + +

    		Images and Icons for the desktop

    Includes bundle(s): - -

  • desktop-gnomelibs
    • - +
      + +
    • desktop-gnomelibs
      • + +
    • intended for all supported styles
      • + +
    • current default
      • + +
    • common
      • + +

    		Bundle to cause the UI to automatically start at boot

    Includes bundle(s): - -

  • desktop
    • - +
      + +
    • desktop
      • + +

    		Run a minimal desktop environment with awesome WM

    Includes bundle(s): - -

  • x11-server
    • - +
      + +
    • x11-server
      • + +

    		All packages required to build the desktop bundle.

    Includes bundle(s): - -

  • desktop
    • - -
  • dev-utils
    • - -
  • os-core-dev
    • - -
  • sysadmin-basic-dev
    • - +
      + +
    • desktop
      • + +
    • dev-utils
      • + +
    • os-core-dev
      • + +
    • sysadmin-basic-dev
      • + +
    • devpkg-at-spi2-atk
      • + +
    • devpkg-at-spi2-core
      • + +
    • devpkg-atk
      • + +
    • devpkg-cairo
      • + +
    • devpkg-cheese
      • + +
    • devpkg-clutter
      • + +
    • devpkg-clutter-gst
      • + +
    • devpkg-cogl
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • docutils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-evolution-data-server
      • + +
    • devpkg-evolution
      • + +
    • devpkg-expat
      • + +
    • devpkg-fontconfig
      • + +
    • fonttools
      • + +
    • devpkg-freetype
      • + +
    • devpkg-fribidi
      • + +
    • gdb
      • + +
    • devpkg-gdk-pixbuf
      • + +
    • devpkg-glib
      • + +
    • devpkg-gnome-desktop
      • + +
    • gpgme
      • + +
    • devpkg-graphite
      • + +
    • devpkg-gsettings-desktop-schemas
      • + +
    • devpkg-gst-plugins-base
      • + +
    • devpkg-gstreamer
      • + +
    • devpkg-gtk3
      • + +
    • gzip
      • + +
    • devpkg-harfbuzz
      • + +
    • devpkg-icu4c
      • + +
    • intltool
      • + +
    • iproute2
      • + +
    • jq
      • + +
    • kbd
      • + +
    • less
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libdrm
      • + +
    • devpkg-libepoxy
      • + +
    • devpkg-libical
      • + +
    • devpkg-libpciaccess
      • + +
    • devpkg-libpng
      • + +
    • devpkg-libpthread-stubs
      • + +
    • devpkg-libsecret
      • + +
    • devpkg-libsoup
      • + +
    • devpkg-libxkbcommon
      • + +
    • libxml2
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • llvm
      • + +
    • make
      • + +
    • devpkg-mesa
      • + +
    • nasm
      • + +
    • devpkg-nspr
      • + +
    • devpkg-nss
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • devpkg-orc
      • + +
    • p11-kit
      • + +
    • devpkg-pango
      • + +
    • parallel
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-pixman
      • + +
    • devpkg-qtbase
      • + +
    • devpkg-qtdeclarative
      • + +
    • scons
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • strace
      • + +
    • subversion
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • devpkg-wayland
      • + +
    • devpkg-wayland-protocols
      • + +
    • devpkg-webkitgtk
      • + +
    • which
      • + +
    • devpkg-xorg-server
      • + +
    • devpkg-xorgproto
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • yasm
      • + +
    • devpkg-zlib
      • + +

    		Helper bundle with common libraries used by desktopy things

    Includes bundle(s): - -

  • libX11client
    • - +
      + +
    • libX11client
      • + +

    		Run the i3 desktop environment

    Includes bundle(s): - -

  • x11-server
    • - +
      + +
    • x11-server
      • + +

    		Applications for the desktop from the KDE ecosystem

    Includes bundle(s): - -

  • desktop-kde-libs
    • - -
  • desktop-kde-apps
    • - -
  • qt-basic
    • - -
  • x11-tools
    • - -
  • x11-server
    • - +
      + +
    • desktop-kde-libs
      • + +
    • desktop-kde-apps
      • + +
    • qt-basic
      • + +
    • x11-tools
      • + +
    • x11-server
      • + +
    • fuse
      • + +
    • gpgme
      • + +
    • kdiff3
      • + +
    • libxslt
      • + +

    		Applications for the desktop from the KDE ecosystem

    Includes bundle(s): - -

  • desktop-kde-libs
    • - -
  • qt-basic
    • - +
      + +
    • desktop-kde-libs
      • + +
    • perl-basic
      • + +
    • qt-basic
      • + +

    		Helper libraries from the KDE ecosystem

    Includes bundle(s): - -

  • qt-basic
    • - +
      + +
    • qt-basic
      • + +

    		desktop-locales translations and documentation for desktop components
    +

    Includes bundle(s): +

      + +
    • perl-basic
      • + +
    +

    +
    Assist application development

    Includes bundle(s): - -

  • git
    • - -
  • openssl
    • - -
  • perl-basic
    • - -
  • python3-basic
    • - +
      + +
    • git
      • + +
    • openssl
      • + +
    • perl-basic
      • + +
    • python3-basic
      • + +
    • bc
      • + +
    • cloc
      • + +
    • cpio
      • + +
    • diffutils
      • + +
    • docutils
      • + +
    • gdb
      • + +
    • icdiff
      • + +
    • inotify-tools
      • + +
    • linux-tools
      • + +
    • llvm
      • + +
    • patch
      • + +
    • strace
      • + +
    • valgrind
      • + +

    		All packages required to build the dev-utils bundle.

    Includes bundle(s): - -

  • dev-utils
    • - -
  • os-core-dev
    • - -
  • perl-basic-dev
    • - +
      + +
    • dev-utils
      • + +
    • os-core-dev
      • + +
    • perl-basic-dev
      • + +
    • bc
      • + +
    • devpkg-cairo
      • + +
    • cpio
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • devpkg-glib
      • + +
    • gzip
      • + +
    • devpkg-icu4c
      • + +
    • intltool
      • + +
    • kbd
      • + +
    • less
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libpciaccess
      • + +
    • devpkg-libpng
      • + +
    • devpkg-libpthread-stubs
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • llvm
      • + +
    • make
      • + +
    • devpkg-mesa
      • + +
    • devpkg-openmpi
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • p11-kit
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-qtbase
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • strace
      • + +
    • subversion
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • which
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • yasm
      • + +
    • devpkg-zlib
      • + +
    +

    + +
    dev-utils-guiAssist application development (gui components)
    + +

    Includes bundle(s): +

      + +
    • dev-utils
      • + +
    • libX11client
      • + +
    • tcl-basic
      • + +
    • qt-basic
      • + +
    +

    + +
    devpkg-at-spi2-atkAll content for pkgconfig file at-spi2-atk.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-at-spi2-core
      • + +
    • devpkg-glib
      • + +
    +

    + +
    devpkg-at-spi2-coreAll content for pkgconfig file at-spi2-core.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-dbus
      • + +
    • devpkg-glib
      • + +
    +

    + +
    devpkg-atkAll content for pkgconfig file atk.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-glib
      • + +
    +

    + +
    devpkg-basebasic pkgconfig infra
    + +

    Includes bundle(s): +

      + +
    • c-basic
      • + +
    +

    + +
    devpkg-cairoAll content for pkgconfig file cairo.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-fontconfig
      • + +
    • devpkg-freetype
      • + +
    • devpkg-glib
      • + +
    • devpkg-libX11
      • + +
    • devpkg-mesa
      • + +
    • devpkg-pixman
      • + +
    +

    + +
    devpkg-cheeseAll content for pkgconfig file cheese.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-clutter
      • + +
    • devpkg-clutter-gst
      • + +
    • devpkg-gdk-pixbuf
      • + +
    • devpkg-glib
      • + +
    • devpkg-gstreamer
      • + +
    +

    + +
    devpkg-clutterAll content for pkgconfig file clutter.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-clutter-gstAll content for pkgconfig file clutter-gst.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-clutter
      • + +
    • devpkg-cogl
      • + +
    • devpkg-glib
      • + +
    • devpkg-gst-plugins-base
      • + +
    • devpkg-gstreamer
      • + +
    +

    + +
    devpkg-coglAll content for pkgconfig file cogl.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-dbusAll content for pkgconfig file dbus.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-elfutilsAll content for pkgconfig file elfutils.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-xz
      • + +
    • devpkg-zlib
      • + +
    +

    + +
    devpkg-evolutionAll content for pkgconfig file evolution.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-evolution-data-server
      • + +
    • devpkg-glib
      • + +
    • devpkg-gnome-desktop
      • + +
    • devpkg-gtk3
      • + +
    • devpkg-webkitgtk
      • + +
    +

    + +
    devpkg-evolution-data-serverAll content for pkgconfig file evolution-data-server.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-glib
      • + +
    • devpkg-gtk3
      • + +
    • devpkg-libical
      • + +
    • devpkg-libsecret
      • + +
    • devpkg-libsoup
      • + +
    • devpkg-libxml2
      • + +
    • devpkg-nspr
      • + +
    • devpkg-nss
      • + +
    • devpkg-sqlite-autoconf
      • + +
    +

    + +
    devpkg-expatAll content for pkgconfig file expat.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-fontconfigAll content for pkgconfig file fontconfig.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-expat
      • + +
    • devpkg-freetype
      • + +
    • devpkg-util-linux
      • + +
    +

    + +
    devpkg-freetypeAll content for pkgconfig file freetype.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-harfbuzz
      • + +
    • devpkg-zlib
      • + +
    +

    + +
    devpkg-fribidiAll content for pkgconfig file fribidi.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-fuseAll content for pkgconfig file fuse.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-gdk-pixbufAll content for pkgconfig file gdk-pixbuf.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-glib
      • + +
    • devpkg-libpng
      • + +
    +

    + +
    devpkg-glibAll content for pkgconfig file glib.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-pcre
      • + +
    • devpkg-util-linux
      • + +
    +

    + +
    devpkg-gnome-desktopAll content for pkgconfig file gnome-desktop.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-gsettings-desktop-schemas
      • + +
    • devpkg-gtk3
      • + +
    +

    + +
    devpkg-graphiteAll content for pkgconfig file graphite.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-gsettings-desktop-schemasAll content for pkgconfig file gsettings-desktop-schemas.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-gst-plugins-baseAll content for pkgconfig file gst-plugins-base.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-gstreamer
      • + +
    • devpkg-orc
      • + +
    +

    + +
    devpkg-gstreamerAll content for pkgconfig file gstreamer.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-glib
      • + +
    +

    + +
    devpkg-gtk3All content for pkgconfig file gtk3.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-at-spi2-atk
      • + +
    • devpkg-atk
      • + +
    • devpkg-cairo
      • + +
    • devpkg-fontconfig
      • + +
    • devpkg-gdk-pixbuf
      • + +
    • devpkg-glib
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libepoxy
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-pango
      • + +
    • devpkg-wayland
      • + +
    • devpkg-wayland-protocols
      • + +
    +

    + +
    devpkg-harfbuzzAll content for pkgconfig file harfbuzz.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-glib
      • + +
    • devpkg-graphite
      • + +
    +

    + +
    devpkg-icu4cAll content for pkgconfig file icu4c.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-libdrmAll content for pkgconfig file libdrm.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-libepoxyAll content for pkgconfig file libepoxy.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-mesa
      • + +
    +

    + +
    devpkg-libicalAll content for pkgconfig file libical.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-icu4c
      • + +
    +

    + +
    devpkg-libpciaccessAll content for pkgconfig file libpciaccess.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-libpngAll content for pkgconfig file libpng.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-zlib
      • + +
    +

    + +
    devpkg-libpthread-stubsAll content for pkgconfig file libpthread-stubs.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-libsecretAll content for pkgconfig file libsecret.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-glib
      • + +
    +

    + +
    devpkg-libsoupAll content for pkgconfig file libsoup.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-glib
      • + +
    • devpkg-libxml2
      • + +
    +

    + +
    devpkg-libX11All content for pkgconfig file libX11.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-libpthread-stubs
      • + +
    • devpkg-xorgproto
      • + +
    +

    + +
    devpkg-libXauAll content for pkgconfig file libXau.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-xorgproto
      • + +
    +

    + +
    devpkg-libxcbAll content for pkgconfig file libxcb.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-libXau
      • + +
    • devpkg-libXdmcp
      • + +
    • devpkg-libpthread-stubs
      • + +
    +

    + +
    devpkg-libXcompositeAll content for pkgconfig file libXcomposite.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libXfixes
      • + +
    • devpkg-xorgproto
      • + +
    +

    + +
    devpkg-libXdamageAll content for pkgconfig file libXdamage.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libXfixes
      • + +
    • devpkg-xorgproto
      • + +
    +

    + +
    devpkg-libXdmcpAll content for pkgconfig file libXdmcp.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-xorgproto
      • + +
    +

    + +
    devpkg-libXextAll content for pkgconfig file libXext.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-libX11
      • + +
    • devpkg-xorgproto
      • + +
    +

    + +
    devpkg-libXfixesAll content for pkgconfig file libXfixes.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-libX11
      • + +
    • devpkg-xorgproto
      • + +
    +

    + +
    devpkg-libXiAll content for pkgconfig file libXi.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libXext
      • + +
    • devpkg-libXfixes
      • + +
    • devpkg-xorgproto
      • + +
    +

    + +
    devpkg-libXineramaAll content for pkgconfig file libXinerama.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libXext
      • + +
    • devpkg-xorgproto
      • + +
    +

    + +
    devpkg-libxkbcommonAll content for pkgconfig file libxkbcommon.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-libxml2All content for pkgconfig file libxml2.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-libXrandrAll content for pkgconfig file libXrandr.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libXext
      • + +
    • devpkg-libXrender
      • + +
    • devpkg-xorgproto
      • + +
    +

    + +
    devpkg-libXrenderAll content for pkgconfig file libXrender.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-libX11
      • + +
    • devpkg-xorgproto
      • + +
    +

    + +
    devpkg-libXxf86vmAll content for pkgconfig file libXxf86vm.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libXext
      • + +
    • devpkg-xorgproto
      • + +
    +

    + +
    devpkg-mesaAll content for pkgconfig file mesa.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libdrm
      • + +
    +

    + +
    devpkg-nsprAll content for pkgconfig file nspr.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-nssAll content for pkgconfig file nss.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-nspr
      • + +
    +

    + +
    devpkg-openblasAll content for pkgconfig file openblas.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-opencvAll content for pkgconfig file opencv.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-openmpiAll content for pkgconfig file openmpi.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-opensslAll content for pkgconfig file openssl.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-orcAll content for pkgconfig file orc.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-pangoAll content for pkgconfig file pango.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-cairo
      • + +
    • devpkg-fontconfig
      • + +
    • devpkg-freetype
      • + +
    • devpkg-fribidi
      • + +
    • devpkg-glib
      • + +
    • devpkg-harfbuzz
      • + +
    +

    + +
    devpkg-pcreAll content for pkgconfig file pcre.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-pixmanAll content for pkgconfig file pixman.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-qt3dAll content for pkgconfig file qt3d.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-qtbase
      • + +
    • devpkg-qtdeclarative
      • + +
    +

    + +
    devpkg-qtbaseAll content for pkgconfig file qtbase.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-qtdeclarativeAll content for pkgconfig file qtdeclarative.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-qtbase
      • + +
    +

    + +
    devpkg-sqlite-autoconfAll content for pkgconfig file sqlite-autoconf.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-util-linuxAll content for pkgconfig file util-linux.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-waylandAll content for pkgconfig file wayland.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-wayland-protocolsAll content for pkgconfig file wayland-protocols.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-webkitgtkAll content for pkgconfig file webkitgtk.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-glib
      • + +
    • devpkg-gtk3
      • + +
    • devpkg-libsoup
      • + +
    +

    + +
    devpkg-xorg-serverAll content for pkgconfig file xorg-server.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    • devpkg-libpciaccess
      • + +
    • devpkg-mesa
      • + +
    • devpkg-pixman
      • + +
    • devpkg-xorgproto
      • + +
    +

    + +
    devpkg-xorgprotoAll content for pkgconfig file xorgproto.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-xzAll content for pkgconfig file xz.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +
    +

    + +
    devpkg-zlibAll content for pkgconfig file zlib.pc
    + +

    Includes bundle(s): +

      + +
    • devpkg-base
      • + +

    dfu-utildfu-util Device Firmware Upgrade Utilities
    diffoscopediffoscope In-depth comparison of files, archives, and directories
    diffutilsdiffutils Tools for file comparisons and differences
    djangoDjango web framwork
    + +

    Includes bundle(s): +

      + +
    • python-basic
      • + +
    +

    + +
    docutilsdocbook-utils docbook tools
    docutils Tools for converting text to other formats (e.g. HTML, XML, LaTeX)
    Home Automation software collection

    Includes bundle(s): - -

  • cloud-api
    • - -
  • python3-basic
    • - +
      + +
    • cloud-api
      • + +
    • python3-basic
      • + +

    dovecotdosfstools
    dovecot Security focused IMAP and POP3 email server
    dtcdoxygen documentation tooling
    dtc Device Tree Compiler, to describe non-discoverable hardware
    duperemoveduperemove Tool for finding duplicated extents and submitting them for deduplication
    Run popular terminal text editors

    Includes bundle(s): - -

  • emacs
    • - -
  • joe
    • - -
  • vim
    • - +
      + +
    • emacs
      • + +
    • joe
      • + +
    • vim
      • + +

    		All packages required to build the editors bundle.

    Includes bundle(s): - -

  • dev-utils
    • - -
  • editors
    • - -
  • os-core-dev
    • - +
      + +
    • dev-utils
      • + +
    • editors
      • + +
    • os-core-dev
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • devpkg-glib
      • + +
    • gzip
      • + +
    • devpkg-icu4c
      • + +
    • intltool
      • + +
    • kbd
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • make
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • p11-kit
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • strace
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • which
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • devpkg-zlib
      • + +

    		Educational applications

    Includes bundle(s): - -

  • desktop-gnomelibs
    • - -
  • desktop-kde-libs
    • - -
  • libX11client
    • - -
  • qt-basic
    • - -
  • education-preschool
    • - -
  • education-primary
    • - -
  • education-secondary
    • - -
  • education-tertiary
    • - +
      + +
    • desktop-gnomelibs
      • + +
    • desktop-kde-libs
      • + +
    • libX11client
      • + +
    • qt-basic
      • + +
    • education-preschool
      • + +
    • education-primary
      • + +
    • education-secondary
      • + +
    • education-tertiary
      • + +
    • gimp
      • + +

    		Educational applications for the preschool level

    Includes bundle(s): - -

  • desktop-gnomelibs
    • - -
  • desktop-kde-libs
    • - -
  • libX11client
    • - -
  • qt-basic
    • - +
      + +
    • desktop-gnomelibs
      • + +
    • desktop-kde-libs
      • + +
    • libX11client
      • + +
    • qt-basic
      • + +

    		Educational applications for the primary school level

    Includes bundle(s): - -

  • desktop-gnomelibs
    • - -
  • desktop-kde-libs
    • - -
  • libX11client
    • - -
  • qt-basic
    • - +
      + +
    • desktop-gnomelibs
      • + +
    • desktop-kde-libs
      • + +
    • libX11client
      • + +
    • qt-basic
      • + +

    		Educational applications for the secondary school level

    Includes bundle(s): - -

  • desktop-gnomelibs
    • - -
  • desktop-kde-libs
    • - -
  • libX11client
    • - -
  • qt-basic
    • - +
      + +
    • desktop-gnomelibs
      • + +
    • desktop-kde-libs
      • + +
    • libX11client
      • + +
    • qt-basic
      • + +

    		Educational applications for the tertiary school/university level

    Includes bundle(s): - -

  • desktop-gnomelibs
    • - -
  • desktop-kde-libs
    • - -
  • libX11client
    • - -
  • qt-basic
    • - +
      + +
    • desktop-gnomelibs
      • + +
    • desktop-kde-libs
      • + +
    • libX11client
      • + +
    • qt-basic
      • + +

    ethtoolethtool Utility for displaying and modifying some parameters of network interface controller
    filefile program for recognizing the type of data contained in a computer file
    findutilsfindutils basic directory searching utilities e.g. find, xargs, and locate
    fiofio Flexible I/O tester
    firefoxfirefox Web Browser
    Update the system's firmware

    Includes bundle(s): - -

  • cryptography
    • - -
  • libX11client
    • - +
      + +
    • cryptography
      • + +
    • libX11client
      • + +
    • fwupdate
      • + +

    flac FLAC audio format tools
    flatpak Use flatpak packages, or build them
    +

    Includes bundle(s): +

      + +
    • git
      • + +
    +

    +
    fwupdatefonttools tools to manipulate system and user fonts
    fossil Fossil is a simple, high-reliability, distributed software configuration management system
    fuse fuse filesystem support
    fwupdate Firmware update tool
    Play games in Clear Linux

    Includes bundle(s): - -

  • libX11client
    • - -
  • p11-kit
    • - +
      + +
    • libX11client
      • + +
    • p11-kit
      • + +
    • perl-basic
      • + +
    • diffutils
      • + +
    • theme, data, etc
      • + +
    • 32-bit
      • + +
    • native
      • + +
    • 32-bit
      • + +
    • native
      • + +

    		All packages required to build the games bundle.

    Includes bundle(s): - -

  • dev-utils
    • - -
  • games
    • - -
  • os-core-dev
    • - +
      + +
    • dev-utils
      • + +
    • games
      • + +
    • os-core-dev
      • + +
    • perl-basic-dev
      • + +
    • devpkg-at-spi2-atk
      • + +
    • devpkg-at-spi2-core
      • + +
    • devpkg-atk
      • + +
    • devpkg-cairo
      • + +
    • devpkg-clutter
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • devpkg-fontconfig
      • + +
    • devpkg-freetype
      • + +
    • devpkg-fribidi
      • + +
    • gdb
      • + +
    • devpkg-gdk-pixbuf
      • + +
    • devpkg-glib
      • + +
    • devpkg-graphite
      • + +
    • devpkg-gst-plugins-base
      • + +
    • devpkg-gstreamer
      • + +
    • devpkg-gtk3
      • + +
    • gzip
      • + +
    • devpkg-harfbuzz
      • + +
    • devpkg-icu4c
      • + +
    • intltool
      • + +
    • kbd
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libdrm
      • + +
    • devpkg-libepoxy
      • + +
    • devpkg-libical
      • + +
    • devpkg-libpciaccess
      • + +
    • devpkg-libpng
      • + +
    • devpkg-libpthread-stubs
      • + +
    • devpkg-libsecret
      • + +
    • devpkg-libsoup
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • llvm
      • + +
    • make
      • + +
    • devpkg-mesa
      • + +
    • nasm
      • + +
    • devpkg-nspr
      • + +
    • devpkg-nss
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • devpkg-orc
      • + +
    • p11-kit
      • + +
    • devpkg-pango
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-pixman
      • + +
    • devpkg-qtbase
      • + +
    • scons
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • strace
      • + +
    • subversion
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • devpkg-wayland
      • + +
    • devpkg-wayland-protocols
      • + +
    • devpkg-webkitgtk
      • + +
    • which
      • + +
    • devpkg-xorgproto
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • yasm
      • + +
    • devpkg-zlib
      • + +

    gdbgdb GNU debugger
    gftpgftp Text mode and GUI FTP Client
    gimpgimp GNU Image Manipulation Program
    git SCM tool

    Includes bundle(s): - -

  • openssl
    • - -
  • p11-kit
    • - +
      + +
    • openssl
      • + +
    • p11-kit
      • + +
    • less
      • + +

    glmark2glmark2 OpenGL 2.0 and ES 2.0 benchmark
    global GNU GLOBAL source code tagging system
    go-basic Build and run go language programs

    Includes bundle(s): - -

  • git
    • - -
  • p11-kit
    • - +
      + +
    • git
      • + +
    • p11-kit
      • + +

    		All packages required to build the go-basic bundle.

    Includes bundle(s): - -

  • dev-utils
    • - -
  • go-basic
    • - -
  • os-core-dev
    • - +
      + +
    • dev-utils
      • + +
    • go-basic
      • + +
    • os-core-dev
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • devpkg-glib
      • + +
    • gzip
      • + +
    • intltool
      • + +
    • kbd
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • make
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • p11-kit
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • strace
      • + +
    • texinfo
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • which
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • devpkg-zlib
      • + +

    goaccessgoaccess Real-time web log analyzer
    gzipgpgme GPG encryption tools
    gzip lossless data compression/decompression utility
    hardware-wifi Firmware and tools for basic wifi support
    +

    Includes bundle(s): +

      + +
    • wpa_supplicant
      • + +
    +

    +
    Build and run haskell language programs

    Includes bundle(s): - -

  • git
    • - -
  • p11-kit
    • - -
  • perl-basic
    • - -
  • c-basic
    • - +
      + +
    • git
      • + +
    • p11-kit
      • + +
    • perl-basic
      • + +
    • c-basic
      • + +
    • make
      • + +
    • xz
      • + +
    • devpkg-zlib
      • + +

    		Provide userspace management programs for various HPC related programs.

    Includes bundle(s): - -

  • perl-basic
    • - +
      + +
    • perl-basic
      • + +

    htophtop interactive text-mode process viewer
    httpdhttpd Apache HyperText Transfer Protocol (HTTP) Server daemon
    hugohugo Static Web site generator
    iasimagehwloc hardware affinity tools
    iasimage for creating Intel Automotive Service (IAS) images, a binary file format understood by Intel© Slim Bootloader
    icdifficdiff Improved Color Differences between similar files
    iftopicecream Distributed network compilation
    iftop display bandwidth usage on an interface
    ImageMagick

    Includes bundle(s): - -

  • libX11client
    • - +
      + +
    • libX11client
      • + +

    inotify-toolsinkscape Inkscape SVG drawing program
    inotify-tools monitor for file system events
    iproute2intltool internationalization tool for develops
    ipmitool Manage IPMI functions of a local or remote system
    iproute2 utilities for controlling TCP / IP networking and traffic control
    ipvsadm used to set up, maintain or inspect the virtual server table in the Linux kernel ipvsadm Virtual Server admin tool used to set up, maintain or inspect the virtual server table in the Linux kernel
    irssiirssi Internet Relay Chat (IRC) client program
    Build and run java language programs

    Includes bundle(s): - -

  • libX11client
    • - -
  • p11-kit
    • - -
  • python3-basic
    • - -
  • which
    • - +
      + +
    • libX11client
      • + +
    • p11-kit
      • + +
    • perl-basic
      • + +
    • python3-basic
      • + +
    • which
      • + +

    		Run java language programs

    Includes bundle(s): - -

  • libX11client
    • - +
      + +
    • libX11client
      • + +

    		Build and run java9 language programs

    Includes bundle(s): - -

  • libX11client
    • - -
  • p11-kit
    • - -
  • python3-basic
    • - -
  • which
    • - +
      + +
    • libX11client
      • + +
    • p11-kit
      • + +
    • python3-basic
      • + +
    • which
      • + +

    joejoe Text editor
    jqjq lightweight and flexible command-line JSON processor
    kbdkbd library to manage the Linux keymaps
    keepalivedkdiff3 Feature-Rich Code Comparison Utility
    keepalived strong & robust keepalive facility for the Linux Virtual Server project
    keepassxckeepassxc KeePassXC is a password manager
    Run the kvm specific kernel

    Includes bundle(s): - -

  • bootloader
    • - +
      + +
    • bootloader
      • + +

    		Run the kvm specific kernel

    Includes bundle(s): - -

  • bootloader
    • - +
      + +
    • bootloader
      • + +

    		Run the hyperv specific kernel

    Includes bundle(s): - -

  • bootloader
    • - +
      + +
    • bootloader
      • + +

    		Run the hyperv specific LTS kernel

    Includes bundle(s): - -

  • bootloader
    • - +
      + +
    • bootloader
      • + +

    		Run the hyperv mini-os specific kernel

    Includes bundle(s): - -

  • kernel-hyperv
    • - +
      + +
    • kernel-hyperv
      • + +

    kernel-installkernel-install installs kernel, initrd, kernel config and system map and creates a bootloader entry for the new kernel
    Run the Intel "PK" kernel, an enterprise-style kernel with backports, plus PREEMPT_RT support

    Includes bundle(s): - -

  • bootloader
    • - +
      + +
    • bootloader
      • + +

    		Run the Intel "PK" kernel, and enterprise-style kernel with backports

    Includes bundle(s): - -

  • bootloader
    • - +
      + +
    • bootloader
      • + +

    		Run the kvm specific kernel

    Includes bundle(s): - -

  • bootloader
    • - +
      + +
    • bootloader
      • + +

    		Run the lts native kernel

    Includes bundle(s): - -

  • bootloader
    • - +
      + +
    • bootloader
      • + +

    		Run the native kernel

    Includes bundle(s): - -

  • bootloader
    • - +
      + +
    • bootloader
      • + +

    kernel-native-dkmsSupport module building/loading via DKMS in native kernel
    + +

    Includes bundle(s): +

      + +
    • c-basic
      • + +
    • linux-dev
      • + +
    +

    + +
    kernel-networktestkernel with NFS root FS support and modular network drivers
    + +
    kernel-oracle Run the Oracle Cloud specific kernel

    Includes bundle(s): - -

  • bootloader
    • - +
      + +
    • bootloader
      • + +

    		Run the Intel "PK" kernel, and enterprise-style kernel with backports

    Includes bundle(s): - -

  • bootloader
    • - +
      + +
    • kernel-iot-lts2018
      • + +

    		Run the native kernel with preempt_rt patchset

    Includes bundle(s): - -

  • bootloader
    • - +
      + +
    • bootloader
      • + +

    keychainkeychain manage SSH and GPG keys
    Sets up a koji build service based on NFS mounts.

    Includes bundle(s): - -

  • package-utils
    • - -
  • python2-basic
    • - -
  • web-server-basic
    • - +
      + +
    • git
      • + +
    • package-utils
      • + +
    • python2-basic
      • + +
    • web-server-basic
      • + +
    • nfs-utils
      • + +
    • postgresql
      • + +

    		Run virtual machines

    Includes bundle(s): - -

  • libX11client
    • - +
      + +
    • libX11client
      • + +

    		All packages required to build the kvm-host bundle.

    Includes bundle(s): - -

  • dev-utils
    • - -
  • kvm-host
    • - -
  • os-core-dev
    • - +
      + +
    • dev-utils
      • + +
    • kvm-host
      • + +
    • os-core-dev
      • + +
    • acpica-unix2
      • + +
    • devpkg-at-spi2-atk
      • + +
    • devpkg-at-spi2-core
      • + +
    • devpkg-atk
      • + +
    • devpkg-cairo
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • dosfstools
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • devpkg-fontconfig
      • + +
    • devpkg-freetype
      • + +
    • devpkg-fribidi
      • + +
    • gdb
      • + +
    • devpkg-gdk-pixbuf
      • + +
    • devpkg-glib
      • + +
    • devpkg-graphite
      • + +
    • devpkg-gtk3
      • + +
    • gzip
      • + +
    • devpkg-harfbuzz
      • + +
    • devpkg-icu4c
      • + +
    • intltool
      • + +
    • kbd
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libdrm
      • + +
    • devpkg-libepoxy
      • + +
    • devpkg-libpciaccess
      • + +
    • devpkg-libpng
      • + +
    • devpkg-libpthread-stubs
      • + +
    • devpkg-libsoup
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • llvm
      • + +
    • make
      • + +
    • devpkg-mesa
      • + +
    • nasm
      • + +
    • nfs-utils
      • + +
    • devpkg-nspr
      • + +
    • devpkg-nss
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • devpkg-orc
      • + +
    • p11-kit
      • + +
    • devpkg-pango
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-pixman
      • + +
    • scons
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • strace
      • + +
    • subversion
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • devpkg-wayland
      • + +
    • devpkg-wayland-protocols
      • + +
    • which
      • + +
    • devpkg-xorgproto
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • yasm
      • + +
    • devpkg-zlib
      • + +

    		Run virtual machines as deployed infrastructure

    Includes bundle(s): - -

  • kvm-host
    • - -
  • python3-basic
    • - +
      + +
    • kvm-host
      • + +
    • python3-basic
      • + +

    less the less page
    letsencrypt-client Obtain and renew valid SSL certificates through Let's Encrypt's ACME service.

    Includes bundle(s): - -

  • python3-basic
    • - -
  • cloud-api
    • - +
      + +
    • python3-basic
      • + +
    • cloud-api
      • + +

    lftplftp File transfer client for http, ftp, sftp and more
    libva-utilslibnl Low level firewall tools
    libva-utils collection of utilities and examples to exercise VA-API (Video Acceleration API)
    libxml2 XML processing tools
    libxslt XML documentation processing tools
    libzmq ZMQ tools and libs
    lightdm LightDM login manager with GTK greeter
    @@ -1805,19 +4921,33 @@
    linux-devlinux-dev programs for developing Linux
    linux-toolslinux-tools Tools for use in Linux
    llvm LLVM/Clang compiler toolchain
    lm-sensors Read various system sensors, sometimes using scary methods
    locales basic system translations
    @@ -1828,7 +4958,7 @@
    logrotatelogrotate manages the automatic rotation and compression of log files
    lz4 tools to compress and decompress lz4 files
    machine-learning-basic Build machine learning applications

    Includes bundle(s): - -

  • c-basic
    • - -
  • cloud-api
    • - -
  • python-extras
    • - -
  • python-data-science
    • - -
  • computer-vision-basic
    • - -
  • machine-learning-mycroft
    • - -
  • machine-learning-tensorflow
    • - +
      + +
    • c-basic
      • + +
    • cloud-api
      • + +
    • python-extras
      • + +
    • python-data-science
      • + +
    • computer-vision-basic
      • + +
    • machine-learning-mycroft
      • + +
    • machine-learning-tensorflow
      • + +

    		Build machine learning applications with mycroft

    Includes bundle(s): - -

  • python-data-science
    • - +
      + +
    • python-data-science
      • + +

    		Build machine learning applications using Tensorflow

    Includes bundle(s): - -

  • cloud-api
    • - -
  • python-data-science
    • - +
      + +
    • cloud-api
      • + +
    • python-data-science
      • + +

    		Web based, interactive tools for machine learning

    Includes bundle(s): - -

  • cloud-api
    • - -
  • R-extras
    • - -
  • python3-basic
    • - -
  • python-data-science
    • - +
      + +
    • cloud-api
      • + +
    • R-extras
      • + +
    • python3-basic
      • + +
    • python-data-science
      • + +

    		Process, read and send email

    Includes bundle(s): - -

  • python2-basic
    • - +
      + +
    • python2-basic
      • + +
    • mutt
      • + +

    		All packages required to build the mail-utils bundle.

    Includes bundle(s): - -

  • dev-utils
    • - -
  • mail-utils
    • - -
  • os-core-dev
    • - +
      + +
    • dev-utils
      • + +
    • mail-utils
      • + +
    • os-core-dev
      • + +
    • devpkg-cairo
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • devpkg-fontconfig
      • + +
    • devpkg-freetype
      • + +
    • gdb
      • + +
    • devpkg-glib
      • + +
    • gpgme
      • + +
    • devpkg-graphite
      • + +
    • gzip
      • + +
    • devpkg-harfbuzz
      • + +
    • devpkg-icu4c
      • + +
    • intltool
      • + +
    • kbd
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libpng
      • + +
    • devpkg-libpthread-stubs
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • make
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • p11-kit
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-qtbase
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • strace
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • which
      • + +
    • devpkg-xorgproto
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • yasm
      • + +
    • devpkg-zlib
      • + +

    makemake build automation tool
    maker-cncCNC carving tools for Makers
    + +

    Includes bundle(s): +

      + +
    • inkscape
      • + +
    • python-extras
      • + +
    • python2-basic
      • + +
    +

    + +
    maker-gisGIS/Mapping tools for Makers
    + +

    Includes bundle(s): +

      + +
    • desktop-kde-libs
      • + +
    +

    + +
    meldmeld visual file difference and merging tool, targeted at developers
    mercurial SCM tool

    Includes bundle(s): - -

  • python3-basic
    • - +
      + +
    • python2-basic
      • + +
    • python3-basic
      • + +

    		Create Clear Linux releases

    Includes bundle(s): - -

  • containers-basic
    • - -
  • git
    • - -
  • openssl
    • - -
  • os-installer
    • - -
  • python3-basic
    • - -
  • sysadmin-basic
    • - -
  • zstd
    • - +
      + +
    • containers-basic
      • + +
    • git
      • + +
    • openssl
      • + +
    • os-installer
      • + +
    • python3-basic
      • + +
    • sysadmin-basic
      • + +
    • zstd
      • + +

    mkosimkosi generate disk images
    mtrmpg123 play and decode mp3 files
    mtd-utils memory (usually flash) device utilities exposing an interface between hardware drivers and upper system layers
    mtr Poll a remote server and see how the latency and performance changes over time
    ncdumusl musl compiler toolchain
    mutt The mutt mail client
    nasm assembler
    ncdu curses disk space usage management tool
    Run network utilities and modify network settings

    Includes bundle(s): - -

  • ethtool
    • - -
  • iproute2
    • - -
  • openssl
    • - -
  • perl-basic
    • - -
  • python3-basic
    • - -
  • wpa_supplicant
    • - +
      + +
    • ethtool
      • + +
    • iproute2
      • + +
    • openssl
      • + +
    • perl-basic
      • + +
    • python3-basic
      • + +
    • wpa_supplicant
      • + +
    • curl
      • + +
    • irssi
      • + +
    • weechat
      • + +
    • znc
      • + +

    		All packages required to build the network-basic bundle.

    Includes bundle(s): - -

  • dev-utils
    • - -
  • network-basic
    • - -
  • os-core-dev
    • - -
  • perl-basic-dev
    • - +
      + +
    • dev-utils
      • + +
    • network-basic
      • + +
    • os-core-dev
      • + +
    • perl-basic-dev
      • + +
    • devpkg-cairo
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • devpkg-glib
      • + +
    • gzip
      • + +
    • devpkg-icu4c
      • + +
    • intltool
      • + +
    • iproute2
      • + +
    • kbd
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libpng
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • make
      • + +
    • devpkg-nss
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • p11-kit
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • strace
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • which
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • devpkg-zlib
      • + +

    		Various tools to test and improve network security

    Includes bundle(s): - -

  • network-basic
    • - +
      + +
    • libX11client
      • + +
    • network-basic
      • + +
    • qt-basic
      • + +
    • nmap
      • + +
    • suricata
      • + +

    		Various tools and plugins to set up TSN/TCC

    Includes bundle(s): - -

  • network-basic
    • - +
      + +
    • network-basic
      • + +
    • alsa-utils
      • + +

    nfs-utilsnfs-utils Server and client tooling for network file systems (NFS)
    nginxnginx HTTP server, reverse proxy, IMAP/POP3 proxy server
    nload network load monitor
    nmap security scanner for network device discovery
    nodejs-basic Run javascript server side
    @@ -2134,26 +5564,42 @@
    octaveoctave high-level programming language, primarily intended for numerical computations
    openldap ldap tools
    openmpi HPC tools for running on jobs on clusters
    openqa OpenQA infrastructure

    Includes bundle(s): - -

  • kvm-host
    • - -
  • perl-basic
    • - -
  • postgresql
    • - -
  • web-server-basic
    • - +
      + +
    • kvm-host
      • + +
    • perl-extras
      • + +
    • postgresql
      • + +
    • web-server-basic
      • + +

    opensslopenssl Toolkit for Transport Layer Security (TLS) and Secure Sockets Layer (SSL) protocols
    Grouping bundle used by all openstack using bundles

    Includes bundle(s): - -

  • perl-basic
    • - -
  • python3-basic
    • - +
      + +
    • cloud-api
      • + +
    • perl-basic
      • + +
    • python3-basic
      • + +
    • keepalived
      • + +

    		Run any initialization processes required of a generic cloud guest VM

    Includes bundle(s): - -

  • ethtool
    • - -
  • openssh-server
    • - -
  • sudo
    • - +
      + +
    • ethtool
      • + +
    • openssh-server
      • + +
    • sudo
      • + +

    		Run any initialization processes required of an AWS cloud guest VM

    Includes bundle(s): - -

  • sudo
    • - +
      + +
    • sudo
      • + +

    		Run any initialization process requried of an Azure cloud guest VM

    Includes bundle(s): - -

  • ethtool
    • - -
  • openssh-server
    • - -
  • openssl
    • - -
  • python3-basic
    • - -
  • sudo
    • - +
      + +
    • ethtool
      • + +
    • openssh-server
      • + +
    • openssl
      • + +
    • python3-basic
      • + +
    • sudo
      • + +

    		Run any initialization processes required of an GCE cloud guest VM

    Includes bundle(s): - -

  • sudo
    • - -
  • which
    • - +
      + +
    • sudo
      • + +
    • which
      • + +

    		Run any initialization processes required of an Oracle Cloud guest

    Includes bundle(s): - -

  • openssh-server
    • - -
  • sudo
    • - +
      + +
    • openssh-server
      • + +
    • sudo
      • + +

    		Run any process required for Clear Linux development

    Includes bundle(s): - -

  • c-basic
    • - -
  • dev-utils
    • - -
  • dev-utils-dev
    • - -
  • editors
    • - -
  • go-basic
    • - -
  • koji
    • - -
  • kvm-host
    • - -
  • mail-utils
    • - -
  • mail-utils-dev
    • - -
  • mixer
    • - -
  • network-basic
    • - -
  • network-basic-dev
    • - -
  • openssh-server
    • - -
  • os-core
    • - -
  • os-core-dev
    • - -
  • os-core-update-dev
    • - -
  • package-builder
    • - -
  • perl-basic
    • - -
  • python3-basic
    • - -
  • storage-utils
    • - -
  • storage-utils-dev
    • - -
  • sysadmin-basic
    • - -
  • sysadmin-basic-dev
    • - +
      + +
    • c-basic
      • + +
    • dev-utils
      • + +
    • dev-utils-dev
      • + +
    • editors
      • + +
    • go-basic
      • + +
    • koji
      • + +
    • kvm-host
      • + +
    • mail-utils
      • + +
    • mail-utils-dev
      • + +
    • mixer
      • + +
    • network-basic
      • + +
    • network-basic-dev
      • + +
    • openssh-server
      • + +
    • os-core
      • + +
    • os-core-dev
      • + +
    • os-core-update-dev
      • + +
    • package-builder
      • + +
    • perl-basic
      • + +
    • python3-basic
      • + +
    • storage-utils
      • + +
    • storage-utils-dev
      • + +
    • sysadmin-basic
      • + +
    • sysadmin-basic-dev
      • + +
    • unbundle
      • + +
    • cabextract
      • + +
    • diffoscope
      • + +
    • devpkg-fribidi
      • + +
    • devpkg-gdk-pixbuf
      • + +
    • global
      • + +
    • devpkg-gtk3
      • + +
    • devpkg-libdrm
      • + +
    • devpkg-libxcb
      • + +
    • devpkg-libXdamage
      • + +
    • devpkg-libXfixes
      • + +
    • devpkg-libXxf86vm
      • + +
    • devpkg-mesa
      • + +
    • mkosi
      • + +
    • scons
      • + +
    • devpkg-xorgproto
      • + +

    		All packages required to build the os-clr-on-clr bundle.

    Includes bundle(s): - -

  • dev-utils
    • - -
  • dev-utils-dev
    • - -
  • editors-dev
    • - -
  • go-basic-dev
    • - -
  • kvm-host-dev
    • - -
  • mail-utils-dev
    • - -
  • network-basic-dev
    • - -
  • os-clr-on-clr
    • - -
  • os-core-dev
    • - -
  • perl-basic-dev
    • - -
  • storage-utils-dev
    • - -
  • sysadmin-basic-dev
    • - +
      + +
    • dev-utils
      • + +
    • dev-utils-dev
      • + +
    • editors-dev
      • + +
    • go-basic-dev
      • + +
    • kvm-host-dev
      • + +
    • mail-utils-dev
      • + +
    • network-basic-dev
      • + +
    • os-clr-on-clr
      • + +
    • os-core-dev
      • + +
    • perl-basic-dev
      • + +
    • storage-utils-dev
      • + +
    • sysadmin-basic-dev
      • + +
    • acpica-unix2
      • + +
    • devpkg-at-spi2-atk
      • + +
    • devpkg-at-spi2-core
      • + +
    • devpkg-atk
      • + +
    • bc
      • + +
    • devpkg-cairo
      • + +
    • ccache
      • + +
    • devpkg-clutter
      • + +
    • cpio
      • + +
    • curl
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • docutils
      • + +
    • dosfstools
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • file
      • + +
    • devpkg-fontconfig
      • + +
    • devpkg-freetype
      • + +
    • devpkg-fribidi
      • + +
    • gdb
      • + +
    • devpkg-gdk-pixbuf
      • + +
    • devpkg-glib
      • + +
    • gpgme
      • + +
    • devpkg-graphite
      • + +
    • devpkg-gst-plugins-base
      • + +
    • devpkg-gstreamer
      • + +
    • devpkg-gtk3
      • + +
    • gzip
      • + +
    • devpkg-harfbuzz
      • + +
    • devpkg-icu4c
      • + +
    • intltool
      • + +
    • iproute2
      • + +
    • kbd
      • + +
    • less
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libdrm
      • + +
    • devpkg-libepoxy
      • + +
    • devpkg-libical
      • + +
    • devpkg-libpciaccess
      • + +
    • devpkg-libpng
      • + +
    • devpkg-libpthread-stubs
      • + +
    • devpkg-libsecret
      • + +
    • devpkg-libsoup
      • + +
    • devpkg-libxkbcommon
      • + +
    • libxml2
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • llvm
      • + +
    • make
      • + +
    • devpkg-mesa
      • + +
    • nasm
      • + +
    • nfs-utils
      • + +
    • devpkg-nspr
      • + +
    • devpkg-nss
      • + +
    • devpkg-openmpi
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • devpkg-orc
      • + +
    • p11-kit
      • + +
    • devpkg-pango
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-pixman
      • + +
    • plzip
      • + +
    • devpkg-qtbase
      • + +
    • devpkg-qtdeclarative
      • + +
    • scons
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • strace
      • + +
    • subversion
      • + +
    • texinfo
      • + +
    • texlive
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • devpkg-wayland
      • + +
    • devpkg-wayland-protocols
      • + +
    • which
      • + +
    • devpkg-xorgproto
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • yasm
      • + +
    • zip
      • + +
    • devpkg-zlib
      • + +

    		All packages required to build the os-core bundle.

    Includes bundle(s): - -

  • dev-utils
    • - +
      + +
    • dev-utils
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • gdb
      • + +
    • devpkg-glib
      • + +
    • gzip
      • + +
    • intltool
      • + +
    • kbd
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • make
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • strace
      • + +
    • texinfo
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • which
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • devpkg-zlib
      • + +

    		Provides basic suite for running the Clear Linux for iA Updater

    Includes bundle(s): - -

  • os-core
    • - +
      + +
    • os-core
      • + +
    • os-core-webproxy
      • + +

    		All packages required to build the os-core-update bundle.

    Includes bundle(s): - -

  • dev-utils
    • - -
  • os-core-dev
    • - -
  • os-core-update
    • - +
      + +
    • dev-utils
      • + +
    • os-core-dev
      • + +
    • os-core-update
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • docutils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • gdb
      • + +
    • devpkg-glib
      • + +
    • gzip
      • + +
    • intltool
      • + +
    • kbd
      • + +
    • less
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • make
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • p11-kit
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • strace
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • which
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • devpkg-zlib
      • + +
    +

    + +
    os-core-webproxyProvides basic suite for using http proxies
    + +

    Includes bundle(s): +

      + +
    • os-core
      • + +

    		Run image creation and installation for Clear Linux

    Includes bundle(s): - -

  • iproute2
    • - -
  • python3-basic
    • - -
  • wpa_supplicant
    • - +
      + +
    • iproute2
      • + +
    • python3-basic
      • + +
    • wpa_supplicant
      • + +
    • curl
      • + +
    • kbd
      • + +
    • less
      • + +

    		Provides minimal functionality for core testing functions

    Includes bundle(s): - -

  • git
    • - -
  • openssh-server
    • - +
      + +
    • acl
      • + +
    • cpio
      • + +
    • curl
      • + +
    • diffutils
      • + +
    • file
      • + +
    • git
      • + +
    • make
      • + +
    • openssh-server
      • + +
    • perl-basic
      • + +
    • sudo
      • + +

    		Helpers for the 0day kernel testing framework

    Includes bundle(s): - -

  • c-basic
    • - -
  • dev-utils
    • - -
  • python3-basic
    • - -
  • perl-basic
    • - +
      + +
    • c-basic
      • + +
    • dev-utils
      • + +
    • python3-basic
      • + +
    • perl-basic
      • + +
    • acpica-unix2
      • + +
    • intltool
      • + +
    • llvm
      • + +
    +

    + +
    os-testsuite-automotiveProvides minimal functionality for automotive testing functions
    + +

    Includes bundle(s): +

      + +
    • os-testsuite
      • + +
    • os-testsuite-graphics
      • + +
    +

    + +
    os-testsuite-graphicsProvides minimal functionality for graphics testing functions
    + +

    Includes bundle(s): +

      + +
    • glmark2
      • + +

    		Run the Phoronix testsuite

    Includes bundle(s): - -

  • os-testsuite-phoronix-desktop
    • - -
  • os-testsuite-phoronix-server
    • - -
  • R-basic
    • - -
  • c-basic
    • - -
  • database-basic
    • - -
  • desktop-apps-extras
    • - -
  • desktop-autostart
    • - -
  • games
    • - -
  • git
    • - -
  • go-basic
    • - -
  • java-basic
    • - -
  • machine-learning-basic
    • - -
  • octave
    • - -
  • php-basic
    • - -
  • python3-basic
    • - -
  • qt-basic-dev
    • - +
      + +
    • os-testsuite-phoronix-desktop
      • + +
    • os-testsuite-phoronix-server
      • + +
    • R-basic
      • + +
    • c-basic
      • + +
    • database-basic
      • + +
    • desktop-apps-extras
      • + +
    • desktop-autostart
      • + +
    • games
      • + +
    • git
      • + +
    • go-basic
      • + +
    • java-basic
      • + +
    • machine-learning-basic
      • + +
    • octave
      • + +
    • php-basic
      • + +
    • python3-basic
      • + +
    • devpkg-qtbase
      • + +
    • bc
      • + +
    • devpkg-cairo
      • + +
    • fio
      • + +
    • gimp
      • + +
    • devpkg-libpng
      • + +
    • openmpi
      • + +
    • devpkg-openmpi
      • + +
    • nasm
      • + +
    • devpkg-openssl
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • redis-native
      • + +
    • scons
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • unzip
      • + +
    • yasm
      • + +
    • devpkg-zlib
      • + +
    • hwloc
      • + +

    		Run the Phoronix testsuite (desktop version)

    Includes bundle(s): - -

  • desktop version
    • - -
  • c-basic
    • - -
  • git
    • - -
  • desktop-autostart
    • - -
  • desktop-apps-extras
    • - -
  • php-basic
    • - -
  • games
    • - -
  • python3-basic
    • - -
  • python2-basic
    • - -
  • qt-basic-dev
    • - +
      + +
    • desktop version
      • + +
    • c-basic
      • + +
    • git
      • + +
    • desktop-autostart
      • + +
    • desktop-apps-extras
      • + +
    • php-basic
      • + +
    • games
      • + +
    • python3-basic
      • + +
    • python2-basic
      • + +
    • devpkg-qtbase
      • + +
    • nasm
      • + +
    • yasm
      • + +
    • bc
      • + +
    • devpkg-cairo
      • + +
    • fio
      • + +
    • gimp
      • + +
    • devpkg-libpng
      • + +
    • nasm
      • + +
    • devpkg-openssl
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • scons
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • unzip
      • + +
    • yasm
      • + +
    • devpkg-zlib
      • + +

    		Run the Phoronix testsuite (server version)

    Includes bundle(s): - -

  • server version
    • - -
  • c-basic
    • - -
  • database-basic
    • - -
  • git
    • - -
  • go-basic
    • - -
  • nodejs-basic
    • - -
  • octave
    • - -
  • php-basic
    • - -
  • python3-basic
    • - -
  • python2-basic
    • - +
      + +
    • server version
      • + +
    • c-basic
      • + +
    • database-basic
      • + +
    • git
      • + +
    • go-basic
      • + +
    • nodejs-basic
      • + +
    • octave
      • + +
    • php-basic
      • + +
    • python3-basic
      • + +
    • python2-basic
      • + +
    • rust-basic
      • + +
    • bc
      • + +
    • fio
      • + +
    • devpkg-libpng
      • + +
    • openmpi
      • + +
    • devpkg-openmpi
      • + +
    • nasm
      • + +
    • devpkg-openssl
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • redis-native
      • + +
    • scons
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • unzip
      • + +
    • yasm
      • + +
    • devpkg-zlib
      • + +

    		Provides a graphical desktop environment

    Includes bundle(s): - -

  • cryptography
    • - -
  • openssl
    • - -
  • python3-basic
    • - -
  • wpa_supplicant
    • - -
  • xfce4-desktop
    • - -
  • xemacs
    • - -
  • darktable
    • - -
  • thunderbird
    • - -
  • x11-server
    • - +
      + +
    • cryptography
      • + +
    • openssl
      • + +
    • perl-basic
      • + +
    • python3-basic
      • + +
    • wpa_supplicant
      • + +
    • xfce4-desktop
      • + +
    • xemacs
      • + +
    • darktable
      • + +
    • thunderbird
      • + +
    • x11-server
      • + +
    • alsa-utils
      • + +
    • darktable
      • + +
    • firefox
      • + +
    • thunderbird
      • + +
    • xemacs
      • + +

    		All packages required to build the os-utils-gui bundle.

    Includes bundle(s): - -

  • dev-utils
    • - -
  • os-core-dev
    • - -
  • os-utils-gui
    • - +
      + +
    • dev-utils
      • + +
    • os-core-dev
      • + +
    • os-utils-gui
      • + +
    • perl-basic-dev
      • + +
    • devpkg-at-spi2-atk
      • + +
    • devpkg-at-spi2-core
      • + +
    • devpkg-atk
      • + +
    • bc
      • + +
    • devpkg-cairo
      • + +
    • devpkg-clutter
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • docutils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • devpkg-fontconfig
      • + +
    • devpkg-freetype
      • + +
    • devpkg-fribidi
      • + +
    • gdb
      • + +
    • devpkg-gdk-pixbuf
      • + +
    • devpkg-glib
      • + +
    • devpkg-gnome-desktop
      • + +
    • gpgme
      • + +
    • devpkg-graphite
      • + +
    • devpkg-gsettings-desktop-schemas
      • + +
    • devpkg-gst-plugins-base
      • + +
    • devpkg-gstreamer
      • + +
    • devpkg-gtk3
      • + +
    • gzip
      • + +
    • devpkg-harfbuzz
      • + +
    • devpkg-icu4c
      • + +
    • intltool
      • + +
    • jq
      • + +
    • kbd
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libdrm
      • + +
    • devpkg-libepoxy
      • + +
    • devpkg-libpciaccess
      • + +
    • devpkg-libpng
      • + +
    • devpkg-libpthread-stubs
      • + +
    • devpkg-libsecret
      • + +
    • devpkg-libsoup
      • + +
    • devpkg-libxkbcommon
      • + +
    • libxml2
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • llvm
      • + +
    • make
      • + +
    • devpkg-mesa
      • + +
    • nasm
      • + +
    • nfs-utils
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • devpkg-orc
      • + +
    • p11-kit
      • + +
    • devpkg-pango
      • + +
    • parallel
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-pixman
      • + +
    • devpkg-qtbase
      • + +
    • scons
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • strace
      • + +
    • subversion
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • devpkg-wayland
      • + +
    • devpkg-wayland-protocols
      • + +
    • which
      • + +
    • devpkg-xorg-server
      • + +
    • devpkg-xorgproto
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • yasm
      • + +
    • devpkg-zlib
      • + +

    p11-kitp11-kit Load and enumerate PKCS#11 modules for cryptography
    Minimal bundle for building packages via Clearlinux common tooling

    Includes bundle(s): - -

  • curl
    • - -
  • diffutils
    • - -
  • git
    • - -
  • package-utils
    • - -
  • sudo
    • - +
      + +
    • curl
      • + +
    • diffutils
      • + +
    • git
      • + +
    • package-utils
      • + +
    • sudo
      • + +
    • make
      • + +
    • plzip
      • + +
    • zstd
      • + +

    		Utilities for creating, building, and managing packages

    Includes bundle(s): - -

  • python3-basic
    • - -
  • python2-basic
    • - +
      + +
    • python3-basic
      • + +
    • perl-basic
      • + +
    • python2-basic
      • + +

    parallelparallel shell tool for executing jobs in parallel using one or more computers
    patchpatch updates text files according to instructions contained in a separate file
    pdns PowerDNS authoritative name server (DNSSEC enabled)
    pdns-recursor PowerDNS recursive caching name server
    performance-tools Run performance and power measurements

    Includes bundle(s): - -

  • ethtool
    • - -
  • iproute2
    • - -
  • perl-basic
    • - -
  • python3-basic
    • - -
  • tcl-basic
    • - +
      + +
    • ethtool
      • + +
    • iproute2
      • + +
    • perl-basic
      • + +
    • python3-basic
      • + +
    • tcl-basic
      • + +
    • htop
      • + +
    • linux-tools
      • + +
    • powertop
      • + +
    • strace
      • + +
    • sysstat
      • + +

    		All packages required to build the perl-basic bundle.

    Includes bundle(s): - -

  • dev-utils
    • - -
  • os-core-dev
    • - -
  • perl-basic
    • - +
      + +
    • dev-utils
      • + +
    • os-core-dev
      • + +
    • perl-basic
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • devpkg-glib
      • + +
    • gzip
      • + +
    • intltool
      • + +
    • kbd
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • make
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • p11-kit
      • + +
    • patch
      • + +
    • strace
      • + +
    • texinfo
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • which
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • devpkg-zlib
      • + +

    		Improve user experience with a common set of prebuilt perl libraries

    Includes bundle(s): - -

  • perl-basic
    • - +
      + +
    • perl-basic
      • + +

    pidginMulti-protocol instant messagging client
    + +
    pmdk tools and libraries for working with non-volatile memory plzip Parallel LZMA Data Compressor
    pmdk Persistent Memory Development Kit tools and libraries for working with non-volatile memory
    postgresqlpostgresql Database
    powertoppowertop diagnose issues with power consumption and power management
    A set of console utilities for task management and communication

    Includes bundle(s): - -

  • mail-utils
    • - -
  • python3-basic
    • - +
      + +
    • mail-utils
      • + +
    • perl-basic
      • + +
    • python3-basic
      • + +
    • irssi
      • + +
    • weechat
      • + +

    pwgenpwgen generates passwords which are designed to be easily memorized by humans, while being as secure as possible.
    Run a PXE server

    Includes bundle(s): - -

  • python3-basic
    • - +
      + +
    • python3-basic
      • + +
    • nginx
      • + +

    		Run python language programs

    Includes bundle(s): - -

  • p11-kit
    • - -
  • python2-basic
    • - -
  • python3-basic
    • - +
      + +
    • p11-kit
      • + +
    • python2-basic
      • + +
    • python3-basic
      • + +

    		All packages required to build the python-basic bundle.

    Includes bundle(s): - -

  • dev-utils
    • - -
  • os-core-dev
    • - -
  • python-basic
    • - +
      + +
    • dev-utils
      • + +
    • os-core-dev
      • + +
    • python-basic
      • + +
    • devpkg-cairo
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • devpkg-fontconfig
      • + +
    • devpkg-freetype
      • + +
    • gdb
      • + +
    • devpkg-glib
      • + +
    • devpkg-graphite
      • + +
    • gzip
      • + +
    • devpkg-harfbuzz
      • + +
    • devpkg-icu4c
      • + +
    • intltool
      • + +
    • kbd
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libpng
      • + +
    • devpkg-libpthread-stubs
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • make
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • p11-kit
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • strace
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • which
      • + +
    • devpkg-xorgproto
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • devpkg-zlib
      • + +

    		The python data-science stack; the best of http://pydata.org

    Includes bundle(s): - -

  • c-basic
    • - -
  • python-extras
    • - +
      + +
    • c-basic
      • + +
    • cloud-api
      • + +
    • python-extras
      • + +

    		Improve user experience with a common set of prebuilt python libraries

    Includes bundle(s): - -

  • python3-basic
    • - -
  • cloud-api
    • - +
      + +
    • python3-basic
      • + +
    • cloud-api
      • + +

    		Run legacy python language programs

    Includes bundle(s): - -

  • p11-kit
    • - +
      + +
    • p11-kit
      • + +

    		Run python language programs

    Includes bundle(s): - -

  • p11-kit
    • - +
      + +
    • p11-kit
      • + +

    		qt-basic Run programs that use the QT runtime
    +

    Includes bundle(s): +

      + +
    • libX11client
      • + +
    +

    +
    All packages required to build the qt-basic bundle.

    Includes bundle(s): - -

  • dev-utils
    • - -
  • os-core-dev
    • - -
  • qt-basic
    • - +
      + +
    • dev-utils
      • + +
    • os-core-dev
      • + +
    • qt-basic
      • + +
    • devpkg-at-spi2-atk
      • + +
    • devpkg-at-spi2-core
      • + +
    • devpkg-atk
      • + +
    • devpkg-cairo
      • + +
    • devpkg-clutter
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • devpkg-fontconfig
      • + +
    • devpkg-freetype
      • + +
    • devpkg-fribidi
      • + +
    • gdb
      • + +
    • devpkg-gdk-pixbuf
      • + +
    • devpkg-glib
      • + +
    • devpkg-graphite
      • + +
    • devpkg-gst-plugins-base
      • + +
    • devpkg-gstreamer
      • + +
    • devpkg-gtk3
      • + +
    • gzip
      • + +
    • devpkg-harfbuzz
      • + +
    • devpkg-icu4c
      • + +
    • intltool
      • + +
    • kbd
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libdrm
      • + +
    • devpkg-libepoxy
      • + +
    • devpkg-libical
      • + +
    • devpkg-libpciaccess
      • + +
    • devpkg-libpng
      • + +
    • devpkg-libpthread-stubs
      • + +
    • devpkg-libsoup
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • llvm
      • + +
    • make
      • + +
    • devpkg-mesa
      • + +
    • nasm
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • devpkg-orc
      • + +
    • p11-kit
      • + +
    • devpkg-pango
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-pixman
      • + +
    • devpkg-qt3d
      • + +
    • devpkg-qtbase
      • + +
    • devpkg-qtdeclarative
      • + +
    • scons
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • strace
      • + +
    • subversion
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • devpkg-wayland
      • + +
    • devpkg-wayland-protocols
      • + +
    • which
      • + +
    • devpkg-xorgproto
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • yasm
      • + +
    • devpkg-zlib
      • + +

    quagga zebra and related routing tools
    quassel Quassel IRC

    Includes bundle(s): - -

  • libX11client
    • - -
  • qt-basic
    • - +
      + +
    • libX11client
      • + +
    • qt-basic
      • + +

    		Run R language programs

    Includes bundle(s): - -

  • libX11client
    • - -
  • plotting, help navigation, etc
    • - +
      + +
    • libX11client
      • + +
    • plotting, help navigation, etc
      • + +
    • less
      • + +

    		Large datasets for R

    Includes bundle(s): - -

  • R-basic
    • - +
      + +
    • R-basic
      • + +

    		Improve the user experience with a common set of prebuilt R libraries

    Includes bundle(s): - -

  • R-basic
    • - -
  • R-datasets
    • - +
      + +
    • R-basic
      • + +
    • R-datasets
      • + +

    redis-nativerebootmgr Performs scheduled or immediate system reboots after the kernel or critical OS components change.
    redis-native key-value database
    Run ruby language programs

    Includes bundle(s): - -

  • p11-kit
    • - +
      + +
    • p11-kit
      • + +

    		Build and run rust language programs

    Includes bundle(s): - -

  • git
    • - -
  • p11-kit
    • - +
      + +
    • git
      • + +
    • p11-kit
      • + +

    		Run a source code management server

    Includes bundle(s): - -

  • git
    • - -
  • python3-basic
    • - +
      + +
    • git
      • + +
    • openssh-server
      • + +
    • perl-basic
      • + +
    • python3-basic
      • + +
    • nginx
      • + +

    scons python build system
    service-os Provides the needed software for Service OS

    Includes bundle(s): - -

  • bootloader
    • - -
  • python3-basic
    • - +
      + +
    • bootloader
      • + +
    • python3-basic
      • + +
    • iasimage
      • + +

    		All packages required to build the service-os bundle.

    Includes bundle(s): - -

  • dev-utils
    • - -
  • os-core-dev
    • - -
  • service-os
    • - +
      + +
    • dev-utils
      • + +
    • os-core-dev
      • + +
    • service-os
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • devpkg-glib
      • + +
    • gzip
      • + +
    • devpkg-icu4c
      • + +
    • intltool
      • + +
    • kbd
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libpciaccess
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • make
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • p11-kit
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • strace
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • which
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • devpkg-zlib
      • + +

    		shells Run a shell
    +

    Includes bundle(s): +

      + +
    • zsh
      • + +
    +

    +
    smartmontools hard disk diagnostic utilities
    software-defined-cockpit Run the automotive software defined cockpit which has graphic, media, sound and connectivity

    Includes bundle(s): - -

  • wpa_supplicant
    • - +
      + +
    • libX11client
      • + +
    • wpa_supplicant
      • + +
    • alsa-utils
      • + +
    • v4l-utils
      • + +

    		All packages required to build the software-defined-cockpit bundle.

    Includes bundle(s): - -

  • dev-utils
    • - -
  • os-core-dev
    • - -
  • software-defined-cockpit
    • - +
      + +
    • dev-utils
      • + +
    • os-core-dev
      • + +
    • software-defined-cockpit
      • + +
    • devpkg-at-spi2-atk
      • + +
    • devpkg-at-spi2-core
      • + +
    • devpkg-atk
      • + +
    • devpkg-cairo
      • + +
    • devpkg-clutter
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • docutils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • devpkg-fontconfig
      • + +
    • devpkg-freetype
      • + +
    • devpkg-fribidi
      • + +
    • gdb
      • + +
    • devpkg-gdk-pixbuf
      • + +
    • devpkg-glib
      • + +
    • devpkg-graphite
      • + +
    • devpkg-gst-plugins-base
      • + +
    • devpkg-gstreamer
      • + +
    • devpkg-gtk3
      • + +
    • gzip
      • + +
    • devpkg-harfbuzz
      • + +
    • devpkg-icu4c
      • + +
    • intltool
      • + +
    • kbd
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libdrm
      • + +
    • devpkg-libepoxy
      • + +
    • devpkg-libpciaccess
      • + +
    • devpkg-libpng
      • + +
    • devpkg-libpthread-stubs
      • + +
    • devpkg-libsoup
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • llvm
      • + +
    • make
      • + +
    • devpkg-mesa
      • + +
    • nasm
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • devpkg-orc
      • + +
    • p11-kit
      • + +
    • devpkg-pango
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-pixman
      • + +
    • devpkg-qtbase
      • + +
    • devpkg-qtdeclarative
      • + +
    • scons
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • strace
      • + +
    • subversion
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • devpkg-wayland
      • + +
    • devpkg-wayland-protocols
      • + +
    • which
      • + +
    • devpkg-xorgproto
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • yasm
      • + +
    • devpkg-zlib
      • + +

    		Software to run or create test suites

    Includes bundle(s): - -

  • perl-basic
    • - -
  • python-basic
    • - +
      + +
    • perl-basic
      • + +
    • python-basic
      • + +

    squid HTTP caching proxy
    storage-cluster Run a storage server

    Includes bundle(s): - -

  • python3-basic
    • - -
  • python2-basic
    • - +
      + +
    • python2-basic
      • + +
    • python3-basic
      • + +
    • xfsprogs
      • + +

    		storage-utils Run disk and filesystem management functions
    +

    Includes bundle(s): +

      + +
    • smartmontools
      • + +
    • dosfstools
      • + +
    • nfs-utils
      • + +
    • pmdk
      • + +
    • smartmontools
      • + +
    • xfsprogs
      • + +
    +

    +
    All packages required to build the storage-utils bundle.

    Includes bundle(s): - -

  • dev-utils
    • - -
  • os-core-dev
    • - -
  • storage-utils
    • - +
      + +
    • dev-utils
      • + +
    • os-core-dev
      • + +
    • storage-utils
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • docutils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • gdb
      • + +
    • devpkg-glib
      • + +
    • gzip
      • + +
    • devpkg-icu4c
      • + +
    • intltool
      • + +
    • kbd
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libxkbcommon
      • + +
    • libxml2
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • llvm
      • + +
    • make
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • p11-kit
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-qtbase
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • strace
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • which
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • yasm
      • + +
    • devpkg-zlib
      • + +

    stracestrace System call diagnostic, instructional, and debugging tool
    subversionsubversion Version Control System
    sudosudo allows a user to run a program as another user
    suricatasuricata network threat detection engine
    Keyboard and mouse sharing across networks

    Includes bundle(s): - -

  • qt-basic
    • - -
  • postgresql
    • - +
      + +
    • qt-basic
      • + +
    • postgresql
      • + +

    		Run common utilities useful for managing a system

    Includes bundle(s): - -

  • iproute2
    • - -
  • p11-kit
    • - -
  • sudo
    • - -
  • which
    • - +
      + +
    • iproute2
      • + +
    • p11-kit
      • + +
    • perl-basic
      • + +
    • sudo
      • + +
    • which
      • + +
    • acpica-unix2
      • + +
    • diffutils
      • + +
    • file
      • + +
    • findutils
      • + +
    • gzip
      • + +
    • htop
      • + +
    • kbd
      • + +
    • kernel-install
      • + +
    • less
      • + +
    • parallel
      • + +
    • patch
      • + +
    • powertop
      • + +
    • strace
      • + +
    • tmux
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • xz
      • + +
    • zstd
      • + +

    		All packages required to build the sysadmin-basic bundle.

    Includes bundle(s): - -

  • dev-utils
    • - -
  • os-core-dev
    • - -
  • sysadmin-basic
    • - +
      + +
    • dev-utils
      • + +
    • os-core-dev
      • + +
    • perl-basic-dev
      • + +
    • sysadmin-basic
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • gdb
      • + +
    • devpkg-glib
      • + +
    • gzip
      • + +
    • devpkg-icu4c
      • + +
    • intltool
      • + +
    • kbd
      • + +
    • less
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libpng
      • + +
    • devpkg-libxkbcommon
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • make
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • p11-kit
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-qtbase
      • + +
    • strace
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • which
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • devpkg-zlib
      • + +

    		Utilities and Services for managing large-scale clusters of networked hosts

    Includes bundle(s): - -

  • git
    • - -
  • pxe-server
    • - -
  • python3-basic
    • - +
      + +
    • ansible
      • + +
    • git
      • + +
    • ipmitool
      • + +
    • pxe-server
      • + +
    • python3-basic
      • + +

    		Enable the host to be managed remotely by configuration management tools

    Includes bundle(s): - -

  • openssh-server
    • - -
  • python3-basic
    • - -
  • cockpit
    • - -
  • sudo
    • - +
      + +
    • openssh-server
      • + +
    • python3-basic
      • + +
    • cockpit
      • + +
    • sudo
      • + +

    sysstat utilities for monitoring system performance and usage activity
    systemd-cryptsetup Dummy bundle to avoid rolling back systemd, will be removed at next format bump
    @@ -3430,9 +8485,11 @@     		Run tk/tcl language programs

    Includes bundle(s): - -

  • libX11client
    • - +
      + +
    • libX11client
      • + +

    texlivetexinfo unix style documentation tooling
    texlive major TeX-related typesetting programs, macro packages, and fonts.
    thunderbirdthunderbird Email client
    tmuxtmux terminal multiplexer (similar to screen)
    tzdatatzdata timezone database
    unisonunbundle Recursively resolves a package list from a bundle definition
    unison bidirectional file synchronization tool
    unzipunzip list, test, or extract files from a ZIP archive
    Meta bundle capturing most console user work flows

    Includes bundle(s): - -

  • dev-utils
    • - -
  • editors
    • - -
  • kvm-host
    • - -
  • mail-utils
    • - -
  • network-basic
    • - -
  • openssh-server
    • - -
  • os-core-update
    • - -
  • shells
    • - -
  • storage-utils
    • - -
  • sysadmin-basic
    • - +
      + +
    • dev-utils
      • + +
    • editors
      • + +
    • kvm-host
      • + +
    • mail-utils
      • + +
    • network-basic
      • + +
    • openssh-server
      • + +
    • os-core-update
      • + +
    • shells
      • + +
    • storage-utils
      • + +
    • sysadmin-basic
      • + +

    		All packages required to build the user-basic bundle.

    Includes bundle(s): - -

  • dev-utils
    • - -
  • dev-utils-dev
    • - -
  • editors-dev
    • - -
  • kvm-host-dev
    • - -
  • mail-utils-dev
    • - -
  • network-basic-dev
    • - -
  • os-core-dev
    • - -
  • os-core-update-dev
    • - -
  • storage-utils-dev
    • - -
  • sysadmin-basic-dev
    • - -
  • user-basic
    • - +
      + +
    • dev-utils
      • + +
    • dev-utils-dev
      • + +
    • editors-dev
      • + +
    • kvm-host-dev
      • + +
    • mail-utils-dev
      • + +
    • network-basic-dev
      • + +
    • os-core-dev
      • + +
    • os-core-update-dev
      • + +
    • storage-utils-dev
      • + +
    • sysadmin-basic-dev
      • + +
    • user-basic
      • + +
    • acpica-unix2
      • + +
    • devpkg-at-spi2-atk
      • + +
    • devpkg-at-spi2-core
      • + +
    • devpkg-atk
      • + +
    • bc
      • + +
    • devpkg-cairo
      • + +
    • cpio
      • + +
    • devpkg-dbus
      • + +
    • diffutils
      • + +
    • docbook-utils
      • + +
    • docutils
      • + +
    • dosfstools
      • + +
    • doxygen
      • + +
    • devpkg-elfutils
      • + +
    • devpkg-expat
      • + +
    • devpkg-fontconfig
      • + +
    • devpkg-freetype
      • + +
    • devpkg-fribidi
      • + +
    • gdb
      • + +
    • devpkg-gdk-pixbuf
      • + +
    • devpkg-glib
      • + +
    • gpgme
      • + +
    • devpkg-graphite
      • + +
    • devpkg-gtk3
      • + +
    • gzip
      • + +
    • devpkg-harfbuzz
      • + +
    • devpkg-icu4c
      • + +
    • intltool
      • + +
    • iproute2
      • + +
    • kbd
      • + +
    • less
      • + +
    • devpkg-libX11
      • + +
    • devpkg-libdrm
      • + +
    • devpkg-libepoxy
      • + +
    • devpkg-libpciaccess
      • + +
    • devpkg-libpng
      • + +
    • devpkg-libpthread-stubs
      • + +
    • devpkg-libsoup
      • + +
    • devpkg-libxkbcommon
      • + +
    • libxml2
      • + +
    • devpkg-libxml2
      • + +
    • libxslt
      • + +
    • llvm
      • + +
    • make
      • + +
    • devpkg-mesa
      • + +
    • nasm
      • + +
    • nfs-utils
      • + +
    • devpkg-nspr
      • + +
    • devpkg-nss
      • + +
    • devpkg-openmpi
      • + +
    • openssl
      • + +
    • devpkg-openssl
      • + +
    • devpkg-orc
      • + +
    • p11-kit
      • + +
    • devpkg-pango
      • + +
    • patch
      • + +
    • devpkg-pcre
      • + +
    • devpkg-pixman
      • + +
    • devpkg-qtbase
      • + +
    • scons
      • + +
    • devpkg-sqlite-autoconf
      • + +
    • strace
      • + +
    • subversion
      • + +
    • texinfo
      • + +
    • tzdata
      • + +
    • unzip
      • + +
    • devpkg-util-linux
      • + +
    • valgrind
      • + +
    • devpkg-wayland
      • + +
    • devpkg-wayland-protocols
      • + +
    • which
      • + +
    • devpkg-xorgproto
      • + +
    • xz
      • + +
    • devpkg-xz
      • + +
    • yasm
      • + +
    • devpkg-zlib
      • + +

    valgrindv4l-utils video4linux tools
    valgrind suite of tools for debugging and profiling software code
    The popular vim text editor

    Includes bundle(s): - -

  • python3-basic
    • - -
  • perl-basic
    • - +
      + +
    • python3-basic
      • + +
    • perl-basic
      • + +

    		Virtualization Management tool

    Includes bundle(s): - -

  • desktop-gnomelibs
    • - -
  • libX11client
    • - +
      + +
    • desktop-gnomelibs
      • + +
    • libX11client
      • + +
    +

    + +
    virt-manager-guiEnable controlling virt-manager through a GUI
    + +

    Includes bundle(s): +

      + +
    • libX11client
      • + +
    • virt-manager
      • + +

    vlcvlc VideoLAN Client, multimedia player and framework
    Enable the host to be a vnc desktop server

    Includes bundle(s): - -

  • desktop
    • - -
  • openssh-server
    • - +
      + +
    • desktop
      • + +
    • openssh-server
      • + +

    		web-server-basic Run a HTTP web server
    +

    Includes bundle(s): +

      + +
    • httpd
      • + +
    • nginx
      • + +
    +

    +
    weechatweechat Internet Relay Chat (IRC) client
    weston-extrasweston-extras Utilities and tools for the Wayland graphics compositor
    whichwhich locate executables in the system
    Network packet capture and analysis

    Includes bundle(s): - -

  • postgresql
    • - -
  • qt-basic
    • - +
      + +
    • postgresql
      • + +
    • qt-basic
      • + +

    wpa_supplicantwpa_supplicant backend component controlling the wireless connections
    Provide a functional X11 Server (Xorg or wayland-based)

    Includes bundle(s): - -

  • Xorg or wayland-based
    • - -
  • libX11client
    • - +
      + +
    • Xorg or wayland-based
      • + +
    • libX11client
      • + +

    		Tools useful when running under X11

    Includes bundle(s): - -

  • libX11client
    • - +
      + +
    • libX11client
      • + +
    • perl-basic
      • + +
    • xterm
      • + +

    xemacsxemacs text editor and application development system
    Run GUI desktop environment

    Includes bundle(s): - -

  • libX11client
    • - -
  • which
    • - +
      + +
    • libX11client
      • + +
    • which
      • + +

    xzxfsprogs XFS tools
    xterm The basic X.Org terminal program desktop launcher
    xz data compression/decompression tool
    zshyasm assembler
    zip create ZIP archives
    znc IRC network bouncer
    zsh Z Shell, an interactive shell and powerful command-line interpreter for scripting language
    zstdzstd realtime data compression/decompression tool
    + + + + + + + + + + + + + + + + + {% for d in data %} + {% if d.url %} + + + + + {% else %} + + + + + {% endif %} + {% endfor %} + +
    + Updated: {{ now.strftime('%x %H:%M') }} UTC +
    Name Description
    {{d.title}}{{d.data_desc}}
    + {% if d.include_list %} +

    Includes bundle(s): + {% for include in d.include_list %} +

  • {{include}}
    • + {% endfor %} +

    + {% endif %} +
    {{d.title}} {{d.pun_desc}}
    + + + \ No newline at end of file