From b6bb1b2421bf10e96f83ee67605b675a8f02e977 Mon Sep 17 00:00:00 2001 From: Geoffroy Desvernay Date: Fri, 29 Nov 2024 18:18:03 +0100 Subject: [PATCH] add github pages --- docs/.buildinfo | 4 + docs/_sources/advanced-use.rst.txt | 312 + docs/_sources/basic-use.rst.txt | 327 + docs/_sources/best-practices.rst.txt | 67 + docs/_sources/debian.rst.txt | 75 + docs/_sources/faq.rst.txt | 66 + docs/_sources/fastentrypoints.rst.txt | 7 + docs/_sources/index.rst.txt | 54 + docs/_sources/install.rst.txt | 201 + docs/_sources/iocage_cli.rst.txt | 246 + docs/_sources/iocage_lib.rst.txt | 158 + docs/_sources/jailtypes.rst.txt | 105 + docs/_sources/known-issues.rst.txt | 97 + docs/_sources/modules.rst.txt | 11 + docs/_sources/networking.rst.txt | 254 + docs/_sources/plugins.rst.txt | 126 + docs/_sources/setup.rst.txt | 7 + docs/_sources/templates.rst.txt | 91 + docs/_sources/tests.rst.txt | 30 + .../_sphinx_javascript_frameworks_compat.js | 134 + docs/_static/agogo.css | 549 + docs/_static/ajax-loader.gif | Bin 0 -> 673 bytes docs/_static/basic.css | 900 ++ docs/_static/bgfooter.png | Bin 0 -> 276 bytes docs/_static/bgtop.png | Bin 0 -> 266 bytes docs/_static/comment-bright.png | Bin 0 -> 756 bytes docs/_static/comment-close.png | Bin 0 -> 829 bytes docs/_static/comment.png | Bin 0 -> 641 bytes docs/_static/doctools.js | 156 + docs/_static/documentation_options.js | 14 + docs/_static/down-pressed.png | Bin 0 -> 222 bytes docs/_static/down.png | Bin 0 -> 202 bytes docs/_static/file.png | Bin 0 -> 286 bytes docs/_static/jquery-3.6.0.js | 10881 ++++++++++++++++ docs/_static/jquery.js | 2 + docs/_static/language_data.js | 199 + docs/_static/minus.png | Bin 0 -> 90 bytes docs/_static/plus.png | Bin 0 -> 90 bytes docs/_static/pygments.css | 75 + docs/_static/searchtools.js | 566 + docs/_static/sphinx_highlight.js | 144 + docs/_static/underscore-1.13.1.js | 2042 +++ docs/_static/underscore-1.3.1.js | 999 ++ docs/_static/underscore.js | 6 + docs/_static/up-pressed.png | Bin 0 -> 214 bytes docs/_static/up.png | Bin 0 -> 203 bytes docs/_static/websupport.js | 808 ++ docs/advanced-use.html | 321 + docs/basic-use.html | 351 + docs/best-practices.html | 174 + docs/debian.html | 167 + docs/faq.html | 160 + docs/fastentrypoints.html | 127 + docs/genindex.html | 1357 ++ docs/index.html | 202 + docs/install.html | 279 + docs/iocage_cli.html | 305 + docs/iocage_lib.html | 1634 +++ docs/jailtypes.html | 186 + docs/known-issues.html | 185 + docs/modules.html | 513 + docs/networking.html | 283 + docs/objects.inv | Bin 0 -> 3852 bytes docs/plugins.html | 209 + docs/py-modindex.html | 373 + docs/search.html | 137 + docs/searchindex.js | 1 + docs/setup.html | 106 + docs/templates.html | 186 + docs/tests.html | 118 + 70 files changed, 27087 insertions(+) create mode 100644 docs/.buildinfo create mode 100644 docs/_sources/advanced-use.rst.txt create mode 100644 docs/_sources/basic-use.rst.txt create mode 100644 docs/_sources/best-practices.rst.txt create mode 100644 docs/_sources/debian.rst.txt create mode 100644 docs/_sources/faq.rst.txt create mode 100644 docs/_sources/fastentrypoints.rst.txt create mode 100644 docs/_sources/index.rst.txt create mode 100644 docs/_sources/install.rst.txt create mode 100644 docs/_sources/iocage_cli.rst.txt create mode 100644 docs/_sources/iocage_lib.rst.txt create mode 100644 docs/_sources/jailtypes.rst.txt create mode 100644 docs/_sources/known-issues.rst.txt create mode 100644 docs/_sources/modules.rst.txt create mode 100644 docs/_sources/networking.rst.txt create mode 100644 docs/_sources/plugins.rst.txt create mode 100644 docs/_sources/setup.rst.txt create mode 100644 docs/_sources/templates.rst.txt create mode 100644 docs/_sources/tests.rst.txt create mode 100644 docs/_static/_sphinx_javascript_frameworks_compat.js create mode 100644 docs/_static/agogo.css create mode 100644 docs/_static/ajax-loader.gif create mode 100644 docs/_static/basic.css create mode 100644 docs/_static/bgfooter.png create mode 100644 docs/_static/bgtop.png create mode 100644 docs/_static/comment-bright.png create mode 100644 docs/_static/comment-close.png create mode 100644 docs/_static/comment.png create mode 100644 docs/_static/doctools.js create mode 100644 docs/_static/documentation_options.js create mode 100644 docs/_static/down-pressed.png create mode 100644 docs/_static/down.png create mode 100644 docs/_static/file.png create mode 100644 docs/_static/jquery-3.6.0.js create mode 100644 docs/_static/jquery.js create mode 100644 docs/_static/language_data.js create mode 100644 docs/_static/minus.png create mode 100644 docs/_static/plus.png create mode 100644 docs/_static/pygments.css create mode 100644 docs/_static/searchtools.js create mode 100644 docs/_static/sphinx_highlight.js create mode 100644 docs/_static/underscore-1.13.1.js create mode 100644 docs/_static/underscore-1.3.1.js create mode 100644 docs/_static/underscore.js create mode 100644 docs/_static/up-pressed.png create mode 100644 docs/_static/up.png create mode 100644 docs/_static/websupport.js create mode 100644 docs/advanced-use.html create mode 100644 docs/basic-use.html create mode 100644 docs/best-practices.html create mode 100644 docs/debian.html create mode 100644 docs/faq.html create mode 100644 docs/fastentrypoints.html create mode 100644 docs/genindex.html create mode 100644 docs/index.html create mode 100644 docs/install.html create mode 100644 docs/iocage_cli.html create mode 100644 docs/iocage_lib.html create mode 100644 docs/jailtypes.html create mode 100644 docs/known-issues.html create mode 100644 docs/modules.html create mode 100644 docs/networking.html create mode 100644 docs/objects.inv create mode 100644 docs/plugins.html create mode 100644 docs/py-modindex.html create mode 100644 docs/search.html create mode 100644 docs/searchindex.js create mode 100644 docs/setup.html create mode 100644 docs/templates.html create mode 100644 docs/tests.html diff --git a/docs/.buildinfo b/docs/.buildinfo new file mode 100644 index 00000000..c98ac922 --- /dev/null +++ b/docs/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 4d64116757cc2e7149e797a8158b2fd9 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_sources/advanced-use.rst.txt b/docs/_sources/advanced-use.rst.txt new file mode 100644 index 00000000..c71c8427 --- /dev/null +++ b/docs/_sources/advanced-use.rst.txt @@ -0,0 +1,312 @@ +.. index:: Advance Usage +.. _Advanced Usage: + +Advanced Usage +============== + +.. index:: Clones +.. _Clones: + +Clones +------ + +When a jail is cloned, iocage creates a ZFS clone filesystem. +Essentially, clones are cheap, lightweight, and writable snapshots. + +A clone depends on its source snapshot and filesystem. To destroy the +source jail and preserve its clones, the clone must be promoted first. + +.. index:: Create clones +.. _Create a Clone: + +Create a Clone +++++++++++++++ + +To clone **www01** to **www02**, run: + +:samp:`# iocage clone www01 --name www02` + +Clone a jail from an existing snapshot with: + +:samp:`# iocage clone www01@snapshotname --name www03` + +.. index:: Promote a Clone +.. _Promoting a Clone: + +Promoting a Clone ++++++++++++++++++ + +.. warning:: This functionality isn't fully added to iocage, and may not + function as expected. + +**To promote a cloned jail, run:** + +:command:`iocage promote [UUID | NAME]` + +This reverses the *clone* and *source* jail relationship. The clone +becomes the source and the source jail is demoted to a clone. + +**The demoted jail can now be removed:** + +:command:`iocage destroy [UUID | NAME]` + +.. index:: Updating Jails +.. _Updating Jails: + +Updating Jails +-------------- + +Updates are handled with the freebsd-update(8) utility. Jails can be +updated while they are stopped or running. + +.. note:: The command :command:`iocage update [UUID | NAME]` + automatically creates a backup snapshot of the jail given. + +To create a backup snapshot manually, run: + +:command:`iocage snapshot -n [snapshotname] [UUID | NAME]` + +To update a jail to latest patch level, run: + +:command:`iocage update [UUID | NAME]` + +When updates are finished and the jail appears to function properly, +remove the snapshot: + +:command:`iocage snapremove [UUID|NAME]@[snapshotname]` + +To test updating without affecting a jail, create a clone and update the +clone the same way as outlined above. + +To clone a jail, run: + +:command:`iocage clone [UUID|NAME] --name [testupdate]` + +.. note:: The **[-n | --name]** flag is optional. :command:`iocage` + assigns an UUID to the jail if **[-n | --name]** is not used. + +.. index:: Upgrade Jails +.. _Upgrading Jails: + +Upgrading Jails +--------------- + +Upgrades are handled with the freebsd-update(8) utility. By default, the +user must supply the new RELEASE for the jail's upgrade. For example: + +:samp:`# iocage upgrade examplejail -r 11.0-RELEASE` + +Tells jail *examplejail* to upgrade its RELEASE to *11.0-RELEASE*. + +.. note:: It is recommended to keep the iocage host and jails RELEASE + synchronized. + +To upgrade a jail to the host's RELEASE, run: + +:command:`iocage upgrade -r [11.1-RELEASE] [UUID | NAME]` + +This upgrades the jail to the same RELEASE as the host. This method also +applies to basejails. + +.. index:: Auto-Boot +.. _AutoBoot: + +Auto-boot +--------- + +Make sure :command:`iocage_enable="YES"` is set in :file:`/etc/rc.conf`. + +To enable a jail to auto-boot during a system boot, simply run: + +:samp:`# iocage set boot=on UUID|NAME` + +.. note:: Setting :command:`boot=on` during jail creation starts the + jail after the jail is created. + +.. index:: Boot Priority +.. _Boot Priority: + +Boot Priority ++++++++++++++ + +Boot order can be specified by setting the priority value: + +:command:`iocage set priority=[20] [UUID|NAME]` + +*Lower* values are higher in the boot priority. + +.. index:: Depends Property +.. _Depends Property: + +Depends Property +++++++++++++++++ + +Use the :literal:`depends` property to require other jails to start +before this one. It is space delimited. Jails listed as dependents +also wait to start if those jails have listed :literal:`depends`. + +Example: :command:`iocage set depends=“foo bar” baz` + +.. index:: Snapshot Management +.. _Snapshot Management: + +Snapshot Management +------------------- + +iocage supports transparent ZFS snapshot management out of the box. +Snapshots are point-in-time copies of data, a safety point to which a +jail can be reverted at any time. Initially, snapshots take up almost no +space, as only changing data is recorded. + +You may use **ALL** as a target jail name for these commands if you want to target all jails at once. + +List snapshots for a jail: + +:command:`iocage snaplist [UUID|NAME]` + +Create a new snapshot: + +:command:`iocage snapshot [UUID|NAME]` + +This creates a snapshot based on the current time. + +:command:`iocage snapshot [UUID|NAME] -n [SNAPSHOT NAME]` + +This creates a snapshot with the given name. + +Delete a snapshot: + +:command:`iocage snapremove [UUID|NAME] -n [SNAPSHOT NAME]` + +Delete all snapshots from a jail (requires `-f / --force`): + +:command:`iocage snapremove [UUID|NAME] -n ALL -f` + +.. index:: Resource Limits +.. _Resource Limits: + +Resource Limits (Legacy ONLY) +----------------------------- + +.. warning:: This functionality is only available for legacy versions of + :command:`iocage`. It is not yet implemented in the current version. + This applies to all subsections of *Resource Limits*. + +:command:`iocage` can enable optional resource limits for a jail. The +outlined procedure here is meant to provide a starting point for the +user. + +.. index:: Limit Cores or Threads +.. _Limit Cores or Threads: + +Limit Cores or Threads +++++++++++++++++++++++ + +Limit a jail to a single thread or core #1: + +:command:`iocage set cpuset=1 [UUID|TAG]` +:command:`iocage start [UUID|TAG]` + +.. index:: List Applied Rules +.. _List Applied Rules: + +List Applied Limits ++++++++++++++++++++ + +List applied limits: + +:command:`iocage limits [UUID|TAG]` + +.. index:: Limit DRAM Usage +.. _Limit DRAM Usage: + +Limit DRAM use +++++++++++++++ + +This example limits a jail to using 4 Gb DRAM memory (limiting RSS +memory use can be done on-the-fly): + +:samp:`# iocage set memoryuse=4G:deny examplejail` + +.. index:: Turn on Resource Limits +.. _Turn on Resource Limits: + +Turn on Resource Limits ++++++++++++++++++++++++ + +Turn on resource limiting for a jail with: + +:command:`iocage set rlimits=on [UUID|TAG]` + +.. index:: Apply Limits +.. _Apply Limits: + +Apply limits +++++++++++++ + +Apply limits to a running jail with: + +:command:`iocage cap [UUID | TAG]` + +.. index:: Check Limits +.. _Check Limits: + +Check Limits +++++++++++++ + +Check the currently active limits on a jail with: + +:command:`iocage limits [UUID | TAG]` + +.. index:: Limit CPU Usage by Percentage +.. _Limit CPU Usage by Percentage: + +Limit CPU Usage by % +++++++++++++++++++++ + +In this example, :command:`iocage` limits *testjail* CPU execution to +20%, then applies the limitation to the active jail: + +:samp:`# iocage set pcpu=20:deny testjail` +:samp:`# iocage cap testjail` + +Double check the jail's current limits to confirm the functionality: + +:samp:`# iocage limits testjail` + +.. index:: Automatic Package Installation +.. _Automatic Package Installation: + +Automatic Package Installation +------------------------------ + +Packages can be installed automatically at creation time! + +Use the [-p | --pkglist] option at creation time, which needs to point +to a JSON file containing one package name per line. + +.. note:: An Internet connection is required for automatic package + installations, as :command:`pkg install` obtains packages from online + repositories. + +Create a :file:`pkgs.json` file and add package names to it. + +:file:`pkgs.json`: + +.. code-block:: json + + { + "pkgs": [ + "nginx", + "tmux" + ] + } + +Now, create a jail and supply :file:`pkgs.json`: + +:command:`iocage create -r [RELEASE] -p [path-to/pkgs.json] -n [NAME]` + +.. note:: The **[-n | --name]** flag is optional. :command:`iocage` + assigns an UUID to the jail if **[-n | --name]** is not used. + +This installs **nginx** and **tmux** in the newly created jail. diff --git a/docs/_sources/basic-use.rst.txt b/docs/_sources/basic-use.rst.txt new file mode 100644 index 00000000..ef42d0d4 --- /dev/null +++ b/docs/_sources/basic-use.rst.txt @@ -0,0 +1,327 @@ +.. index:: Basic Usage +.. _Basic Usage: + +Basic Usage +=========== + +This section is about basic iocage usage and is meant as a "how-to" +reference for new users. + +.. tip:: Remember, command line help is always available by typing + :command:`iocage --help` or :command:`iocage [subcommand] --help`. + +iocage has a basic "flow" when first used. As a new user interacts with +iocage for the first time, this flow guides them through initializing +iocage, then interacting with newly created jails. + +.. tip:: iocage has an experimental "color" mode enabled by setting the + environment variable :command:`IOCAGE_COLOR` to **TRUE**. + +.. index:: Setting environment variables +.. _Setting environment variables: + +Setting Environment Variables +----------------------------- + +iocage currently has four environment variables: + +.. table:: **iocage Environment Variables** + :class: longtable + + +------------------+-----------------+----------------------------------------------------+ + | Name | Accepted Values | Description | + +------------------+-----------------+----------------------------------------------------+ + | IOCAGE_LOGFILE | FILE | File location to have iocage log into. | + +------------------+-----------------+----------------------------------------------------+ + | IOCAGE_COLOR | TRUE|FALSE | Turns on a colored CLI output. | + +------------------+-----------------+----------------------------------------------------+ + | IOCAGE_FORCE | TRUE|FALSE | Required for any automatic migrations | + +------------------+-----------------+----------------------------------------------------+ + | IOCAGE_PLUGIN_IP | IP_ADDR | This environment variable is set in a plugin jail. | + | | | Use it to quickly query it with another | + | | | program/script | + +------------------+-----------------+----------------------------------------------------+ + +The process for setting these variables depends on the shell being used. +The default FreeBSD shell :command:`csh/tcsh` and the :command:`bash/sh` +shell are different from one another and require a slightly different +process for setting environment variables. For example: + +In the FreeBSD shell :command:`csh/tcsh` , :samp:`setenv IOCAGE_COLOR TRUE` +sets the environment variable IOCAGE_COLOR to true. + +In the :command:`bash/sh` shell, :samp:`export IOCAGE_COLOR=TRUE` sets +the environment variable IOCAGE_COLOR to true. + +.. index:: Activate iocage +.. _Activate iocage: + +Activate iocage +--------------- + +Before iocage is functional, it needs to :command:`activate`. +Essentially, iocage needs to link with a usable zpool. In most cases, +activation is automatic to the primary system zpool, but more advanced +users can use :command:`iocage activate` to designate a different zpool +for iocage usage. + +Once iocage is ready with an active zpool, users are able to immediately +begin downloading FreeBSD releases for jail creation. + +.. index:: Fetch a release +.. _Fetch a Release: + +Fetch a Release +--------------- + +:command:`iocage` now needs to fetch a RELEASE, which is used to create +jails. By default, typing :command:`iocage fetch` opens a menu for the +user to choose which release to download, as seen in this example: + +.. code-block:: none + + # iocage fetch + [0] 9.3-RELEASE (EOL) + [1] 10.1-RELEASE (EOL) + [2] 10.2-RELEASE (EOL) + [3] 10.3-RELEASE + [4] 11.0-RELEASE + + Type the number of the desired RELEASE + Press [Enter] to fetch the default selection: (11.0-RELEASE) + Type EXIT to quit: 4 + +Once the desired RELEASE is downloaded, the most recent patches are also +applied to it. + +:command:`iocage fetch` also has a number of options and properties for +users to fine-tune the functionality of the command. + +To fetch the latest RELEASE, + +:samp:`iocage fetch -r LATEST` + +If a specific RELEASE is required, use the **-r** option: + +:command:`iocage fetch -r [11.0-RELEASE]` + + +If a specific download mirror is required, use the **-s** option: + +:command:`iocage fetch -s [ftp.hostname.org]` + +:command:`fetch` can also pull from a specific ftp directory, using the +**-d** option: + +:command:`iocage fetch -d [dir/]` + +.. index:: Basic Jail Creation +.. _Create a Jail: + +Create a Jail +------------- + +With a release downloaded, iocage is now able to create jails. There are +two types of jails: **normal** and **base**. More details about these +jail types can be found in the :ref:`Jail Types` section of this +documentation. + +Depending on the user's requirements, the :command:`create` subcommand +can be adjusted to create either jail type. By default, +:command:`iocage create` creates a **normal** jail, but invoking the +**-b** option changes the creation to the basejail type. iocage is able +to create a jail with the latest release by adding *LATEST* to the +create command. + +Here is an example of creating a normal jail from the latest available +release: + +:samp:`# iocage create -r LATEST -n [JAIL]` + +This creates a normal jail that is a clone of the latest release. + +Here is an example of creating a normal jail from the *11.0-RELEASE*: + +:samp:`# iocage create -r 11.0-RELEASE` + +This normal jail is a clone of the specified RELEASE. + +To create multiple jails, use the **-c** option: + +:samp:`# iocage create -r 11.0-RELEASE -c 2` + +This example shows the numeric value after the **-c** flag is used to +designate the number of jails to create. In the above example, two jails +are created. + +A simple basejail is created with the **-b** option: + +:command:`iocage create -b -r [RELEASE]` + +After designating the type and number of jails to create with the option +flags, specific jail **properties** can also be set. For example: + +:samp:`# iocage create -r 11.0-RELEASE --name myjail boot=on` + +Creates a FreeBSD 11.0-RELEASE jail with the custom name *myjail* and +sets the jail to start at system boot time. + +More information about jail properties is available in the iocage(8) +FreeBSD manual page, accessible on a FreeBSD system by +typing :command:`man iocage`. + +.. index:: Listing Jails +.. _Listing Jails: + +Listing Jails +------------- + +To list all jails, use :command:`iocage list` + +To see all downloaded RELEASEs, use :command:`iocage list -r` + +View available templates with :command:`iocage list -t` + +.. index:: Jail start stop restart +.. _Start Stop Restart Jail: + +Start, Stop, or Restart a Jail +------------------------------ + +Jails can be started, stopped, or restarted at any time. By default, new +jails are in a *down* (stopped) state. To see the status of all jails, +use :command:`iocage list` and read the **STATE** column. + +Use each jail's UUID or custom NAME to start, stop, or restart it. +Partial entries are acceptable, as long as the given characters are +enough to identify the desired jail. Alternately, use **ALL** to apply +the command to all created jails. + +.. tip:: Partial entries can also be supplied for any other + :command:`iocage` operation or subcommand. + +.. index:: Jail Start +.. _Startjail: + +Start ++++++ + +Use :command:`iocage start` to start jails. + +**Examples:** + +Start a jail with the custom name **www01**: + +:samp:`iocage start www01`. + +If no custom NAME or UUID is provided by the user, :command:`iocage` +automatically assigns a complex UUID to a new jail. This UUID is always +usable when doing :command:`iocage` operations like starting a jail: + +:samp:`# iocage start 26e8e027-f00c-11e4-8f7f-3c970e80eb61` + +Partial entries are also acceptable: + +:samp:`# iocaget start www` + +:samp:`# iocage start 26e8` + +.. index:: Jail Stop +.. _Stopjail: + +Stop +++++ + +:command:`iocage stop` uses the same syntax as :command:`iocage start`. + +**Examples:** + +:samp:`# iocage stop www01` + +:samp:`# iocage stop 26e8e027-f00c-11e4-8f7f-3c970e80eb61` + +:samp:`# iocage stop 26e8` + +.. index:: Jail Restart +.. _Restartjail: + +Restart ++++++++ + +:command:`iocage restart` also uses the same syntax as **start** and +**stop**: + +:samp:`# iocage restart www01` + +:samp:`# iocage restart 26e8e027-f00c-11e4-8f7f-3c970e80eb61` + +:samp:`# iocage restart 26e8` + +.. index:: Configure a Jail +.. _Configure a Jail: + +Configure a Jail +---------------- + +Configuring the properties of an already created jail is best done with +the **set** and **get** subcommands. Be sure to provide the NAME or UUID +of the desired jail when using these subcommands. + +.. index:: Set Property +.. _Set Jail Property: + +Set Jail Property ++++++++++++++++++ + +:command:`iocage` uses the **set** subcommand to configure jail +properties. + +To assign a custom note to a jail with the **notes** property: + +:samp:`# iocage set notes="This is a test jail." 26e8e027` + +The full list of jail properties is available in the iocage(8) manual +page PROPERTIES section. + +.. index:: Get Property +.. _Get Jail Property: + +Get Jail Property ++++++++++++++++++ + +To view a specific jail property, use the **get** subcommand: + +:samp:`# iocage get notes 26e8e027` + +Get all properties: ++++++++++++++++++++ + +Display the full list of a jail's properties: + +:samp:`# iocage get all 26e8e027 | more` + +.. index:: Destroy a Jail +.. _Destroy a Jail: + +Destroy a Jail +-------------- + +Destroy a specific jail using the **destroy** subcommand: + +:samp:`# iocage destroy www02` + +.. warning:: This irreversibly destroys the jail! + +.. index:: Rename Jail +.. _Rename Jail: + +Rename a Jail +------------- + +:command:`iocage` allows jails to be renamed after creation and/or +migration. The :command:`iocage rename` subcommand is used to alter an +existing jail's UUID or NAME. Type the command, then the UUID or name of +the jail to be altered, then the desired name. This example shows using +the :command:`rename` subcommand: + +:samp:`# iocage rename jail1 TESTINGJAIL` diff --git a/docs/_sources/best-practices.rst.txt b/docs/_sources/best-practices.rst.txt new file mode 100644 index 00000000..db6b7c6a --- /dev/null +++ b/docs/_sources/best-practices.rst.txt @@ -0,0 +1,67 @@ +.. index:: Best Practices +.. _Best Practices: + +Best Practices +-------------- + +This section provides some generic guidelines and tips for working with +:command:`iocage` managed jails. + +**Use PF as a module** + + This is the default setting in the *GENERIC* kernel. There seems to be + a VNET bug which is only triggered when PF is directly compiled into + the kernel. + +**Always name jails and templates!** + + Use the -n option with :command:`iocage create` to set a name for the + jail. This helps avoid mistakes and easily identify jails. + + Example: :samp:`iocage create -r 11.0-RELEASE -n testjail` + +**Set the notes property** + + Set the **notes** property to something meaningful, especially for + templates and jails used infrequently. + + Example: + + .. code-block:: none + + [root@tester ~]# iocage set notes="This is a test jail." testjail + Property: notes has been updated to This is a test jail. + + [root@tester ~]# iocage get notes testjail + This is a test jail. + +**VNET** + + *VNET* provides more fine control and isolation for jails. VNET also + allows jails to run their own firewalls. See :ref:`Known Issues` for + more about VNET. + +**Discover templates!** + + Templates simplify using jail creation and customization, give it a + try! See :ref:`Using Templates` to get started. + +**Use** :command:`iocage restart` **instead of start/stop** + + Always restart a jail with the :command:`iocage restart -s` command. + This performs a soft restart and leaves the *VNET* stack alone, which + is less stressful for both kernel and user. + +**Check the firewall rules** + + When using *IPFW* inside a *VNET* jail, put **firewall_enable="YES"** + and **firewall_type="open"** into :file:`/etc/rc.conf`. This excludes + the firewall from accidentally blocking the user right from the + beginning! Re-lock it once finished testing. It is also recommended to + check the *PF* firewall rules on the host if jail and host rules are + mixed. + +**Delete old snapshots** + + Remove unnecessary snapshots, especially from jails where data is + constantly changing! diff --git a/docs/_sources/debian.rst.txt b/docs/_sources/debian.rst.txt new file mode 100644 index 00000000..38343a30 --- /dev/null +++ b/docs/_sources/debian.rst.txt @@ -0,0 +1,75 @@ +.. index:: Create Debian Jail +.. _Create a Debian Jail: + +Create a Debian Buster Jail (native Linux) +=========================================== + +This section shows the process to set up a Debian Linux jail. +The examples in this section use a jail with the custom name +**debjail**. Remember to replace **debjail** with your jail's UUID or +NAME! + +.. warning:: This is not recommended for production use. The intention + is to show :command:`iocage` can do almost anything with jails. + +**Create an empty jail:** + +.. code-block:: none + + # iocage create -e -n debjail exec_start="/bin/true" exec_stop="/bin/true" + allow_mount_linprocfs=1 allow_mount_devfs=1 allow_raw_sockets=1 + allow_socket_af=1 allow_mount_linsysfs=1 allow_mount=1 + +**Install devfs rules for vnet:** + +In `/etc/devfs.rules`: + +.. code-block:: none + + [devfsrules_jail_linux=6] add include $devfsrules_hide_all + add include $devfsrules_unhide_basic + add include $devfsrules_unhide_login + add path 'tun*' unhide + add path 'bpf*' unhide + add path zfs unhide + +**Install debootstrap on the host:** + +:samp:`# pkg install debootstrap` + +**Enable linux(4):** + +:samp:`# sysrc linux_enable="YES"` +:samp:`# sysrc linux_mounts_enable="NO"` +:samp:`# service linux start` + +**Grab the mountpoint for the empty jail, append /root/ to it, and run** +**debootstrap(8):** + +:samp:`# iocage get mountpoint debjail` + +:samp:`# debootstrap bookworm /iocage/jails/debjail/root/` + +Apart from Debian releases, like *buster* or *testing*, you can +also use Ubuntu releases, eg *bionic*. + +**Add lines to the jail** :file:`fstab` **file:** + +Use :command:`iocage fstab -e [UUID | NAME]` to edit the :file:`fstab` +file of *debjail* directly. Add these lines to the file: + +.. code-block:: none + + devfs /iocage/jails/debjail/root/dev devfs rw 0 0 + tmpfs /iocage/jails/debjail/root/dev/shm tmpfs rw,size=1g,mode=1777 0 0 + fdescfs /iocage/jails/debjail/root/dev/fd fdescfs rw,linrdlnk 0 0 + linproc /iocage/jails/debjail/root/proc linprocfs rw 0 0 + linsys /iocage/jails/debjail/root/sys linsysfs rw 0 0 + +**Start the jail and attach to it:** + +:samp:`# iocage start debjail` + +:samp:`# iocage console debjail` + +The result is a 64-bit Debian Linux userland. diff --git a/docs/_sources/faq.rst.txt b/docs/_sources/faq.rst.txt new file mode 100644 index 00000000..4907efc4 --- /dev/null +++ b/docs/_sources/faq.rst.txt @@ -0,0 +1,66 @@ +.. index:: FAQ +.. _FAQ: + +FAQ +=== + +**What is iocage?** + :command:`iocage` is a jail management program designed to simplify + jail administration tasks. + +**What is a jail?** + A *Jail* is a FreeBSD **OS virtualization** technology allowing + users to run multiple copies of the operating system. Some operating + systems use the term **Zones** or **Containers** for OS + virtualization. + +**What is VNET?** + VNET is an independent, per jail virtual networking stack. + +**How do I configure network interfaces in a VNET or shared IPjail?** + Both are configured in the same way: + :command:`iocage set ip4_add="[interface]|[IP]/[netmask]" [UUID | NAME]`. + For more info, please refer to the :ref:`Networking` section of this + documentation. + +**Do I need to set my default gateway?** + Only if VNET is enabled. You need to assign an IP address to the + **bridge** where the jail interface is attached. This IP essentially + becomes the default gateway for your jail. + +**Can I run a firewall inside a jail?** + Yes, a VNET jail supports **IPFW**. *PF* is not supported inside the + jail. However, you can still enable *PF* for the host. If you plan + to use **IPFW** inside a jail, be sure **securelevel** is set to + **2**. + +**Can I enable both IPFW and PF at the same time?** + Yes, make sure you allow traffic on both in/out for your jails. + +**Can I create custom jail templates?** + Yes, and thin provisioning is supported too! + +**What is a jail clone?** + **Clones** are ZFS clones. These are fully writable copies of the + source jail. + +**Can I limit the CPU and Memory use?** + Yes, but **only** for legacy versions of :command:`iocage`. Refer to + the :file:`iocage.8` manual page or :ref:`Resource Limits` section + of this documentation for more details. + +**Is there a way to display resource consumption?** + Yes - :command:`iocage df` + +**Is NAT supported for jails?** + Yes. NAT is built into FreeBSD. Treat your server as a core + router/firewall. Check the FreeBSD + `Firewalls chapter `_ + for more details. + +**Will iocage work on a generic system with no ZFS pools?** + No. ZFS is a must. If you run a FreeBSD server, you should be using + ZFS! + +**Is ZFS jailing supported?** + Yes, please refer to the :file:`iocage.8` manual page. diff --git a/docs/_sources/fastentrypoints.rst.txt b/docs/_sources/fastentrypoints.rst.txt new file mode 100644 index 00000000..0bd8c9d1 --- /dev/null +++ b/docs/_sources/fastentrypoints.rst.txt @@ -0,0 +1,7 @@ +fastentrypoints module +====================== + +.. automodule:: fastentrypoints + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt new file mode 100644 index 00000000..e63e20f3 --- /dev/null +++ b/docs/_sources/index.rst.txt @@ -0,0 +1,54 @@ +.. iocage documentation master file, created by + sphinx-quickstart on Wed Jul 9 10:19:09 2014. + You can adapt this file completely to your liking, but it should at + least contain the root `toctree` directive. + +=============================== +iocage - A FreeBSD Jail Manager +=============================== + +iocage is a jail/container manager written in Python, combining +some of the best features and technologies the FreeBSD operating system +has to offer. It is geared for ease of use with a simplistic and easy to +learn command syntax. + +**FEATURES:** + +- Templates, basejails, and normal jails +- Easy to use +- Rapid thin provisioning within seconds +- Automatic package installation +- Virtual networking stacks (vnet) +- Shared IP based jails (non vnet) +- Dedicated ZFS datasets inside jails +- Transparent ZFS snapshot management +- Binary updates +- Export and import +- And many more! + +Documentation: +-------------- + +.. toctree:: + :maxdepth: 2 + + install + basic-use + plugins + networking + jailtypes + best-practices + advanced-use + templates + debian + known-issues + faq + +.. Missing File: automatic-package-installation + +Indices and tables +================== + + * :ref:`genindex` + * :ref:`modindex` + * :ref:`search` diff --git a/docs/_sources/install.rst.txt b/docs/_sources/install.rst.txt new file mode 100644 index 00000000..bc6465a7 --- /dev/null +++ b/docs/_sources/install.rst.txt @@ -0,0 +1,201 @@ +.. index:: Install iocage +.. _Install iocage: + +Install iocage +============== + +iocage is a jail and container manager merging some of the best features +and technologies from the FreeBSD operating system. It is geared for +ease of use with simple command syntax. Visit the +`iocage github `_ for more information. + +Using binary packages ++++++++++++++++++++++ + +To install using binary packages on a FreeBSD system, run: + +:samp:`sudo pkg install py38-iocage` + +Using github +++++++++++++ + +If installing from github, the FreeBSD source tree **must** be located +at :samp:`$SRC_BASE` ( :samp:`/usr/src` by default). + +To install from github, run these commands: + +:samp:`pkg install python38 git-lite py38-cython py38-libzfs py38-pip` + +:samp:`git clone https://github.com/iocage/iocage` + +:samp:`make install` as root. + +.. tip:: To install subsequent updates run: :samp:`make install` as + root. + +Using pkg(8) +++++++++++++ + +It is possible to install pre-build packages using pkg(8) if using +FreeBSD 10 or above. + +To install using pkg(8), run: + +:samp:`sudo pkg install py38-iocage` + +Building Ports +++++++++++++++ + +iocage is in the FreeBSD ports tree as sysutils/py-iocage. + +Build the ports: +:samp:`cd /usr/ports/sysutils/iocage/ ; make install clean` + +Upgrading from :samp:`iocage_legacy` +++++++++++++++++++++++++++++++++++++ + +This repository replaces :samp:`iocage_legacy` . +To upgrade to the current version: + +1. Stop the jails ( :samp:`Service iocage stop; iocage stop ALL`) +#. Back up your data. +#. Remove the old :samp:`iocage` package if it is installed + ( :samp:`pkg delete iocage`) +#. Install :samp:`iocage` using one of the methods above. +#. Migrate the jails by running :samp:`iocage list` as root. +#. Start the jails ( :samp:`service iocage onestart`). + +.. index:: Ezjail Migration +.. _Ezjail Migration: + +Migrating from Ezjail to Iocage ++++++++++++++++++++++++++++++++ + +**Assumptions**: + +- ezjail jails are located at ``/usr/jails`` +- iocage jails are located at ``/iocage/jails`` + +Create Target +------------- + +Create an empty jail in iocage to act as the target for the migration. +The release and networking information will be updated with information +from ezjail. + +:: + + iocage create -e -n NewJail + +Copy Old Data +------------- + +Before data can be copied, another symlink must be created in the root +directory. Ezjail relies on symlinks to utlilize the basejail system, +however when looking in an existing jail, it’s symlinked to the root. + +:: + + % ls -ls /usr/jails/OldJail/bin + 1 lrwxr-xr-x 1 root wheel 13 Feb 22 2017 /usr/jails/OldJail/bin@ -> /basejail/bin + +This would work fine from within a running jail, but on the host +filesystem this link doesn’t currently exist. Because of this, create a +symlink from the basejail to the root filesystem of the jail host. + +:: + + ln -s /usr/jails/basejail /basejail + +Now that the link exists, copy the data from the ezjail jail directory +to the iocage jail directory. + +:: + + rsync -a --copy-links /usr/jails/OldJail/ /iocage/jails/NewJail/root/ + +Populate iocage config.json +--------------------------- + +There are 2 main parts from ezjail that need to be copied into the +iocage config: + +- release information +- IP address + +Release +~~~~~~~ + +The release info can be found in the old basejail files via the +``freebsd-update`` executable. + +:: + + $ grep USERLAND_VERSION= /usr/jails/basejail/bin/freebsd-version + USERLAND_VERSION="11.1-RELEASE-p6" + +This value goes into the “release” line of ``config.json`` + +:: + + "release": "11.1-RELEASE-p6", + +IP Address +~~~~~~~~~~ + +The IP addresses used in an ezjail jail are found in +``/usr/local/etc/ezjail/OldJail`` + +:: + + $ grep ip= /usr/local/etc/ezjail/OldJail + export jail_OldJail_ip="em0|192.168.1.10" + +This goes into the “ip4_addr” line of ``config.json`` + +:: + + "ip4_addr": "em0|192.168.1.10/24", + +Remember to append the subnet mask when adding network info to the +iocage config. + +Start the New Jail +~~~~~~~~~~~~~~~~~~ + +Make sure the old jail is shut down so there won’t be any IP conflicts. + +:: + + ezjail-admin stop OldJail + +Start the new jail with iocage + +:: + + iocage start NewJail + +(Optional) Update fstab +~~~~~~~~~~~~~~~~~~~~~~~ + +If there are other mounts in use in ezjail, these can be easily copied +into iocage as well. + +Ezjail fstab entries are located at ``/etc/fstab.OldJail`` on the host. + +:: + + $ cat /etc/fstab.OldJail + /usr/jails/basejail /usr/jails/OldJail/basejail nullfs ro 0 0 + /path/on/host /usr/jails/OldJail/path/in/jail nullfs rw 0 0 + +The basejail line isn’t needed in iocage if using the default jail type, +but the remaining entries need to be updated. + +Edit the fstab for the iocage jail and change the paths of the +mountpoint. + +:: + + $ cat /iocage/jails/NewJail/fstab + /path/on/host /iocage/jails/NewJail/root/path/in/jail nullfs rw 0 0 diff --git a/docs/_sources/iocage_cli.rst.txt b/docs/_sources/iocage_cli.rst.txt new file mode 100644 index 00000000..68227a67 --- /dev/null +++ b/docs/_sources/iocage_cli.rst.txt @@ -0,0 +1,246 @@ +iocage\_cli package +=================== + +Submodules +---------- + +iocage\_cli.activate module +--------------------------- + +.. automodule:: iocage_cli.activate + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.chroot module +------------------------- + +.. automodule:: iocage_cli.chroot + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.clean module +------------------------ + +.. automodule:: iocage_cli.clean + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.clone module +------------------------ + +.. automodule:: iocage_cli.clone + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.console module +-------------------------- + +.. automodule:: iocage_cli.console + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.create module +------------------------- + +.. automodule:: iocage_cli.create + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.debug module +------------------------ + +.. automodule:: iocage_cli.debug + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.destroy module +-------------------------- + +.. automodule:: iocage_cli.destroy + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.df module +--------------------- + +.. automodule:: iocage_cli.df + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.exec module +----------------------- + +.. automodule:: iocage_cli.exec + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.export module +------------------------- + +.. automodule:: iocage_cli.export + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.fetch module +------------------------ + +.. automodule:: iocage_cli.fetch + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.fstab module +------------------------ + +.. automodule:: iocage_cli.fstab + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.get module +---------------------- + +.. automodule:: iocage_cli.get + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.import module +------------------------- + +.. automodule:: iocage_cli.import + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.list module +----------------------- + +.. automodule:: iocage_cli.list + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.migrate module +-------------------------- + +.. automodule:: iocage_cli.migrate + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.pkg module +---------------------- + +.. automodule:: iocage_cli.pkg + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.rename module +------------------------- + +.. automodule:: iocage_cli.rename + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.restart module +-------------------------- + +.. automodule:: iocage_cli.restart + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.rollback module +--------------------------- + +.. automodule:: iocage_cli.rollback + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.set module +---------------------- + +.. automodule:: iocage_cli.set + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.snaplist module +--------------------------- + +.. automodule:: iocage_cli.snaplist + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.snapremove module +----------------------------- + +.. automodule:: iocage_cli.snapremove + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.snapshot module +--------------------------- + +.. automodule:: iocage_cli.snapshot + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.start module +------------------------ + +.. automodule:: iocage_cli.start + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.stop module +----------------------- + +.. automodule:: iocage_cli.stop + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.update module +------------------------- + +.. automodule:: iocage_cli.update + :members: + :undoc-members: + :show-inheritance: + +iocage\_cli.upgrade module +-------------------------- + +.. automodule:: iocage_cli.upgrade + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: iocage_cli + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/_sources/iocage_lib.rst.txt b/docs/_sources/iocage_lib.rst.txt new file mode 100644 index 00000000..0150535c --- /dev/null +++ b/docs/_sources/iocage_lib.rst.txt @@ -0,0 +1,158 @@ +iocage\_lib package +=================== + +Submodules +---------- + +iocage\_lib.ioc\_check module +----------------------------- + +.. automodule:: iocage_lib.ioc_check + :members: + :undoc-members: + :show-inheritance: + +iocage\_lib.ioc\_clean module +----------------------------- + +.. automodule:: iocage_lib.ioc_clean + :members: + :undoc-members: + :show-inheritance: + +iocage\_lib.ioc\_common module +------------------------------ + +.. automodule:: iocage_lib.ioc_common + :members: + :undoc-members: + :show-inheritance: + +iocage\_lib.ioc\_create module +------------------------------ + +.. automodule:: iocage_lib.ioc_create + :members: + :undoc-members: + :show-inheritance: + +iocage\_lib.ioc\_debug module +----------------------------- + +.. automodule:: iocage_lib.ioc_debug + :members: + :undoc-members: + :show-inheritance: + +iocage\_lib.ioc\_destroy module +------------------------------- + +.. automodule:: iocage_lib.ioc_destroy + :members: + :undoc-members: + :show-inheritance: + +iocage\_lib.ioc\_exceptions module +---------------------------------- + +.. automodule:: iocage_lib.ioc_exceptions + :members: + :undoc-members: + :show-inheritance: + +iocage\_lib.ioc\_exec module +---------------------------- + +.. automodule:: iocage_lib.ioc_exec + :members: + :undoc-members: + :show-inheritance: + +iocage\_lib.ioc\_fetch module +----------------------------- + +.. automodule:: iocage_lib.ioc_fetch + :members: + :undoc-members: + :show-inheritance: + +iocage\_lib.ioc\_fstab module +----------------------------- + +.. automodule:: iocage_lib.ioc_fstab + :members: + :undoc-members: + :show-inheritance: + +iocage\_lib.ioc\_image module +----------------------------- + +.. automodule:: iocage_lib.ioc_image + :members: + :undoc-members: + :show-inheritance: + +iocage\_lib.ioc\_json module +---------------------------- + +.. automodule:: iocage_lib.ioc_json + :members: + :undoc-members: + :show-inheritance: + +iocage\_lib.ioc\_list module +---------------------------- + +.. automodule:: iocage_lib.ioc_list + :members: + :undoc-members: + :show-inheritance: + +iocage\_lib.ioc\_plugin module +------------------------------ + +.. automodule:: iocage_lib.ioc_plugin + :members: + :undoc-members: + :show-inheritance: + +iocage\_lib.ioc\_start module +----------------------------- + +.. automodule:: iocage_lib.ioc_start + :members: + :undoc-members: + :show-inheritance: + +iocage\_lib.ioc\_stop module +---------------------------- + +.. automodule:: iocage_lib.ioc_stop + :members: + :undoc-members: + :show-inheritance: + +iocage\_lib.ioc\_upgrade module +------------------------------- + +.. automodule:: iocage_lib.ioc_upgrade + :members: + :undoc-members: + :show-inheritance: + +iocage\_lib.iocage module +------------------------- + +.. automodule:: iocage_lib.iocage + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: iocage_lib + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/_sources/jailtypes.rst.txt b/docs/_sources/jailtypes.rst.txt new file mode 100644 index 00000000..f57dbcfd --- /dev/null +++ b/docs/_sources/jailtypes.rst.txt @@ -0,0 +1,105 @@ +.. index:: Jail Types +.. _Jail Types: + +Jail Types +========== + +iocage supports several different jail types: + +* Clone (default) +* Basejail +* Template +* Empty +* Thickjail + +All jail types have specific benefits and drawbacks, serving a variety +of unique needs. This section describes and has creation examples for +each of these jail types. + +.. index:: Clone Jails +.. _Clone: + +Clone (default) +--------------- + +Clone jails are created with: + +:samp:`# iocage create -r 11.0-RELEASE` + +Clone jails are duplicated from the appropriate RELEASE at creation +time. These consume a small amount of space, preserving only the +changing data. + +.. index:: Basejails +.. _Basejail: + +Basejail +-------- + +The original basejail concept was based on nullfs mounts. It was +popularized by `ezjail `_, +but :command:`iocage` basejails are a little different. Basejails in +:command:`iocage` are mounts in a jail **fstab** that are mounted at +jail startup. + +Create a basejail by typing: + +:command:`iocage create -r [RELEASE] -b` + +Basejails mount their **fstab** mounts at each startup. They are ideal +for environments where immediate patching or upgrading of multiple +jails is required. + +.. index:: Template Jails +.. _Template: + +Template +-------- + +Template jails are customized jails used to quickly create further +custom jails. + +For example, after creating a jail, the user customizes +that jail's networking properties. Once satisfied, the user then changes +the jail into a template with: + +:samp:`# iocage set template=yes examplejail` + +After this operation the jail is found in the *templates* list: + +:samp:`# iocage list -t` + +And new jails with the user customized networking can be created: + +:samp:`# iocage create -t examplejail -n newexamplejail` + +Template jails are convertable by setting the *template=* +property. + +.. index:: Empty Jails +.. _Empty: + +Empty +----- + +Empty jails are intended for unsupported jail setups or testing. Create +an empty jail with :command:`iocage create -e`. + +These are ideal for experimentation with unsupported RELEASES or Linux +jails. + +.. index:: Thickjail +.. _Thick: + +Thickjail +--------- + +Thickjails jails are created with: + +:samp:`# iocage create -T -r 11.2-RELEASE` + +Thickjails are copied from the appropriate RELEASE at creation +time. These consume a large amount of space, but are fully independent. + +These are ideal for transmission or synchronization between different +hosts with :command:`zfs send` and :command:`zfs receive`. diff --git a/docs/_sources/known-issues.rst.txt b/docs/_sources/known-issues.rst.txt new file mode 100644 index 00000000..26a99e12 --- /dev/null +++ b/docs/_sources/known-issues.rst.txt @@ -0,0 +1,97 @@ +.. index:: Known Issues +.. _Known Issues: + +Known Issues +============ + +This section provides a short list of known issues. + +.. index:: Known Issues, Mount Path Limit +.. _Mount Path Limit: + +Mount Path Limit +---------------- + +There is a known mountpoint path length limitation issue on FreeBSD. +Path length has an historical 88 character limit. + +This issue does not affect :command:`iocage` jails from functioning +properly, but can present challenges when diving into ZFS snapshots, +like :command:`cd` into :file:`.zfs/snapshots`, :command:`tar`, etc. + +ZFS snapshot creation and rollback is not affected. + +To work around this issue, :command:`iocage` allows the user to +assign and use a unique *NAME* for the jail. Alternately, using the +**[-s | --short]** flag at jail creation tells :command:`iocage` to +assign a shortened UUID to the jail. + +.. index:: Known Issues, VNET/VIMAGE +.. _VNETVIMAGE: + +VNET/VIMAGE Issues +------------------ + +VNET/VIMAGE can cause unexpected system crashes when VNET enabled jails +are destroyed. In other words, when the jail process is killed, removed, +or stopped. + +As a workaround, :command:`iocage` allows a soft restart without +destroying the jail. :command:`iocage restart -s [UUID | NAME]` executes +a soft restart of the jail. + +Example: + +:samp:`# iocage restart -s examplejail` + +FreeBSD 10.1-RELEASE is stable enough to run with VNET and soft +restarts. There are production machines with :command:`iocage` and VNET +jails running well over 100 days of uptime running both PF and IPFW. + +.. index:: Known Issues, VNET and ALTQ +.. _VNETVIMAGE and ALTQ: + +VNET/VIMAGE issues w/ ALTQ +++++++++++++++++++++++++++ + +As recent as FreeBSD 10.1-RELEASE-p10, there are some *interesting* +interactions between VNET/VIMAGE and the ALTernate Queueing (ALTQ) +system used by PF and other routing software. When compiling a kernel, +be sure these lines are **not** in the :file:`kernconf` file (unless +disabling VNET): + +.. code-block:: none + + options ALTQ + options ALTQ_CBQ + options ALTQ_RED + options ALTQ_RIO + options ALTQ_HFSC + options ALTQ_CDNR + options ALTQ_PRIQ + +Otherwise, when starting a jail with VNET support enabled, the host +system is likely to crash. Read a more about this issue from a +`2014 mailing list post `_. + +.. index:: Known Issues, IPv6 Host Bind Failure +.. _IPv6 Host Bind Failures: + +IPv6 host bind failures +----------------------- + +In some cases, a jail with an *ip6* address may take too long adding the +address to the interface. Services defined to bind specifically to the +address may then fail. If this happens, add this to :file:`sysctl.conf` +to disable DAD (duplicate address detection) probe packets: + +.. code-block:: none + + # disable duplicated address detection probe packets for jails + net.inet6.ip6.dad_count=0 + +Adding these lines permanently disables DAD. To set this for ONLY the +current system boot, type :command:`sysctl net.inet6.ip6.dad_count=0` in +a command line interface (CLI). More information about this issue is +available from a +`2013 mailing list post `_. diff --git a/docs/_sources/modules.rst.txt b/docs/_sources/modules.rst.txt new file mode 100644 index 00000000..32c264d1 --- /dev/null +++ b/docs/_sources/modules.rst.txt @@ -0,0 +1,11 @@ +iocage +====== + +.. toctree:: + :maxdepth: 4 + + fastentrypoints + iocage_cli + iocage_lib + setup + tests diff --git a/docs/_sources/networking.rst.txt b/docs/_sources/networking.rst.txt new file mode 100644 index 00000000..09744438 --- /dev/null +++ b/docs/_sources/networking.rst.txt @@ -0,0 +1,254 @@ +.. index:: Networking +.. _Networking: + +Networking +========== + +Jails have multiple networking options to better serve a user's needs. +Traditionally, jails have only supported IP alias based networking. This +is where an IP address is assigned to the host's interface and then used +by the jail for network communication. This is typically known as +"shared IP" based jails. + +Another recently developed option is called VNET or sometimes VIMAGE. +VNET is a fully virtualized networking stack which is isolated per jail. +VNET abstracts virtual network interfaces to jails, which then behave in +the same way as physical interfaces. + +By default, iocage does not enable VNET, but users can enable and +configure VNET for a jail by configuring that jail's properties using +the instructions in the :ref:`Configure a Jail` section of this +documentation. + +The rest of this section shows more depth of the **Shared IP** and +**VNET** networking options, along with instructions for +:ref:`Configuring Network Interfaces`. + +.. warning:: In the examples in this section, **em0** is used as the + network adapter. **em0** is a placeholder and must be replaced with + the user's specific network adapter. A network adapter is a computer + hardware component that connects a computer to a computer network. + In order to find the network adapter on the system run + :samp:`ifconfig`. + +.. index:: Shared IP +.. _Shared IP: + +Shared IP +--------- + +The *Shared IP* networking option is rock solid, with over a decade of +heavy use and testing. + +It has no specific system requirements, as everything needed is built +directly into the default GENERIC kernel. + +.. index:: Using Shared IP +.. _Using Shared IP: + +Using Shared IP ++++++++++++++++ + +There are a few steps to follow when setting up *Shared IP*: + +**Check the VNET property status** + +:samp:`# iocage get vnet examplejail1` + +If **vnet** is on, disable it: + +:samp:`# iocage set vnet=off examplejail1` + +**Configure an IP address** + +:samp:`# iocage set ip4_addr="em0|10.1.1.10/24" examplejail1` + +If multiple addresses are desired, separate the configuration directives +with a :kbd:`,`: + +:samp:`# iocage set ip4_addr="em0|10.1.1.10/24,em0|10.1.1.11/24" examplejail1` + +**Start the jail** + +:samp:`iocage start examplejail1` + +**Verify visible IP configuration in the jail** + +:samp:`# iocage exec examplejail1 ifconfig` + +.. index:: VIMAGE_VNET +.. _VIMAGEVNET: + +VIMAGE/VNET +----------- + +VNET is considered experimental. Unexpected system crashes +can occur. More details about issues with VNET are available in the +:ref:`Known Issues` section of this documentation. + +There are a number of required steps when configuring a jail to use +VNET: + +**Kernel** + +.. tip:: If not required, disable SCTP. + +Rebuild the kernel with these options: + +.. code-block:: none + + nooptions SCTP # Stream Control Transmission Protocol + options VIMAGE # VNET/Vimage support + options RACCT # Resource containers + options RCTL # same as above + +**/etc/rc.conf** + +On the host node, add this bridge configuration to :file:`/etc/rc.conf`: + +.. code-block:: none + + # set up bridge interface for iocage + cloned_interfaces="bridge0" + + # plumb interface em0 into bridge0 + ifconfig_bridge0="addm em0 up" + ifconfig_em0="up" + +**/etc/sysctl.conf** + +Add these tunables to :file:`/etc/sysctl.conf`: + +.. code-block:: none + + net.inet.ip.forwarding=1 # Enable IP forwarding between interfaces + net.link.bridge.pfil_onlyip=0 # Only pass IP packets when pfil is enabled + net.link.bridge.pfil_bridge=0 # Packet filter on the bridge interface + net.link.bridge.pfil_member=0 # Packet filter on the member interface + +**Enable vnet for the jail** + +:samp:`# iocage set vnet=on examplejail` + +**Configure jail's default gateway** + +:samp:`# iocage set defaultrouter=10.1.1.254 examplejail` + +**Configure an IP address** + +:samp:`iocage set ip4_addr="vnet0|10.1.1.10/24" examplejail` + +**Start jail and ping the default gateway** + +Start the jail: + +:samp:`# iocage start examplejail` + +Open the system console inside the jail: + +:samp:`iocage console examplejail` + +Ping the previously configured default gateway: + +:samp:`# ping 10.1.1.254` + +.. index:: VNET tips +.. _VNET Tips: + +Tips +++++ + +**Routes** + +Be sure the default gateway knows the route back to the VNET subnets. + +**Using VLANs** + +To assign a jail's traffic to a VLAN, add the VLAN interface as a bridge +member, but not the VLAN's parent. For example: + +.. code-block:: none + + sysrc vlans_em0="666" + sysrc ifconfig_em0_666="up" + iocage set vnet_default_interface="em0.666" examplejail + iocage set interfaces="vnet1:bridge1" examplejail + + +If using VLAN interfaces for the jail host only, on the other hand, add the +parent as a bridge member, but not the VLAN interface. + +.. code-block:: none + + sysrc vlans_em0="666" + sysrc ifconfig_em0_666="1.2.3.4/24" + iocage set vnet_default_interface="auto" examplejail # "em0" would also work + iocage set interfaces="vnet1:bridge1" examplejail + +.. index:: Configure Network Interfaces +.. _Configuring Network Interfaces: + +Configuring Network Interfaces +------------------------------ + +:command:`iocage` transparently handles network configuration for both +*Shared IP* and *VNET* jails. + +.. index:: Configure Shared IP jail +.. _Configuring a Shared IP Jail: + +Configuring a Shared IP Jail +++++++++++++++++++++++++++++ + +**IPv4** + +:samp:`# iocage set ip4_addr="em0|192.168.0.10/24" examplejail` + +**IPv6** + +:samp:`# iocage set ip6_addr="em0|2001:123:456:242::5/64" examplejail` + +These examples add IP alias *192.168.0.10/24* and *2001:123:456::5/64* +to interface *em0* of the shared IP jail, at start time. + +.. index:: Configure VNET Jail +.. _Configuring a VNET Jail: + +Configuring a VNET Jail ++++++++++++++++++++++++ + +To configure both IPv4 and IPv6: + +:samp:`# iocage set ip4_addr="vnet0|192.168.0.10/24" examplejail` + +:samp:`# iocage set ip6_addr="vnet0|2001:123:456:242::5/64" examplejail` + +:samp:`# iocage set defaultrouter6="2001:123:456:242::1" examplejail` + +.. note:: For VNET jails, a default route has to also be specified. + +To create a a jail with a DHCP interface add the `dhcp=on` property: + +:samp:`# iocage create -r 11.0-RELEASE --name myjail dhcp=on` + +The `dhcp=on` property implies creating a VNET virtual network stack and +enabling the Berkley Packet Filter. DHCP cannot work without VNET. +More information about VNET is available in the VNET(9) FreeBSD manual page. + +.. index:: Tips for configuring VNET +.. _Tips for Configuring VNET: + +Tips for Configuring VNET ++++++++++++++++++++++++++ + +To start a jail with no IPv4/6 address, **set** the *ip4_addr* and +*ip6_addr* properties, then the *defaultrouter* and *defaultrouter6* +properties: + +:samp:`# iocage set ip4_addr=none ip6_addr=none examplejail` + +:samp:`# iocage set defaultrouter=none defaultrouter6=none examplejail` + +Force iocage to regenerate the MAC and HW address (e.g.: after cloning a jail). This will cause the MAC and HW addresses to be regenerated when the jail is next started. + +:samp:`# iocage set vnet0_mac=none examplejail` diff --git a/docs/_sources/plugins.rst.txt b/docs/_sources/plugins.rst.txt new file mode 100644 index 00000000..77d96115 --- /dev/null +++ b/docs/_sources/plugins.rst.txt @@ -0,0 +1,126 @@ +.. index:: Plugins +.. _Plugins: + +Plugins +======= + +iocage plugins are a simple and very fast method to get application +containers installed and configured. At its core, a plugin is a jail +specifically running one program. Popular programs can be installed +repeatedly with one line. Additionally, plugins are easily extended by +users, offering a high level of customizability and functionality. + +In structure, a plugin consists of :file:`.json` manifest and +:file:`.png` icon files. + + +**See what's available** + + +To see a list of all currently available plugins, open a command line +and type :command:`iocage list -PR` or +:command:`iocage list --plugins --remote`. The full +`iocage plugin list `_ +is also available on GitHub. + +Check which plugins are installed on the system with +:command:`iocage list --plugins` or :command:`iocage list -P`. + + +**Getting started with plugins** + + +.. note:: iocage needs to be `activated `_ before + plugins can be installed or modified! + + +To get started, open a command line and type +:command:`iocage fetch --plugins ip4_addr="IF|IP"`. This initial +:command:`fetch` also supports *dhcp* in the same manner as +:command:`iocage create`. The IP listed for the plugin needs to +be a valid IP not already in use. Use the *- -name* flag to easily fetch a +specific plugin: + +:samp:`$ iocage fetch --plugins --name plexmediaserver ip4_addr="igb0|192.168.0.91"` + +If available, plugins can also be fetched locally with +:command:`iocage fetch -P the/path/to/plugin.json ip4_addr="re0|192.168.0.100"` + + +.. tip:: Using :command:`iocage fetch` locally is very useful when + testing an in-development plugin. + + +After fetching a plugin, view of all its properties with +:command:`iocage get -a NAME|UUID | less`. Individual properties are +found with :command:`iocage get PROPERTY`: + +:samp:`$ iocage get type quasselcore` + +Adjust the plugin properties with :command:`iocage set`: + +:samp:`$ iocage set PROPERTY quasselcore` + + +:command:`iocage set` is used to configure +that plugin. In this example, a complete Quasselcore plugin is +installed to a FreeNAS system, then the note of the plugin is changed: + +.. code-block:: none + + [root@freenas ~]# iocage fetch --plugins --name quasselcore ip4_addr="em0|192.168.1.50" + [root@freenas ~]# iocage set notes="Hello world" quasselcore + [root@freenas ~]# iocage get notes quasselcore + Hello world + + +**Upgrading and updating plugins** + + +The process for upgrading and updating plugins is exactly the same as +normal jails. See :ref:`Updating Jails` or :ref:`Upgrading Jails` . + + +**Plugin Manifest Example** + + +Following is an example of a plugin manifest: + +.. sourcecode:: json + + { + "name": "default_jail_name_here", + "release": "11.3-RELEASE", + "artifact": "https://github.com/git_path_to_plugin_repo", + "official": false, + "properties": { + "nat": 1, + "nat_forwards": "tcp(7878:7878)" + }, + "devfs_ruleset": { + "paths": {"bpf*": null}, + "includes": [] + }, + "pkgs": [ + ], + "packagesite": "http://pkg.FreeBSD.org/${ABI}/latest", + "fingerprints": { + "iocage-plugins": [ + { + "function": "sha256", + "fingerprint": "b0170035af3acc5f3f3ae1859dc717101b4e6c1d0a794ad554928ca0cbb2f438" + } + ] + }, + "revision": 0 + } + +* **devfs_ruleset**: It should be a valid dictionary object where "paths" must be specified. Value of "paths" is a + dictionary where keys are the path to be added and the value is the mode to be used. `null` translates to `unhide`. + For any include specified, please refer to the following example which shows how each path specified is added as + iocage dynamically generates a devfs ruleset and how an include is added to the ruleset: + +.. sourcecode:: shell + + devfs rule -s ruleset_number add path bpf* unhide + devfs rule -s ruleset_number add include include_value diff --git a/docs/_sources/setup.rst.txt b/docs/_sources/setup.rst.txt new file mode 100644 index 00000000..31789b12 --- /dev/null +++ b/docs/_sources/setup.rst.txt @@ -0,0 +1,7 @@ +setup module +============ + +.. automodule:: setup + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/_sources/templates.rst.txt b/docs/_sources/templates.rst.txt new file mode 100644 index 00000000..211d70f9 --- /dev/null +++ b/docs/_sources/templates.rst.txt @@ -0,0 +1,91 @@ +.. index:: Using Templates +.. _Using Templates: + +Using Templates +=============== + +**Templates can save precious time!** + +Set up a jail and create a template from it. All packages and +preconfigured settings remain available for deployment to new jails +within seconds. + +Any jail can be converted between jail and template as needed. +Essentially, a template is just another jail which has the property +**template** set to **yes**. The difference is templates are not started +by :command:`iocage`. + +**Create a template with iocage:** + +1. Create a jail: :samp:`# iocage create -r 11.0-RELEASE -n mytemplate`. +2. Configure the jail's networking. +3. Install packages and/or customize the jail as needed. +4. Once finished with customization, stop the jail: + :samp:`# iocage stop mytemplate`. +5. It is recommended to add notes to the jail, so the specific jail + customizations are easily remembered: + :samp:`# iocage set notes="customized PHP,nginx jail" mytemplate` +6. Set the **template** property **on**: + :samp:`# iocage set template=yes mytemplate`. +7. Find the new template with :command:`iocage list -t`. + +**Use the created template:** + +Use :command:`iocage create -t` to create a new jail from the new +template: + +1. :samp:`# iocage create -t mytemplate -n jailfromtemplate` +2. Find the new jail with :command:`iocage list`. +3. Start the jail with :samp:`# iocage start jailfromtemplate`. + +Done! + +**Customizing a template:** + +To make changes to the template, you will need to know whether any existing +jails are based on the template. Since modifying the template will require +converting it back into a jail, it cannot be the base for any jails. + +*** No jails based on the template *** + +1. Convert the template back into a jail: + + :command:`iocage set template=no [UUID | NAME]`. + +2. Start the jail: + + :command:`iocage start [UUID | NAME]`. + +3. Use any method you wish to connect to the jail and modify its contents. + +4. Stop the jail: + + :command:`iocage stop [UUID | NAME]`. + +5. Convert the jail back into a template: + + :command:`iocage set template=yes [UUID | NAME]`. + +*** Jails based on the template *** + +This process will create a new template, leaving the existing template +and jails unaffected. + +1. Create a 'thick' jail from the template, so that it will be independent + from the template: + + :command:`iocage create -T -t [UUID | NAME] -n newtemplate`. + +2. Start the jail: + + :command:`iocage start newtemplate`. + +3. Use any method you wish to connect to the jail and modify its contents. + +4. Stop the jail: + + :command:`iocage stop newtemplate`. + +5. Convert the jail into a template: + + :command:`iocage set template=yes newtemplate`. diff --git a/docs/_sources/tests.rst.txt b/docs/_sources/tests.rst.txt new file mode 100644 index 00000000..4789412a --- /dev/null +++ b/docs/_sources/tests.rst.txt @@ -0,0 +1,30 @@ +tests package +============= + +Submodules +---------- + +tests.conftest module +--------------------- + +.. automodule:: tests.conftest + :members: + :undoc-members: + :show-inheritance: + +tests.data\_classes module +-------------------------- + +.. automodule:: tests.data_classes + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/_static/_sphinx_javascript_frameworks_compat.js b/docs/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 00000000..8549469d --- /dev/null +++ b/docs/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,134 @@ +/* + * _sphinx_javascript_frameworks_compat.js + * ~~~~~~~~~~ + * + * Compatability shim for jQuery and underscores.js. + * + * WILL BE REMOVED IN Sphinx 6.0 + * xref RemovedInSphinx60Warning + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} diff --git a/docs/_static/agogo.css b/docs/_static/agogo.css new file mode 100644 index 00000000..0260ce7f --- /dev/null +++ b/docs/_static/agogo.css @@ -0,0 +1,549 @@ +/* + * agogo.css_t + * ~~~~~~~~~~~ + * + * Sphinx stylesheet -- agogo theme. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +* { + margin: 0px; + padding: 0px; +} + +body { + font-family: "Verdana", Arial, sans-serif; + line-height: 1.4em; + color: black; + background-color: #eeeeec; +} + + +/* Page layout */ + +div.header, div.content, div.footer { + width: 70em; + margin-left: auto; + margin-right: auto; +} + +div.header-wrapper { + background: #555 top left repeat-x; + border-bottom: 3px solid #2e3436; +} + + +/* Default body styles */ +a { + color: #ce5c00; +} + +div.bodywrapper a, div.footer a { + text-decoration: underline; +} + +.clearer { + clear: both; +} + +.left { + float: left; +} + +.right { + float: right; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +h1, h2, h3, h4 { + font-family: "Georgia", "Times New Roman", serif; + font-weight: normal; + color: #3465a4; + margin-bottom: .8em; +} + +h1 { + color: #204a87; +} + +h2 { + padding-bottom: .5em; + border-bottom: 1px solid #3465a4; +} + +a.headerlink { + visibility: hidden; + color: #dddddd; + padding-left: .3em; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +img { + border: 0; +} + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 2px 7px 1px 7px; + border-left: 0.2em solid black; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +dt:target, .highlighted { + background-color: #fbe54e; +} + +/* Header */ + +div.header { + padding-top: 10px; + padding-bottom: 10px; +} + +div.header .headertitle { + font-family: "Georgia", "Times New Roman", serif; + font-weight: normal; + font-size: 180%; + letter-spacing: .08em; + margin-bottom: .8em; +} + +div.header .headertitle a { + color: white; +} + +div.header div.rel { + margin-top: 1em; +} + +div.header div.rel a { + color: #fcaf3e; + letter-spacing: .1em; + text-transform: uppercase; +} + +p.logo { + float: right; +} + +img.logo { + border: 0; +} + + +/* Content */ +div.content-wrapper { + background-color: white; + padding-top: 20px; + padding-bottom: 20px; +} + +div.document { + width: 50em; + float: left; +} + +div.body { + padding-right: 2em; + text-align: justify; +} + +div.document h1 { + line-height: 120%; +} + +div.document ul { + margin: 1.5em; + list-style-type: square; +} + +div.document dd { + margin-left: 1.2em; + margin-top: .4em; + margin-bottom: 1em; +} + +div.document .section { + margin-top: 1.7em; +} +div.document .section:first-child { + margin-top: 0px; +} + +div.document div.highlight { + padding: 3px; + border-top: 2px solid #dddddd; + border-bottom: 2px solid #dddddd; + margin-top: .8em; + margin-bottom: .8em; +} + +div.document div.literal-block-wrapper { + margin-top: .8em; + margin-bottom: .8em; +} + +div.document div.literal-block-wrapper div.highlight { + margin: 0; +} + +div.document div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.document div.code-block-caption span.caption-text { +} + +div.document h2 { + margin-top: .7em; +} + +div.document p { + margin-bottom: .5em; +} + +div.document li.toctree-l1 { + margin-bottom: 1em; +} + +div.document .descname { + font-weight: bold; +} + +div.document .sig-paren { + font-size: larger; +} + +div.document .docutils.literal { + background-color: #eeeeec; + padding: 1px; +} + +div.document .docutils.xref.literal { + background-color: transparent; + padding: 0px; +} + +div.document blockquote { + margin: 1em; +} + +div.document ol { + margin: 1.5em; +} + + +/* Sidebar */ + +div.sidebar, +aside.sidebar { + width: 20em; + float: right; + font-size: .9em; +} + +div.sidebar a, aside.sidebar a, div.header a { + text-decoration: none; +} + +div.sidebar a:hover, aside.sidebar a:hover, div.header a:hover { + text-decoration: underline; +} + +div.sidebar h3, +aside.sidebar h3 { + color: #2e3436; + text-transform: uppercase; + font-size: 130%; + letter-spacing: .1em; +} + +div.sidebar ul, +aside.sidebar ul { + list-style-type: none; +} + +div.sidebar li.toctree-l1 a, +aside.sidebar li.toctree-l1 a { + display: block; + padding: 1px; + border: 1px solid #dddddd; + background-color: #eeeeec; + margin-bottom: .4em; + padding-left: 3px; + color: #2e3436; +} + +div.sidebar li.toctree-l2 a, +aside.sidebar li.toctree-l2 a { + background-color: transparent; + border: none; + margin-left: 1em; + border-bottom: 1px solid #dddddd; +} + +div.sidebar li.toctree-l3 a, +aside.sidebar li.toctree-l3 a { + background-color: transparent; + border: none; + margin-left: 2em; + border-bottom: 1px solid #dddddd; +} + +div.sidebar li.toctree-l2:last-child a, +aside.sidebar li.toctree-l2:last-child a { + border-bottom: none; +} + +div.sidebar li.toctree-l1.current a, +aside.sidebar li.toctree-l1.current a { + border-right: 5px solid #fcaf3e; +} + +div.sidebar li.toctree-l1.current li.toctree-l2 a, +aside.sidebar li.toctree-l1.current li.toctree-l2 a { + border-right: none; +} + +div.sidebar input[type="text"], +aside.sidebar input[type="text"] { + width: 170px; +} + +div.sidebar input[type="submit"], +aside.sidebar input[type="submit"] { + width: 30px; +} + + +/* Footer */ + +div.footer-wrapper { + background: url(bgfooter.png) top left repeat-x; + border-top: 4px solid #babdb6; + padding-top: 10px; + padding-bottom: 10px; + min-height: 80px; +} + +div.footer, div.footer a { + color: #888a85; +} + +div.footer .right { + text-align: right; +} + +div.footer .left { + text-transform: uppercase; +} + + +/* Styles copied from basic theme */ + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-right { + text-align: right; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- viewcode extension ---------------------------------------------------- */ + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family:: "Verdana", Arial, sans-serif; +} + +div.viewcode-block:target { + margin: -1px -3px; + padding: 0 3px; + background-color: #f4debf; + border-top: 1px solid #ac9; + border-bottom: 1px solid #ac9; +} + +div.code-block-caption { + background-color: #ddd; + color: #333; + padding: 2px 5px; + font-size: small; +} + +/* -- math display ---------------------------------------------------------- */ + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} \ No newline at end of file diff --git a/docs/_static/ajax-loader.gif b/docs/_static/ajax-loader.gif new file mode 100644 index 0000000000000000000000000000000000000000..61faf8cab23993bd3e1560bff0668bd628642330 GIT binary patch literal 673 zcmZ?wbhEHb6krfw_{6~Q|Nno%(3)e{?)x>&1u}A`t?OF7Z|1gRivOgXi&7IyQd1Pl zGfOfQ60;I3a`F>X^fL3(@);C=vM_KlFfb_o=k{|A33hf2a5d61U}gjg=>Rd%XaNQW zW@Cw{|b%Y*pl8F?4B9 zlo4Fz*0kZGJabY|>}Okf0}CCg{u4`zEPY^pV?j2@h+|igy0+Kz6p;@SpM4s6)XEMg z#3Y4GX>Hjlml5ftdH$4x0JGdn8~MX(U~_^d!Hi)=HU{V%g+mi8#UGbE-*ao8f#h+S z2a0-5+vc7MU$e-NhmBjLIC1v|)9+Im8x1yacJ7{^tLX(ZhYi^rpmXm0`@ku9b53aN zEXH@Y3JaztblgpxbJt{AtE1ad1Ca>{v$rwwvK(>{m~Gf_=-Ro7Fk{#;i~+{{>QtvI yb2P8Zac~?~=sRA>$6{!(^3;ZP0TPFR(G_-UDU(8Jl0?(IXu$~#4A!880|o%~Al1tN literal 0 HcmV?d00001 diff --git a/docs/_static/basic.css b/docs/_static/basic.css new file mode 100644 index 00000000..fb908a96 --- /dev/null +++ b/docs/_static/basic.css @@ -0,0 +1,900 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 20em; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/docs/_static/bgfooter.png b/docs/_static/bgfooter.png new file mode 100644 index 0000000000000000000000000000000000000000..b7c7cadd4e6978aa7081fe672fcf5afc97516bda GIT binary patch literal 276 zcmV+v0qg#WP)qvnR6EfsQ*t~7O=UY2%BZy- zs#7>Lw$#|1-#yb5jZ8}CcXenmE?Bb?+emvZy3eu4G&!aT9i`%Ot1U0%(#mRx?NNc)^t8TJHA0R4$Di^IIL4X9&MVm&N-9#bE;?}xqq}wTrc0WUU#YK z#2JfT+O{=ipwX3&j4H~AegD$wD(9Ee_Le?vx(rq^B%Dj?^+nzae0J!bK00|W&N)Yz aUi|<^NiO;Hz(H~V0000P0IhA`JcOe?|*M3M!YD+&^mI=Y=U~-8S>8l1XAJ*3?jZZ Q8UO$Q07*qoM6N<$f;!4|TmS$7 literal 0 HcmV?d00001 diff --git a/docs/_static/comment-bright.png b/docs/_static/comment-bright.png new file mode 100644 index 0000000000000000000000000000000000000000..15e27edb12ac25701ac0ac21b97b52bb4e45415e GIT binary patch literal 756 zcmVgfIX78 z$8Pzv({A~p%??+>KickCb#0FM1rYN=mBmQ&Nwp<#JXUhU;{|)}%&s>suq6lXw*~s{ zvHx}3C%<;wE5CH!BR{p5@ml9ws}y)=QN-kL2?#`S5d*6j zk`h<}j1>tD$b?4D^N9w}-k)bxXxFg>+#kme^xx#qg6FI-%iv2U{0h(Y)cs%5a|m%Pn_K3X_bDJ>EH#(Fb73Z zfUt2Q3B>N+ot3qb*DqbTZpFIn4a!#_R-}{?-~Hs=xSS6p&$sZ-k1zDdtqU`Y@`#qL z&zv-~)Q#JCU(dI)Hf;$CEnK=6CK50}q7~wdbI->?E07bJ0R;!GSQTs5Am`#;*WHjvHRvY?&$Lm-vq1a_BzocI^ULXV!lbMd%|^B#fY;XX)n<&R^L z=84u1e_3ziq;Hz-*k5~zwY3*oDKt0;bM@M@@89;@m*4RFgvvM_4;5LB!@OB@^WbVT zjl{t;a8_>od-~P4 m{5|DvB&z#xT;*OnJqG}gk~_7HcNkCr0000W zanA~u9RIXo;n7c96&U)YLgs-FGlx~*_c{Jgvesu1E5(8YEf&5wF=YFPcRe@1=MJmi zag(L*xc2r0(slpcN!vC5CUju;vHJkHc*&70_n2OZsK%O~A=!+YIw z7zLLl7~Z+~RgWOQ=MI6$#0pvpu$Q43 zP@36QAmu6!_9NPM?o<1_!+stoVRRZbW9#SPe!n;#A_6m8f}|xN1;H{`0RoXQ2LM47 zt(g;iZ6|pCb@h2xk&(}S3=EVBUO0e90m2Lp5CB<(SPIaB;n4))3JB87Or#XPOPcum z?<^(g+m9}VNn4Y&B`g8h{t_$+RB1%HKRY6fjtd-<7&EsU;vs0GM(Lmbhi%Gwcfs0FTF}T zL{_M6Go&E0Eg8FuB*(Yn+Z*RVTBE@10eIOb3El^MhO`GabDll(V0&FlJi2k^;q8af zkENdk2}x2)_KVp`5OAwXZM;dG0?M-S)xE1IKDi6BY@5%Or?#aZ9$gcX)dPZ&wA1a< z$rFXHPn|TBf`e?>Are8sKtKrKcjF$i^lp!zkL?C|y^vlHr1HXeVJd;1I~g&Ob-q)& z(fn7s-KI}G{wnKzg_U5G(V%bX6uk zIa+<@>rdmZYd!9Y=C0cuchrbIjuRB_Wq{-RXlic?flu1*_ux}x%(HDH&nT`k^xCeC ziHi1!ChH*sQ6|UqJpTTzX$aw8e(UfcS^f;6yBWd+(1-70zU(rtxtqR%j z-lsH|CKQJXqD{+F7V0OTv8@{~(wp(`oIP^ZykMWgR>&|RsklFMCnOo&Bd{le} zV5F6424Qzl;o2G%oVvmHgRDP9!=rK8fy^!yV8y*4p=??uIRrrr0?>O!(z*g5AvL2!4z0{sq%vhG*Po}`a<6%kTK5TNhtC8}rXNu&h^QH4A&Sk~Autm*s~45(H7+0bi^MraaRVzr05hQ3iK?j` zR#U@^i0WhkIHTg29u~|ypU?sXCQEQgXfObPW;+0YAF;|5XyaMAEM0sQ@4-xCZe=0e z7r$ofiAxn@O5#RodD8rh5D@nKQ;?lcf@tg4o+Wp44aMl~c47azN_(im0N)7OqdPBC zGw;353_o$DqGRDhuhU$Eaj!@m000000NkvXXu0mjfjZ7Z_ literal 0 HcmV?d00001 diff --git a/docs/_static/doctools.js b/docs/_static/doctools.js new file mode 100644 index 00000000..527b876c --- /dev/null +++ b/docs/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js new file mode 100644 index 00000000..61ed8cfb --- /dev/null +++ b/docs/_static/documentation_options.js @@ -0,0 +1,14 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '1.9', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/docs/_static/down-pressed.png b/docs/_static/down-pressed.png new file mode 100644 index 0000000000000000000000000000000000000000..5756c8cad8854722893dc70b9eb4bb0400343a39 GIT binary patch literal 222 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!61|;P_|4#%`OFdm2Ln;`PZ^+1>KjR?B@S0W7 z%OS_REiHONoJ6{+Ks@6k3590|7k9F+ddB6!zw3#&!aw#S`x}3V3&=A(a#84O-&F7T z^k3tZB;&iR9siw0|F|E|DAL<8r-F4!1H-;1{e*~yAKZN5f0|Ei6yUmR#Is)EM(Po_ zi`qJR6|P<~+)N+kSDgL7AjdIC_!O7Q?eGb+L+qOjm{~LLinM4NHn7U%HcK%uoMYO5 VJ~8zD2B3o(JYD@<);T3K0RV0%P>BEl literal 0 HcmV?d00001 diff --git a/docs/_static/down.png b/docs/_static/down.png new file mode 100644 index 0000000000000000000000000000000000000000..1b3bdad2ceffae91cee61b32f3295f9bbe646e48 GIT binary patch literal 202 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!60wlNoGJgf6CVIL!hEy=F?b*7pIY7kW{q%Rg zx!yQ<9v8bmJwa`TQk7YSw}WVQ()mRdQ;TC;* literal 0 HcmV?d00001 diff --git a/docs/_static/file.png b/docs/_static/file.png new file mode 100644 index 0000000000000000000000000000000000000000..a858a410e4faa62ce324d814e4b816fff83a6fb3 GIT binary patch literal 286 zcmV+(0pb3MP)s`hMrGg#P~ix$^RISR_I47Y|r1 z_CyJOe}D1){SET-^Amu_i71Lt6eYfZjRyw@I6OQAIXXHDfiX^GbOlHe=Ae4>0m)d(f|Me07*qoM6N<$f}vM^LjV8( literal 0 HcmV?d00001 diff --git a/docs/_static/jquery-3.6.0.js b/docs/_static/jquery-3.6.0.js new file mode 100644 index 00000000..fc6c299b --- /dev/null +++ b/docs/_static/jquery-3.6.0.js @@ -0,0 +1,10881 @@ +/*! + * jQuery JavaScript Library v3.6.0 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright OpenJS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2021-03-02T17:08Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + // Support: QtWeb <=3.8.5, WebKit <=534.34, wkhtmltopdf tool <=0.12.5 + // Plus for old WebKit, typeof returns "function" for HTML collections + // (e.g., `typeof document.getElementsByTagName("div") === "function"`). (gh-4756) + return typeof obj === "function" && typeof obj.nodeType !== "number" && + typeof obj.item !== "function"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.6.0", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), + function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); + } ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.6 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2021-02-16 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem && elem.namespaceURI, + docElem = elem && ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +} +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the primary Deferred + primary = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + primary.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, primary.done( updateFunc( i ) ).resolve, primary.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( primary.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return primary.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), primary.reject ); + } + + return primary.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + + // Support: Chrome 86+ + // In Chrome, if an element having a focusout handler is blurred by + // clicking outside of it, it invokes the handler synchronously. If + // that handler calls `.remove()` on the element, the data is cleared, + // leaving `result` undefined. We need to guard against this. + return result && result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + which: true +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + // Suppress native focus or blur as it's already being fired + // in leverageNative. + _default: function() { + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + // + // Support: Firefox 70+ + // Only Firefox includes border widths + // in computed dimensions. (gh-4529) + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px;border-collapse:separate"; + tr.style.cssText = "border:1px solid"; + + // Support: Chrome 86+ + // Height set through cssText does not get applied. + // Computed height then comes back as 0. + tr.style.height = "1px"; + trChild.style.height = "9px"; + + // Support: Android 8 Chrome 86+ + // In our bodyBackground.html iframe, + // display for all div elements is set to "inline", + // which causes a problem only in Android 8 Chrome 86. + // Ensuring the div is display: block + // gets around this issue. + trChild.style.display = "block"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = ( parseInt( trStyle.height, 10 ) + + parseInt( trStyle.borderTopWidth, 10 ) + + parseInt( trStyle.borderBottomWidth, 10 ) ) === tr.offsetHeight; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( dataPriv.get( cur, "events" ) || Object.create( null ) )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml, parserErrorElem; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) {} + + parserErrorElem = xml && xml.getElementsByTagName( "parsererror" )[ 0 ]; + if ( !xml || parserErrorElem ) { + jQuery.error( "Invalid XML: " + ( + parserErrorElem ? + jQuery.map( parserErrorElem.childNodes, function( el ) { + return el.textContent; + } ).join( "\n" ) : + data + ) ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ).filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ).map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + +originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script but not if jsonp + if ( !isSuccess && + jQuery.inArray( "script", s.dataTypes ) > -1 && + jQuery.inArray( "json", s.dataTypes ) < 0 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+

Advanced Usage

+
+

Clones

+

When a jail is cloned, iocage creates a ZFS clone filesystem. +Essentially, clones are cheap, lightweight, and writable snapshots.

+

A clone depends on its source snapshot and filesystem. To destroy the +source jail and preserve its clones, the clone must be promoted first.

+
+

Create a Clone

+

To clone www01 to www02, run:

+

# iocage clone www01 --name www02

+

Clone a jail from an existing snapshot with:

+

# iocage clone www01@snapshotname --name www03

+
+
+

Promoting a Clone

+
+

Warning

+

This functionality isn’t fully added to iocage, and may not +function as expected.

+
+

To promote a cloned jail, run:

+

iocage promote [UUID | NAME]

+

This reverses the clone and source jail relationship. The clone +becomes the source and the source jail is demoted to a clone.

+

The demoted jail can now be removed:

+

iocage destroy [UUID | NAME]

+
+
+
+

Updating Jails

+

Updates are handled with the freebsd-update(8) utility. Jails can be +updated while they are stopped or running.

+
+

Note

+

The command iocage update [UUID | NAME] +automatically creates a backup snapshot of the jail given.

+
+

To create a backup snapshot manually, run:

+

iocage snapshot -n [snapshotname] [UUID | NAME]

+

To update a jail to latest patch level, run:

+

iocage update [UUID | NAME]

+

When updates are finished and the jail appears to function properly, +remove the snapshot:

+

iocage snapremove [UUID|NAME]@[snapshotname]

+

To test updating without affecting a jail, create a clone and update the +clone the same way as outlined above.

+

To clone a jail, run:

+

iocage clone [UUID|NAME] --name [testupdate]

+
+

Note

+

The [-n | –name] flag is optional. iocage +assigns an UUID to the jail if [-n | –name] is not used.

+
+
+
+

Upgrading Jails

+

Upgrades are handled with the freebsd-update(8) utility. By default, the +user must supply the new RELEASE for the jail’s upgrade. For example:

+

# iocage upgrade examplejail -r 11.0-RELEASE

+

Tells jail examplejail to upgrade its RELEASE to 11.0-RELEASE.

+
+

Note

+

It is recommended to keep the iocage host and jails RELEASE +synchronized.

+
+

To upgrade a jail to the host’s RELEASE, run:

+

iocage upgrade -r [11.1-RELEASE] [UUID | NAME]

+

This upgrades the jail to the same RELEASE as the host. This method also +applies to basejails.

+
+
+

Auto-boot

+

Make sure iocage_enable="YES" is set in /etc/rc.conf.

+

To enable a jail to auto-boot during a system boot, simply run:

+

# iocage set boot=on UUID|NAME

+
+

Note

+

Setting boot=on during jail creation starts the +jail after the jail is created.

+
+
+

Boot Priority

+

Boot order can be specified by setting the priority value:

+

iocage set priority=[20] [UUID|NAME]

+

Lower values are higher in the boot priority.

+
+
+

Depends Property

+

Use the depends property to require other jails to start +before this one. It is space delimited. Jails listed as dependents +also wait to start if those jails have listed depends.

+

Example: iocage set depends=“foo bar” baz

+
+
+
+

Snapshot Management

+

iocage supports transparent ZFS snapshot management out of the box. +Snapshots are point-in-time copies of data, a safety point to which a +jail can be reverted at any time. Initially, snapshots take up almost no +space, as only changing data is recorded.

+

You may use ALL as a target jail name for these commands if you want to target all jails at once.

+

List snapshots for a jail:

+

iocage snaplist [UUID|NAME]

+

Create a new snapshot:

+

iocage snapshot [UUID|NAME]

+

This creates a snapshot based on the current time.

+

iocage snapshot [UUID|NAME] -n [SNAPSHOT NAME]

+

This creates a snapshot with the given name.

+

Delete a snapshot:

+

iocage snapremove [UUID|NAME] -n [SNAPSHOT NAME]

+

Delete all snapshots from a jail (requires -f / –force):

+

iocage snapremove [UUID|NAME] -n ALL -f

+
+
+

Resource Limits (Legacy ONLY)

+
+

Warning

+

This functionality is only available for legacy versions of +iocage. It is not yet implemented in the current version. +This applies to all subsections of Resource Limits.

+
+

iocage can enable optional resource limits for a jail. The +outlined procedure here is meant to provide a starting point for the +user.

+
+

Limit Cores or Threads

+

Limit a jail to a single thread or core #1:

+

iocage set cpuset=1 [UUID|TAG] +iocage start [UUID|TAG]

+
+
+

List Applied Limits

+

List applied limits:

+

iocage limits [UUID|TAG]

+
+
+

Limit DRAM use

+

This example limits a jail to using 4 Gb DRAM memory (limiting RSS +memory use can be done on-the-fly):

+

# iocage set memoryuse=4G:deny examplejail

+
+
+

Turn on Resource Limits

+

Turn on resource limiting for a jail with:

+

iocage set rlimits=on [UUID|TAG]

+
+
+

Apply limits

+

Apply limits to a running jail with:

+

iocage cap [UUID | TAG]

+
+
+

Check Limits

+

Check the currently active limits on a jail with:

+

iocage limits [UUID | TAG]

+
+
+

Limit CPU Usage by %

+

In this example, iocage limits testjail CPU execution to +20%, then applies the limitation to the active jail:

+

# iocage set pcpu=20:deny testjail +# iocage cap testjail

+

Double check the jail’s current limits to confirm the functionality:

+

# iocage limits testjail

+
+
+
+

Automatic Package Installation

+

Packages can be installed automatically at creation time!

+

Use the [-p | –pkglist] option at creation time, which needs to point +to a JSON file containing one package name per line.

+
+

Note

+

An Internet connection is required for automatic package +installations, as pkg install obtains packages from online +repositories.

+
+

Create a pkgs.json file and add package names to it.

+

pkgs.json:

+
{
+    "pkgs": [
+    "nginx",
+    "tmux"
+    ]
+}
+
+
+

Now, create a jail and supply pkgs.json:

+

iocage create -r [RELEASE] -p [path-to/pkgs.json] -n [NAME]

+
+

Note

+

The [-n | –name] flag is optional. iocage +assigns an UUID to the jail if [-n | –name] is not used.

+
+

This installs nginx and tmux in the newly created jail.

+
+
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ previous | + next | + modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/basic-use.html b/docs/basic-use.html new file mode 100644 index 00000000..3fb6c532 --- /dev/null +++ b/docs/basic-use.html @@ -0,0 +1,351 @@ + + + + + + + + + Basic Usage — iocage 1.9 documentation + + + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+

Basic Usage

+

This section is about basic iocage usage and is meant as a “how-to” +reference for new users.

+
+

Tip

+

Remember, command line help is always available by typing +iocage --help or iocage [subcommand] --help.

+
+

iocage has a basic “flow” when first used. As a new user interacts with +iocage for the first time, this flow guides them through initializing +iocage, then interacting with newly created jails.

+
+

Tip

+

iocage has an experimental “color” mode enabled by setting the +environment variable IOCAGE_COLOR to TRUE.

+
+
+

Setting Environment Variables

+

iocage currently has four environment variables:

+ + + + + + + + + + + + + + + + + + + + + + + + +
iocage Environment Variables

Name

Accepted Values

Description

IOCAGE_LOGFILE

FILE

File location to have iocage log into.

IOCAGE_COLOR

TRUE|FALSE

Turns on a colored CLI output.

IOCAGE_FORCE

TRUE|FALSE

Required for any automatic migrations

IOCAGE_PLUGIN_IP

IP_ADDR

This environment variable is set in a plugin jail. +Use it to quickly query it with another +program/script

+

The process for setting these variables depends on the shell being used. +The default FreeBSD shell csh/tcsh and the bash/sh +shell are different from one another and require a slightly different +process for setting environment variables. For example:

+

In the FreeBSD shell csh/tcsh , setenv IOCAGE_COLOR TRUE +sets the environment variable IOCAGE_COLOR to true.

+

In the bash/sh shell, export IOCAGE_COLOR=TRUE sets +the environment variable IOCAGE_COLOR to true.

+
+
+

Activate iocage

+

Before iocage is functional, it needs to activate. +Essentially, iocage needs to link with a usable zpool. In most cases, +activation is automatic to the primary system zpool, but more advanced +users can use iocage activate to designate a different zpool +for iocage usage.

+

Once iocage is ready with an active zpool, users are able to immediately +begin downloading FreeBSD releases for jail creation.

+
+
+

Fetch a Release

+

iocage now needs to fetch a RELEASE, which is used to create +jails. By default, typing iocage fetch opens a menu for the +user to choose which release to download, as seen in this example:

+
# iocage fetch
+[0] 9.3-RELEASE (EOL)
+[1] 10.1-RELEASE (EOL)
+[2] 10.2-RELEASE (EOL)
+[3] 10.3-RELEASE
+[4] 11.0-RELEASE
+
+Type the number of the desired RELEASE
+Press [Enter] to fetch the default selection: (11.0-RELEASE)
+Type EXIT to quit: 4
+
+
+

Once the desired RELEASE is downloaded, the most recent patches are also +applied to it.

+

iocage fetch also has a number of options and properties for +users to fine-tune the functionality of the command.

+

To fetch the latest RELEASE,

+

iocage fetch -r LATEST

+

If a specific RELEASE is required, use the -r option:

+

iocage fetch -r [11.0-RELEASE]

+

If a specific download mirror is required, use the -s option:

+

iocage fetch -s [ftp.hostname.org]

+

fetch can also pull from a specific ftp directory, using the +-d option:

+

iocage fetch -d [dir/]

+
+
+

Create a Jail

+

With a release downloaded, iocage is now able to create jails. There are +two types of jails: normal and base. More details about these +jail types can be found in the Jail Types section of this +documentation.

+

Depending on the user’s requirements, the create subcommand +can be adjusted to create either jail type. By default, +iocage create creates a normal jail, but invoking the +-b option changes the creation to the basejail type. iocage is able +to create a jail with the latest release by adding LATEST to the +create command.

+

Here is an example of creating a normal jail from the latest available +release:

+

# iocage create -r LATEST -n [JAIL]

+

This creates a normal jail that is a clone of the latest release.

+

Here is an example of creating a normal jail from the 11.0-RELEASE:

+

# iocage create -r 11.0-RELEASE

+

This normal jail is a clone of the specified RELEASE.

+

To create multiple jails, use the -c option:

+

# iocage create -r 11.0-RELEASE -c 2

+

This example shows the numeric value after the -c flag is used to +designate the number of jails to create. In the above example, two jails +are created.

+

A simple basejail is created with the -b option:

+

iocage create -b -r [RELEASE]

+

After designating the type and number of jails to create with the option +flags, specific jail properties can also be set. For example:

+

# iocage create -r 11.0-RELEASE --name myjail boot=on

+

Creates a FreeBSD 11.0-RELEASE jail with the custom name myjail and +sets the jail to start at system boot time.

+

More information about jail properties is available in the iocage(8) +FreeBSD manual page, accessible on a FreeBSD system by +typing man iocage.

+
+
+

Listing Jails

+

To list all jails, use iocage list

+

To see all downloaded RELEASEs, use iocage list -r

+

View available templates with iocage list -t

+
+
+

Start, Stop, or Restart a Jail

+

Jails can be started, stopped, or restarted at any time. By default, new +jails are in a down (stopped) state. To see the status of all jails, +use iocage list and read the STATE column.

+

Use each jail’s UUID or custom NAME to start, stop, or restart it. +Partial entries are acceptable, as long as the given characters are +enough to identify the desired jail. Alternately, use ALL to apply +the command to all created jails.

+
+

Tip

+

Partial entries can also be supplied for any other +iocage operation or subcommand.

+
+
+

Start

+

Use iocage start to start jails.

+

Examples:

+

Start a jail with the custom name www01:

+

iocage start www01.

+

If no custom NAME or UUID is provided by the user, iocage +automatically assigns a complex UUID to a new jail. This UUID is always +usable when doing iocage operations like starting a jail:

+

# iocage start 26e8e027-f00c-11e4-8f7f-3c970e80eb61

+

Partial entries are also acceptable:

+

# iocaget start www

+

# iocage start 26e8

+
+
+

Stop

+

iocage stop uses the same syntax as iocage start.

+

Examples:

+

# iocage stop www01

+

# iocage stop 26e8e027-f00c-11e4-8f7f-3c970e80eb61

+

# iocage stop 26e8

+
+
+

Restart

+

iocage restart also uses the same syntax as start and +stop:

+

# iocage restart www01

+

# iocage restart 26e8e027-f00c-11e4-8f7f-3c970e80eb61

+

# iocage restart 26e8

+
+
+
+

Configure a Jail

+

Configuring the properties of an already created jail is best done with +the set and get subcommands. Be sure to provide the NAME or UUID +of the desired jail when using these subcommands.

+
+

Set Jail Property

+

iocage uses the set subcommand to configure jail +properties.

+

To assign a custom note to a jail with the notes property:

+

# iocage set notes="This is a test jail." 26e8e027

+

The full list of jail properties is available in the iocage(8) manual +page PROPERTIES section.

+
+
+

Get Jail Property

+

To view a specific jail property, use the get subcommand:

+

# iocage get notes 26e8e027

+
+
+

Get all properties:

+

Display the full list of a jail’s properties:

+

# iocage get all 26e8e027 | more

+
+
+
+

Destroy a Jail

+

Destroy a specific jail using the destroy subcommand:

+

# iocage destroy www02

+
+

Warning

+

This irreversibly destroys the jail!

+
+
+
+

Rename a Jail

+

iocage allows jails to be renamed after creation and/or +migration. The iocage rename subcommand is used to alter an +existing jail’s UUID or NAME. Type the command, then the UUID or name of +the jail to be altered, then the desired name. This example shows using +the rename subcommand:

+

# iocage rename jail1 TESTINGJAIL

+
+
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ previous | + next | + modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/best-practices.html b/docs/best-practices.html new file mode 100644 index 00000000..4354edb5 --- /dev/null +++ b/docs/best-practices.html @@ -0,0 +1,174 @@ + + + + + + + + + Best Practices — iocage 1.9 documentation + + + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+

Best Practices

+

This section provides some generic guidelines and tips for working with +iocage managed jails.

+

Use PF as a module

+
+

This is the default setting in the GENERIC kernel. There seems to be +a VNET bug which is only triggered when PF is directly compiled into +the kernel.

+
+

Always name jails and templates!

+
+

Use the -n option with iocage create to set a name for the +jail. This helps avoid mistakes and easily identify jails.

+

Example: iocage create -r 11.0-RELEASE -n testjail

+
+

Set the notes property

+
+

Set the notes property to something meaningful, especially for +templates and jails used infrequently.

+

Example:

+
[root@tester ~]# iocage set notes="This is a test jail." testjail
+Property: notes has been updated to This is a test jail.
+
+[root@tester ~]# iocage get notes testjail
+This is a test jail.
+
+
+
+

VNET

+
+

VNET provides more fine control and isolation for jails. VNET also +allows jails to run their own firewalls. See Known Issues for +more about VNET.

+
+

Discover templates!

+
+

Templates simplify using jail creation and customization, give it a +try! See Using Templates to get started.

+
+

Use iocage restart instead of start/stop

+
+

Always restart a jail with the iocage restart -s command. +This performs a soft restart and leaves the VNET stack alone, which +is less stressful for both kernel and user.

+
+

Check the firewall rules

+
+

When using IPFW inside a VNET jail, put firewall_enable=”YES” +and firewall_type=”open” into /etc/rc.conf. This excludes +the firewall from accidentally blocking the user right from the +beginning! Re-lock it once finished testing. It is also recommended to +check the PF firewall rules on the host if jail and host rules are +mixed.

+
+

Delete old snapshots

+
+

Remove unnecessary snapshots, especially from jails where data is +constantly changing!

+
+
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ previous | + next | + modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/debian.html b/docs/debian.html new file mode 100644 index 00000000..fe36e638 --- /dev/null +++ b/docs/debian.html @@ -0,0 +1,167 @@ + + + + + + + + + Create a Debian Buster Jail (native Linux) — iocage 1.9 documentation + + + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+

Create a Debian Buster Jail (native Linux)

+

This section shows the process to set up a Debian Linux jail. +The examples in this section use a jail with the custom name +debjail. Remember to replace debjail with your jail’s UUID or +NAME!

+
+

Warning

+

This is not recommended for production use. The intention +is to show iocage can do almost anything with jails.

+
+

Create an empty jail:

+
# iocage create -e -n debjail exec_start="/bin/true" exec_stop="/bin/true"
+  allow_mount_linprocfs=1 allow_mount_devfs=1 allow_raw_sockets=1
+  allow_socket_af=1 allow_mount_linsysfs=1 allow_mount=1
+
+
+

Install devfs rules for vnet:

+

In /etc/devfs.rules:

+
[devfsrules_jail_linux=6] add include $devfsrules_hide_all
+add include $devfsrules_unhide_basic
+add include $devfsrules_unhide_login
+add path 'tun*' unhide
+add path 'bpf*' unhide
+add path zfs unhide
+
+
+

Install debootstrap on the host:

+

# pkg install debootstrap

+

Enable linux(4):

+

# sysrc linux_enable="YES" +# sysrc linux_mounts_enable="NO" +# service linux start

+

Grab the mountpoint for the empty jail, append /root/ to it, and run +debootstrap(8):

+

# iocage get mountpoint debjail

+

# debootstrap bookworm /iocage/jails/debjail/root/

+

Apart from Debian releases, like buster or testing, you can +also use Ubuntu releases, eg bionic.

+

Add lines to the jail fstab file:

+

Use iocage fstab -e [UUID | NAME] to edit the fstab +file of debjail directly. Add these lines to the file:

+
devfs    /iocage/jails/debjail/root/dev         devfs     rw          0 0
+tmpfs    /iocage/jails/debjail/root/dev/shm     tmpfs     rw,size=1g,mode=1777 0 0
+fdescfs  /iocage/jails/debjail/root/dev/fd      fdescfs   rw,linrdlnk 0 0
+linproc  /iocage/jails/debjail/root/proc        linprocfs rw          0 0
+linsys   /iocage/jails/debjail/root/sys         linsysfs  rw          0 0
+
+
+

Start the jail and attach to it:

+

# iocage start debjail

+

# iocage console debjail

+

The result is a 64-bit Debian Linux userland.

+
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ previous | + next | + modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/faq.html b/docs/faq.html new file mode 100644 index 00000000..7023d789 --- /dev/null +++ b/docs/faq.html @@ -0,0 +1,160 @@ + + + + + + + + + FAQ — iocage 1.9 documentation + + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+

FAQ

+
+
What is iocage?

iocage is a jail management program designed to simplify +jail administration tasks.

+
+
What is a jail?

A Jail is a FreeBSD OS virtualization technology allowing +users to run multiple copies of the operating system. Some operating +systems use the term Zones or Containers for OS +virtualization.

+
+
What is VNET?

VNET is an independent, per jail virtual networking stack.

+
+
How do I configure network interfaces in a VNET or shared IPjail?

Both are configured in the same way: +iocage set ip4_add="[interface]|[IP]/[netmask]" [UUID | NAME]. +For more info, please refer to the Networking section of this +documentation.

+
+
Do I need to set my default gateway?

Only if VNET is enabled. You need to assign an IP address to the +bridge where the jail interface is attached. This IP essentially +becomes the default gateway for your jail.

+
+
Can I run a firewall inside a jail?

Yes, a VNET jail supports IPFW. PF is not supported inside the +jail. However, you can still enable PF for the host. If you plan +to use IPFW inside a jail, be sure securelevel is set to +2.

+
+
Can I enable both IPFW and PF at the same time?

Yes, make sure you allow traffic on both in/out for your jails.

+
+
Can I create custom jail templates?

Yes, and thin provisioning is supported too!

+
+
What is a jail clone?

Clones are ZFS clones. These are fully writable copies of the +source jail.

+
+
Can I limit the CPU and Memory use?

Yes, but only for legacy versions of iocage. Refer to +the iocage.8 manual page or Resource Limits (Legacy ONLY) section +of this documentation for more details.

+
+
Is there a way to display resource consumption?

Yes - iocage df

+
+
Is NAT supported for jails?

Yes. NAT is built into FreeBSD. Treat your server as a core +router/firewall. Check the FreeBSD +Firewalls chapter +for more details.

+
+
Will iocage work on a generic system with no ZFS pools?

No. ZFS is a must. If you run a FreeBSD server, you should be using +ZFS!

+
+
Is ZFS jailing supported?

Yes, please refer to the iocage.8 manual page.

+
+
+
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ previous | + modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/fastentrypoints.html b/docs/fastentrypoints.html new file mode 100644 index 00000000..f1a591c6 --- /dev/null +++ b/docs/fastentrypoints.html @@ -0,0 +1,127 @@ + + + + + + + + + fastentrypoints module — iocage 1.9 documentation + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+

fastentrypoints module

+

Monkey patch setuptools to write faster console_scripts with this format:

+
+

import sys +from mymodule import entry_function +sys.exit(entry_function())

+
+

This is better.

+

(c) 2016, Aaron Christianson +http://github.com/ninjaaron/fast-entry_points

+
+
+fastentrypoints.get_args()
+

Yield write_script() argument tuples for a distribution’s +console_scripts and gui_scripts entry points.

+
+ +
+
+fastentrypoints.main()
+
+ +
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/genindex.html b/docs/genindex.html new file mode 100644 index 00000000..d57745e7 --- /dev/null +++ b/docs/genindex.html @@ -0,0 +1,1357 @@ + + + + + + + + Index — iocage 1.9 documentation + + + + + + + + + + + + + +
+
+
+ +
+
+
+ + +

Index

+ +
+ A + | B + | C + | D + | E + | F + | G + | I + | J + | K + | L + | M + | N + | O + | P + | R + | S + | T + | U + | V + +
+

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + + +
+ +

F

+ + + +
+ +

G

+ + + +
+ +

I

+ + + +
+ +

J

+ + + +
+ +

K

+ + +
+ +

L

+ + + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ +

V

+ + + +
+ + + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 00000000..40af13b5 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,202 @@ + + + + + + + + + iocage - A FreeBSD Jail Manager — iocage 1.9 documentation + + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+

iocage - A FreeBSD Jail Manager

+

iocage is a jail/container manager written in Python, combining +some of the best features and technologies the FreeBSD operating system +has to offer. It is geared for ease of use with a simplistic and easy to +learn command syntax.

+

FEATURES:

+
    +

  • Templates, basejails, and normal jails

    • +

  • Easy to use

    • +

  • Rapid thin provisioning within seconds

    • +

  • Automatic package installation

    • +

  • Virtual networking stacks (vnet)

    • +

  • Shared IP based jails (non vnet)

    • +

  • Dedicated ZFS datasets inside jails

    • +

  • Transparent ZFS snapshot management

    • +

  • Binary updates

    • +

  • Export and import

    • +

  • And many more!

    • +
+
+

Documentation:

+
+ +
+
+

Indices and tables

+
+
+
+
+
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ next | + modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/install.html b/docs/install.html new file mode 100644 index 00000000..1dcb7a1a --- /dev/null +++ b/docs/install.html @@ -0,0 +1,279 @@ + + + + + + + + + Install iocage — iocage 1.9 documentation + + + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+

Install iocage

+

iocage is a jail and container manager merging some of the best features +and technologies from the FreeBSD operating system. It is geared for +ease of use with simple command syntax. Visit the +iocage github for more information.

+
+

Using binary packages

+

To install using binary packages on a FreeBSD system, run:

+

sudo pkg install py38-iocage

+
+
+

Using github

+

If installing from github, the FreeBSD source tree must be located +at $SRC_BASE ( /usr/src by default).

+

To install from github, run these commands:

+

pkg install python38 git-lite py38-cython py38-libzfs py38-pip

+

git clone https://github.com/iocage/iocage

+

make install as root.

+
+

Tip

+

To install subsequent updates run: make install as +root.

+
+
+
+

Using pkg(8)

+

It is possible to install pre-build packages using pkg(8) if using +FreeBSD 10 or above.

+

To install using pkg(8), run:

+

sudo pkg install py38-iocage

+
+
+

Building Ports

+

iocage is in the FreeBSD ports tree as sysutils/py-iocage.

+

Build the ports: +cd /usr/ports/sysutils/iocage/ ; make install clean

+
+
+

Upgrading from iocage_legacy

+

This repository replaces iocage_legacy . +To upgrade to the current version:

+
    +

  1. Stop the jails ( Service iocage stop; iocage stop ALL)

    2. +

  2. Back up your data.

    3. +

  3. Remove the old iocage package if it is installed +( pkg delete iocage)

    4. +

  4. Install iocage using one of the methods above.

    5. +

  5. Migrate the jails by running iocage list as root.

    6. +

  6. Start the jails ( service iocage onestart).

    7. +
+
+
+

Migrating from Ezjail to Iocage

+

Assumptions:

+
    +

  • ezjail jails are located at /usr/jails

    • +

  • iocage jails are located at /iocage/jails

    • +
+
+

Create Target

+

Create an empty jail in iocage to act as the target for the migration. +The release and networking information will be updated with information +from ezjail.

+
iocage create -e -n NewJail
+
+
+
+
+

Copy Old Data

+

Before data can be copied, another symlink must be created in the root +directory. Ezjail relies on symlinks to utlilize the basejail system, +however when looking in an existing jail, it’s symlinked to the root.

+
% ls -ls /usr/jails/OldJail/bin
+1 lrwxr-xr-x  1 root  wheel  13 Feb 22  2017 /usr/jails/OldJail/bin@ -> /basejail/bin
+
+
+

This would work fine from within a running jail, but on the host +filesystem this link doesn’t currently exist. Because of this, create a +symlink from the basejail to the root filesystem of the jail host.

+
ln -s /usr/jails/basejail /basejail
+
+
+

Now that the link exists, copy the data from the ezjail jail directory +to the iocage jail directory.

+
rsync -a --copy-links /usr/jails/OldJail/ /iocage/jails/NewJail/root/
+
+
+
+
+

Populate iocage config.json

+

There are 2 main parts from ezjail that need to be copied into the +iocage config:

+
    +

  • release information

    • +

  • IP address

    • +
+
+

Release

+

The release info can be found in the old basejail files via the +freebsd-update executable.

+
$ grep USERLAND_VERSION= /usr/jails/basejail/bin/freebsd-version
+USERLAND_VERSION="11.1-RELEASE-p6"
+
+
+

This value goes into the “release” line of config.json

+
"release": "11.1-RELEASE-p6",
+
+
+
+
+

IP Address

+

The IP addresses used in an ezjail jail are found in +/usr/local/etc/ezjail/OldJail

+
$ grep ip= /usr/local/etc/ezjail/OldJail
+export jail_OldJail_ip="em0|192.168.1.10"
+
+
+

This goes into the “ip4_addr” line of config.json

+
"ip4_addr": "em0|192.168.1.10/24",
+
+
+

Remember to append the subnet mask when adding network info to the +iocage config.

+
+
+

Start the New Jail

+

Make sure the old jail is shut down so there won’t be any IP conflicts.

+
ezjail-admin stop OldJail
+
+
+

Start the new jail with iocage

+
iocage start NewJail
+
+
+
+
+

(Optional) Update fstab

+

If there are other mounts in use in ezjail, these can be easily copied +into iocage as well.

+

Ezjail fstab entries are located at /etc/fstab.OldJail on the host.

+
$ cat /etc/fstab.OldJail
+/usr/jails/basejail /usr/jails/OldJail/basejail   nullfs   ro   0   0
+/path/on/host /usr/jails/OldJail/path/in/jail   nullfs   rw   0   0
+
+
+

The basejail line isn’t needed in iocage if using the default jail type, +but the remaining entries need to be updated.

+

Edit the fstab for the iocage jail and change the paths of the +mountpoint.

+
$ cat /iocage/jails/NewJail/fstab
+/path/on/host /iocage/jails/NewJail/root/path/in/jail   nullfs   rw   0   0
+
+
+
+
+
+
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ previous | + next | + modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/iocage_cli.html b/docs/iocage_cli.html new file mode 100644 index 00000000..e332ac59 --- /dev/null +++ b/docs/iocage_cli.html @@ -0,0 +1,305 @@ + + + + + + + + + iocage_cli package — iocage 1.9 documentation + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+

iocage_cli package

+
+

Submodules

+
+
+

iocage_cli.activate module

+

activate module for the cli.

+
+
+

iocage_cli.chroot module

+

chroot module for the cli.

+
+
+

iocage_cli.clean module

+

clean module for the cli.

+
+
+

iocage_cli.clone module

+

clone module for the cli.

+
+
+iocage_cli.clone.validate_count(ctx, param, value)
+

Takes a string, removes the commas and returns an int.

+
+ +
+
+

iocage_cli.console module

+

console module for the cli.

+
+
+

iocage_cli.create module

+

create module for the cli.

+
+
+iocage_cli.create.validate_count(ctx, param, value)
+

Takes a string, removes the commas and returns an int.

+
+ +
+
+

iocage_cli.debug module

+

debug module for the cli.

+
+
+

iocage_cli.destroy module

+

destroy module for the cli.

+
+
+iocage_cli.destroy.child_test(iocroot, name, _type, force=False, recursive=False)
+

Tests for dependent children

+
+ +
+
+

iocage_cli.df module

+

df module for the cli.

+
+
+

iocage_cli.exec module

+

exec module for the cli.

+
+
+

iocage_cli.export module

+

export module for the cli.

+
+
+

iocage_cli.fetch module

+

fetch module for the cli.

+
+
+iocage_cli.fetch.validate_count(ctx, param, value)
+

Takes a string, removes the commas and returns an int.

+
+ +
+
+

iocage_cli.fstab module

+

fstab module for the cli.

+
+
+

iocage_cli.get module

+

get module for the cli.

+
+
+

iocage_cli.import module

+

import module for the cli.

+
+
+

iocage_cli.list module

+

list module for the cli.

+
+
+

iocage_cli.migrate module

+

migrate module for the cli.

+
+
+

iocage_cli.pkg module

+

pkg module for the cli.

+
+
+

iocage_cli.rename module

+

rename module for the cli.

+
+
+

iocage_cli.restart module

+

restart module for the cli.

+
+
+

iocage_cli.rollback module

+

rollback module for the cli.

+
+
+

iocage_cli.set module

+

set module for the cli.

+
+
+

iocage_cli.snaplist module

+

snaplist module for the cli.

+
+
+

iocage_cli.snapremove module

+

snapremove module for the cli.

+
+
+

iocage_cli.snapshot module

+

snapshot module for the cli.

+
+
+

iocage_cli.start module

+

start module for the cli.

+
+
+

iocage_cli.stop module

+

stop module for the cli.

+
+
+

iocage_cli.update module

+

update module for the cli.

+
+
+

iocage_cli.upgrade module

+

upgrade module for the cli.

+
+
+

Module contents

+

The main CLI for ioc.

+
+
+class iocage_cli.IOCLogger
+

Bases: object

+
+
+setConsoleLogLevel(level)
+
+ +
+ +
+
+class iocage_cli.IOCageCLI(name: Optional[str] = None, invoke_without_command: bool = False, no_args_is_help: Optional[bool] = None, subcommand_metavar: Optional[str] = None, chain: bool = False, result_callback: Optional[Callable[[...], Any]] = None, **attrs: Any)
+

Bases: MultiCommand

+

Iterates in the ‘cli’ directory and will load any module’s cli definition.

+
+
+get_command(ctx, name)
+

Given a context and a command name, this returns a +Command object if it exists or returns None.

+
+ +
+
+list_commands(ctx)
+

Returns a list of subcommand names in the order they should +appear.

+
+ +
+ +
+
+class iocage_cli.InfoHandler(level=0)
+

Bases: Handler

+
+
+emit(record)
+

Do whatever it takes to actually log the specified logging record.

+

This version is intended to be implemented by subclasses and so +raises a NotImplementedError.

+
+ +
+ +
+
+iocage_cli.print_version(ctx, param, value)
+

Prints the version and then exits.

+
+ +
+
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/iocage_lib.html b/docs/iocage_lib.html new file mode 100644 index 00000000..914baf0a --- /dev/null +++ b/docs/iocage_lib.html @@ -0,0 +1,1634 @@ + + + + + + + + + iocage_lib package — iocage 1.9 documentation + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+

iocage_lib package

+
+

Submodules

+
+
+

iocage_lib.ioc_check module

+

Check datasets before execution

+
+
+class iocage_lib.ioc_check.IOCCheck(silent=False, callback=None, migrate=False, reset_cache=False)
+

Bases: object

+

Checks if the required iocage datasets are present

+
+ +
+
+

iocage_lib.ioc_clean module

+

Destroy all of a dataset type.

+
+
+class iocage_lib.ioc_clean.IOCClean(callback=None, silent=False)
+

Bases: object

+

Cleans datasets and snapshots of a given type.

+
+
+clean_all()
+

Cleans everything related to iocage.

+
+ +
+
+clean_debug()
+

Removes the debug directory

+
+ +
+
+clean_images()
+

Destroys the images dataset

+
+ +
+
+clean_jails()
+

Cleans all jails and their respective snapshots.

+
+ +
+
+clean_releases()
+

Cleans all releases and the jails created from them.

+
+ +
+
+clean_templates()
+

Cleans all templates and their respective children.

+
+ +
+ +
+
+

iocage_lib.ioc_common module

+

Common methods we reuse.

+
+
+iocage_lib.ioc_common.boolean_prop_exists(supplied_props, props_to_check)
+
+ +
+
+iocage_lib.ioc_common.callback(_log, callback_exception)
+

Helper to call the appropriate logging level

+
+ +
+
+iocage_lib.ioc_common.check_release_newer(release, callback=None, silent=False, raise_error=True, major_only=False)
+

Checks if the host RELEASE is greater than the target release

+
+ +
+
+iocage_lib.ioc_common.check_truthy(value)
+

Checks if the given value is ‘True’

+
+ +
+
+iocage_lib.ioc_common.checkoutput(*args, **kwargs)
+

Just a wrapper to return utf-8 from check_output

+
+ +
+
+iocage_lib.ioc_common.construct_truthy(item, inverse=False)
+

Will return an iterable with all truthy variations

+
+ +
+
+iocage_lib.ioc_common.consume_and_log(exec_gen, log=True, callback=None)
+

Consume a generator and massage the output with lines

+
+ +
+
+iocage_lib.ioc_common.copytree(src, dst, symlinks=False, ignore=None)
+

Copies a tree and overwrites.

+
+ +
+
+iocage_lib.ioc_common.gen_nat_ip(ip_prefix)
+

Best effort to try to allocate a private NAT IP for a jail

+
+ +
+
+iocage_lib.ioc_common.gen_unused_lo_ip()
+

Best effort to try to allocate a localhost IP for a jail

+
+ +
+
+iocage_lib.ioc_common.generate_devfs_ruleset(conf, paths=None, includes=None, callback=None, silent=False)
+

Will add a per jail devfs ruleset with the specified rules, +specifying defaults that equal devfs_ruleset 4

+
+ +
+
+iocage_lib.ioc_common.get_active_jails()
+
+ +
+
+iocage_lib.ioc_common.get_host_gateways()
+
+ +
+
+iocage_lib.ioc_common.get_host_release()
+

Helper to return the hosts sanitized RELEASE

+
+ +
+
+iocage_lib.ioc_common.get_jail_freebsd_version(path, release)
+

Checks the current patch level for the jail

+
+ +
+
+iocage_lib.ioc_common.get_jails_with_config(filters=None, mapping_func=None)
+
+ +
+
+iocage_lib.ioc_common.get_name_sortkey(name)
+
+ +
+
+iocage_lib.ioc_common.get_natural_sortkey(text)
+
+ +
+
+iocage_lib.ioc_common.get_nested_key(_dict, keys=None)
+

Gets a nested key from a dictionary.

+
+ +
+
+iocage_lib.ioc_common.get_size_sortkey(size)
+
+ +
+
+iocage_lib.ioc_common.get_used_ips()
+

Run ifconfig in every jail and return an iteratable of the inuse addresses

+
+ +
+
+iocage_lib.ioc_common.ioc_sort(caller, s_type, data=None)
+
+ +
+
+iocage_lib.ioc_common.logit(content, _callback=None, silent=False, exception=<class 'RuntimeError'>)
+

Helper to check callable status of callback or call ours.

+
+ +
+
+iocage_lib.ioc_common.lowercase_set(values)
+
+ +
+
+iocage_lib.ioc_common.match_to_dir(iocroot, uuid, old_uuid=None)
+

Checks for existence of jail/template with specified uuid. +Replaces dots and underscores in the uuid with pattern [._] and returns +the template- or jail directory that matches, or returns None if no match +was found. +Background: jail(8) doesn’t allow dots in the name, they will be replaced +with underscores. Because of this, foo.bar and foo_bar will be considered +identical, as they cannot coexist.

+
+ +
+
+iocage_lib.ioc_common.open_atomic(filepath, *args, **kwargs)
+

Open temporary file object that atomically moves to destination upon +exiting.

+

Allows reading and writing to and from the same filename.

+

The file will not be moved to destination in case of an exception.

+
+

Parameters

+
+
filepathstring

the file path to be opened

+
+
fsyncbool

whether to force write the file to disk

+
+
*argsmixed

Any valid arguments for open

+
+
**kwargsmixed

Any valid keyword arguments for open

+
+
+
+
+ +
+
+iocage_lib.ioc_common.parse_latest_release()
+

Returns the latest RELEASE from upstreams supported list

+
+ +
+
+iocage_lib.ioc_common.parse_package_name(pkg)
+
+ +
+
+iocage_lib.ioc_common.raise_sort_error(sort_list)
+
+ +
+
+iocage_lib.ioc_common.retrieve_admin_portals(conf, jail_running, admin_portal, default_gateways=None, full_ipv4_dict=None)
+
+ +
+
+iocage_lib.ioc_common.retrieve_ip4_for_jail(conf, jail_running)
+
+ +
+
+iocage_lib.ioc_common.runscript(script, custom_env=None)
+

Runs the script provided and return a tuple with first value showing +stdout and last showing stderr

+
+ +
+
+iocage_lib.ioc_common.set_interactive(interactive)
+

Returns True or False if stdout is a tty

+
+ +
+
+iocage_lib.ioc_common.set_rcconf(jail_path, key, value)
+
+ +
+
+iocage_lib.ioc_common.sort_ava(ava)
+

Sort df by AVA

+
+ +
+
+iocage_lib.ioc_common.sort_boot(boot)
+

Sort the list by boot, then by name.

+
+ +
+
+iocage_lib.ioc_common.sort_created(crt)
+

Sort snaplist by CREATED

+
+ +
+
+iocage_lib.ioc_common.sort_crt(crt)
+

Sort df by CRT

+
+ +
+
+iocage_lib.ioc_common.sort_ip(sort_row, version='4')
+

Sort the list by IP address +We expect the following values for ip sorting +1) interface|ip/subnet +2) interface|ip +3) interface|dhcp +4) ip +5) ip|accept_rtadv

+

All the while obviously not forgetting that there can be multiple +ips specified by ‘,’ delimiter

+
+ +
+
+iocage_lib.ioc_common.sort_ip6(ip)
+

Helper for sort_ip

+
+ +
+
+iocage_lib.ioc_common.sort_jid(jid)
+

Sort the list by JID.

+
+ +
+
+iocage_lib.ioc_common.sort_key(item)
+

Sort list by the first key.

+
+ +
+
+iocage_lib.ioc_common.sort_name(name)
+

Sort list by the name.

+
+ +
+
+iocage_lib.ioc_common.sort_qta(qta)
+

Sort df by QTA or snaplist by USED

+
+ +
+
+iocage_lib.ioc_common.sort_release(releases, split=False, fetch_releases=False)
+

Sort the list by RELEASE, if split is true it’s expecting full +datasets.

+
+ +
+
+iocage_lib.ioc_common.sort_res(res)
+

Sort df by RES or snaplist by RSIZE

+
+ +
+
+iocage_lib.ioc_common.sort_state(state)
+

Sort the list by state, then by name.

+
+ +
+
+iocage_lib.ioc_common.sort_template(template)
+

Helper function for templates to be sorted in sort_name

+
+ +
+
+iocage_lib.ioc_common.sort_type(jail_type)
+

Sort the list by jail type, then by name.

+
+ +
+
+iocage_lib.ioc_common.sort_use(use)
+

Sort df by USE

+
+ +
+
+iocage_lib.ioc_common.tempfile(suffix='', dir=None)
+

Context for temporary file.

+

Will find a free temporary filename upon entering +and will try to delete the file on leaving, even in case of an exception.

+
+

Parameters

+
+
suffixstring

optional file suffix

+
+
dirstring

optional directory to save temporary file in

+
+
+
+
+ +
+
+iocage_lib.ioc_common.tmp_dataset_checks(_callback, silent)
+
+ +
+
+iocage_lib.ioc_common.truthy_inverse_values()
+
+ +
+
+iocage_lib.ioc_common.truthy_values()
+
+ +
+
+iocage_lib.ioc_common.try_convert(value, default, *types)
+
+ +
+
+iocage_lib.ioc_common.validate_plugin_manifest(manifest, _callback, silent)
+
+ +
+
+

iocage_lib.ioc_create module

+

iocage create module.

+
+
+class iocage_lib.ioc_create.IOCCreate(release, props, num, pkglist=None, plugin=False, migrate=False, config=None, silent=False, template=False, short=False, basejail=False, thickjail=False, empty=False, uuid=None, clone=False, thickconfig=False, clone_basejail=False, callback=None)
+

Bases: object

+

Create a jail from a clone.

+
+
+create_config(jail_uuid, release, source_template)
+

Create the jail configuration with the minimal needed defaults. +If self.thickconfig is True, it will create a jail with all properties.

+
+ +
+
+create_install_packages(jail_uuid, location, repo='pkg.freebsd.org')
+

Takes a list of pkg’s to install into the target jail. The resolver +property is required for pkg to have network access.

+
+ +
+
+create_jail()
+

Helper to catch SIGINT

+
+ +
+
+create_rc(location, host_hostname, basejail=0)
+
+
Writes a boilerplate rc.conf file for a jail if it doesn’t exist,

otherwise changes the hostname.

+
+
+
+ +
+
+create_thickjail(jail_uuid, source)
+
+ +
+ +
+
+

iocage_lib.ioc_debug module

+

This collects debug about all the iocage jails.

+
+
+class iocage_lib.ioc_debug.IOCDebug(path, silent=False, callback=None)
+

Bases: object

+
+
Collects the following debug for a system + jails/templates:

zfs list +mount +df -h

+

iocage get all +/etc/hosts +/etc/rc.conf +/etc/nsswitch.conf +ifconfig -a +netstat -nr +/etc/resolv.conf

+
+
+
+
+run_debug()
+
+ +
+
+run_host_debug()
+
+ +
+
+run_jail_debug(name, path)
+
+ +
+ +
+
+

iocage_lib.ioc_destroy module

+

iocage destroy module.

+
+
+class iocage_lib.ioc_destroy.IOCDestroy(callback=None)
+

Bases: object

+

Destroy a jail’s datasets and then if they have a RELEASE snapshot, +destroy that as well.

+
+
+destroy_jail(path, clean=False)
+
+
A convenience wrapper to call __stop_jails__ and

__destroy_parse_datasets__

+
+
+
+ +
+ +
+
+

iocage_lib.ioc_exceptions module

+

Exception classes for iocage

+
+
+exception iocage_lib.ioc_exceptions.CommandFailed(message)
+

Bases: ExceptionWithMsg

+
+ +
+
+exception iocage_lib.ioc_exceptions.CommandNeedsRoot(message)
+

Bases: ExceptionWithMsg

+
+ +
+
+exception iocage_lib.ioc_exceptions.ExceptionWithMsg(message)
+

Bases: Exception

+

message attribute will be an iterable if a message is supplied

+
+ +
+
+exception iocage_lib.ioc_exceptions.Exists(message)
+

Bases: ExceptionWithMsg

+
+ +
+
+exception iocage_lib.ioc_exceptions.JailCorruptConfiguration(message)
+

Bases: JailMisconfigured

+
+ +
+
+exception iocage_lib.ioc_exceptions.JailMisconfigured(message)
+

Bases: ExceptionWithMsg

+
+ +
+
+exception iocage_lib.ioc_exceptions.JailMissingConfiguration(message)
+

Bases: JailMisconfigured

+
+ +
+
+exception iocage_lib.ioc_exceptions.JailRunning
+

Bases: Exception

+
+ +
+
+exception iocage_lib.ioc_exceptions.PoolNotActivated
+

Bases: Exception

+
+ +
+
+exception iocage_lib.ioc_exceptions.ValidationFailed(message)
+

Bases: ExceptionWithMsg

+
+ +
+
+exception iocage_lib.ioc_exceptions.ValueNotFound
+

Bases: Exception

+
+ +
+
+iocage_lib.ioc_exceptions.ignore_exceptions(*exceptions, clean=None, suppress_exception=True)
+

Ignore any exceptions specified by exceptions and make sure that +we clean any resources specified by callable clean

+
+ +
+
+

iocage_lib.ioc_exec module

+

iocage exec module.

+
+
+class iocage_lib.ioc_exec.IOCExec(command, path, uuid='', host_user='root', jail_user=None, plugin=False, unjailed=False, skip=False, stdin_bytestring=None, su_env=None, decode=False, callback=None)
+

Bases: object

+

Run jexec with a user inside the specified jail.

+
+
+exec_jail()
+
+ +
+
+flight_checks()
+
+ +
+ +
+
+class iocage_lib.ioc_exec.InteractiveExec(*args, **kwargs)
+

Bases: IOCExec

+
+ +
+
+class iocage_lib.ioc_exec.SilentExec(*args, **kwargs)
+

Bases: object

+
+ +
+
+

iocage_lib.ioc_fetch module

+

iocage fetch module.

+
+
+class iocage_lib.ioc_fetch.IOCFetch(release, server='download.freebsd.org', user='anonymous', password='anonymous@', auth=None, root_dir=None, http=True, _file=False, verify=True, hardened=False, update=True, eol=True, files=('MANIFEST', 'base.txz', 'lib32.txz', 'src.txz'), silent=False, callback=None)
+

Bases: object

+

Fetch a RELEASE for use as a jail base.

+
+
+fetch_download(_list, missing=False)
+

Creates the download dataset and then downloads the RELEASE.

+
+ +
+
+fetch_extract(f)
+

Takes a src and dest then creates the RELEASE dataset for the data.

+
+ +
+
+fetch_http_release(eol, _list=False)
+

Fetch a user specified RELEASE from FreeBSD’s http server or a user +supplied one. The user can also specify the user, password and +root-directory containing the release tree that looks like so:

+
+
    +

  • XX.X-RELEASE

    • +

  • XX.X-RELEASE

    • +

  • XX.X-RELEASE

    • +
+
+
+ +
+
+fetch_release(_list=False)
+

Small wrapper to choose the right fetch.

+
+ +
+
+fetch_update(cli=False, uuid=None)
+

This calls ‘freebsd-update’ to update the fetched RELEASE.

+
+ +
+
+update_progress(progress, display_text, elapsed, chunk_size)
+

Displays or updates a console progress bar. +Original source: https://stackoverflow.com/a/15860757/1391441

+
+ +
+ +
+
+

iocage_lib.ioc_fstab module

+

Manipulate a jails fstab

+
+
+class iocage_lib.ioc_fstab.Fstab
+

Bases: Structure

+
+
+fs_file
+

Structure/Union member

+
+ +
+
+fs_freq
+

Structure/Union member

+
+ +
+
+fs_mntops
+

Structure/Union member

+
+ +
+
+fs_passno
+

Structure/Union member

+
+ +
+
+fs_spec
+

Structure/Union member

+
+ +
+
+fs_type
+

Structure/Union member

+
+ +
+
+fs_vfstype
+

Structure/Union member

+
+ +
+ +
+
+class iocage_lib.ioc_fstab.IOCFstab(uuid, action, source='', destination='', fstype='', fsoptions='', fsdump='', fspass='', index=None, silent=False, callback=None, header=False)
+

Bases: object

+

Will add or remove an entry, and mount or umount the filesystem.

+
+
+fstab_list()
+

Returns list of lists, or a table

+
+ +
+ +
+
+

iocage_lib.ioc_image module

+

iocage export and import module

+
+
+class iocage_lib.ioc_image.IOCImage(callback=None, silent=False)
+

Bases: object

+

export() and import()

+
+
+export_jail(uuid, path, compression_algo='zip')
+

Make a recursive snapshot of the jail and export to a file.

+
+ +
+
+import_jail(jail, compression_algo=None, path=None)
+

Import from an iocage export.

+
+ +
+ +
+
+

iocage_lib.ioc_json module

+

Convert, load or write JSON.

+
+
+class iocage_lib.ioc_json.IOCConfiguration(location, checking_datasets, silent, callback)
+

Bases: object

+
+
+backup_iocage_jail_conf(location)
+
+ +
+
+check_config(conf, default=False)
+

Takes JSON as input and checks to see what is missing and adds the +new keys to the defaults with their default values if missing.

+
+ +
+
+check_default_config()
+

This sets up the default configuration for jails.

+
+ +
+
+check_jail_config(conf)
+

Checks the jails configuration and migrates anything needed

+
+ +
+
+fix_properties(conf)
+

Takes a conf file and makes sure any property that has a bad value +that was previously allowed is fixed to the correct equivalent, but +aren’t a CONFIG_VERSION bump

+

Returns a bool if it updated anything and it needs writing

+
+ +
+
+static get_mac_prefix()
+
+ +
+
+get_pool_and_iocroot()
+

For internal getting of pool and iocroot.

+
+ +
+
+static get_version()
+

Sets the iocage configuration version.

+
+ +
+
+json_write(data, _file='/config.json', defaults=False)
+

Write a JSON file at the location given with supplied data.

+
+ +
+
+static retrieve_default_props()
+
+ +
+
+static validate_mac_prefix(mac_prefix)
+
+ +
+ +
+
+class iocage_lib.ioc_json.IOCCpuset(name)
+

Bases: object

+
+
+static retrieve_cpu_sets()
+
+ +
+
+set_cpuset(value=None)
+
+ +
+
+static validate_cpuset_prop(value, raise_error=True)
+
+ +
+ +
+
+class iocage_lib.ioc_json.IOCJson(location='', silent=False, cli=False, stop=False, checking_datasets=False, suppress_log=False, callback=None)
+

Bases: IOCConfiguration

+

Migrates old iocage configurations(UCL and ZFS Props) to the new JSON +format, will set and get properties.

+
+
+default_only_props = ['nat_prefix', 'nat_interface', 'nat_backend']
+
+ +
+
+get_full_config()
+
+ +
+
+json_check_prop(key, value, conf, default=False)
+

Checks if the property matches known good values, if it’s the +CLI, deny setting any properties not in this list.

+
+ +
+
+json_convert_from_ucl()
+

Convert to JSON. Accepts a location to the ucl configuration.

+
+ +
+
+json_convert_from_zfs(uuid, skip=False)
+

Convert to JSON. Accepts a jail UUID

+
+ +
+
+json_get_value(prop, default=False)
+

Returns a string with the specified prop’s value.

+
+ +
+
+json_load()
+

Load the JSON at the location given. Returns a JSON object.

+
+ +
+
+json_migrate_uuid_to_tag(uuid, tag, state, conf)
+

This will migrate an old uuid + tag jail to a tag only one

+
+ +
+
+json_plugin_get_value(prop)
+
+ +
+
+json_plugin_load()
+
+ +
+
+json_plugin_set_value(prop)
+
+ +
+
+json_set_value(prop, _import=False, default=False)
+

Set a property for the specified jail.

+
+ +
+
+truthy_props = ['bpf', 'template', 'host_time', 'basejail', 'dhcp', 'vnet', 'rtsold', 'jail_zfs', 'hostid_strict_check', 'boot', 'exec_clean', 'mount_linprocfs', 'mount_procfs', 'allow_vmm', 'allow_tun', 'allow_socket_af', 'allow_quotas', 'allow_mount_zfs', 'allow_mount_tmpfs', 'allow_mount_procfs', 'allow_mount_nullfs', 'allow_mount_fusefs', 'allow_mount_devfs', 'allow_mount_fdescfs', 'allow_mount_linprocfs', 'allow_mount_linsysfs', 'allow_mount', 'allow_mlock', 'allow_chflags', 'allow_raw_sockets', 'allow_sysvipc', 'allow_set_hostname', 'allow_nfsd', 'mount_fdescfs', 'mount_devfs', 'ip6_saddrsel', 'ip4_saddrsel', 'ip_hostname', 'assign_localhost', 'nat']
+
+ +
+ +
+
+class iocage_lib.ioc_json.IOCRCTL(name)
+

Bases: object

+
+
+rctl_rules_exist(prop=None)
+
+ +
+
+remove_rctl_rules(props=None)
+
+ +
+
+set_rctl_rules(props)
+
+ +
+
+types = {'coredumpsize', 'cputime', 'datasize', 'maxproc', 'memorylocked', 'memoryuse', 'msgqqueued', 'msgqsize', 'nmsgq', 'nsem', 'nsemop', 'nshm', 'nthr', 'openfiles', 'pcpu', 'pseudoterminals', 'readbps', 'readiops', 'shmsize', 'stacksize', 'swapuse', 'vmemoryuse', 'wallclock', 'writebps', 'writeiops'}
+
+ +
+
+static validate_rctl_props(prop, value)
+
+ +
+
+static validate_rctl_tunable()
+
+ +
+ +
+
+class iocage_lib.ioc_json.JailRuntimeConfiguration(jail_name, data=None)
+

Bases: object

+
+
+normalize_data(data)
+
+ +
+
+property path
+
+ +
+
+remove(key)
+
+ +
+
+set(key, value=None)
+
+ +
+
+sync_changes()
+
+ +
+ +
+
+

iocage_lib.ioc_list module

+

List all datasets by type

+
+
+class iocage_lib.ioc_list.IOCList(lst_type='all', hdr=True, full=False, _sort=None, silent=False, callback=None, plugin=False, quick=False, **kwargs)
+

Bases: object

+

List jails that are a specified type.

+
+
Format is:

JID UID BOOT STATE TYPE IP4 RELEASE

+
+
+
+
+list_all(jails)
+

List all jails.

+
+ +
+
+list_all_quick(jails)
+

Returns a table of jails with minimal processing

+
+ +
+
+list_bases(datasets)
+

Lists all bases.

+
+ +
+
+list_datasets()
+

Lists the datasets of given type.

+
+ +
+
+classmethod list_get_jid(uuid)
+

Return a tuple containing True or False and the jail’s id or ‘-‘.

+
+ +
+ +
+
+

iocage_lib.ioc_plugin module

+

iocage plugin module

+
+
+class iocage_lib.ioc_plugin.IOCPlugin(release=None, jail=None, plugin=None, branch=None, keep_jail_on_failure=False, callback=None, silent=False, **kwargs)
+

Bases: object

+

This is responsible for the general life cycle of a plugin jail. This +includes creation, updating and upgrading.

+
+
+DEFAULT_PROPS = {'boot': 1, 'vnet': 1}
+
+ +
+
+PLUGIN_VERSION = '2'
+
+ +
+
+static expand_abi_with_specified_release(packagesite, release)
+
+ +
+
+fetch_plugin(props, num, accept_license)
+

Helper to fetch plugins

+
+ +
+
+fetch_plugin_index(props, _list=False, list_header=False, list_long=False, accept_license=False, icon=False, official=False, index_only=False)
+
+ +
+
+static fetch_plugin_packagesites(package_sites)
+
+ +
+
+fetch_plugin_versions()
+
+ +
+
+static fetch_plugin_versions_from_plugin_index(plugins_index)
+
+ +
+
+pull_clone_git_repo(depth=None)
+
+ +
+
+static retrieve_plugin_index_data(plugin_index_path, expand_abi=True)
+
+ +
+
+retrieve_plugin_json()
+
+ +
+
+start_rc()
+
+ +
+
+stop_rc()
+
+ +
+
+update(jid)
+
+ +
+
+upgrade(jid)
+
+ +
+ +
+
+

iocage_lib.ioc_start module

+

This is responsible for starting jails.

+
+
+class iocage_lib.ioc_start.IOCStart(uuid, path, silent=False, callback=None, is_depend=False, unit_test=False, suppress_exception=False, used_ports=None)
+

Bases: object

+

Starts jails, the network stack for the jail and generates a resolv file

+

for them. It also finds any scripts the user supplies for exec_*

+
+
+check_aliases(ip_addrs, mode='4')
+

Check if the alias already exists for given IP’s, otherwise add +default interface to the ips and return the new list

+
+ +
+
+find_bridge_mtu(bridge)
+
+ +
+
+get_bridge_members(bridge)
+
+ +
+
+get_default_gateway(address_family='ipv4')
+
+ +
+
+get_default_interface()
+
+ +
+
+start_copy_localtime()
+
+ +
+
+start_generate_resolv()
+
+ +
+
+start_network(vnet, nat=False)
+

This function is largely a check to see if VNET is true, and then to +actually run the correct function, otherwise it passes.

+
+
Parameters:
+

vnet – Boolean

+
+
+
+ +
+
+start_network_interface_vnet(nic_defs, net_configs, jid, nat_addr=0)
+

Start VNET on interface

+
+
Parameters:
+
    +

  • nic_defs – comma separated interface definitions (nic, bridge)

    • +

  • net_configs – Tuple of IP address and router pairs

    • +

  • jid – The jails ID

    • +
+
+
+
+ +
+
+start_network_vnet_addr(iface, ip, defaultgw, ipv6=False)
+

Add an IP address to a vnet interface inside the jail.

+
+
Parameters:
+
    +

  • iface – The interface to use

    • +

  • ip – The IP address to assign

    • +

  • defaultgw – The gateway IP to assign to the nic

    • +
+
+
Returns:
+

If an error occurs it returns the error. Otherwise, it’s None

+
+
+
+ +
+
+start_network_vnet_iface(nic, bridge, mtu, jid, nat_addr=0)
+

The real meat and potatoes for starting a VNET interface.

+
+
Parameters:
+
    +

  • nic – The network interface to assign the IP in the jail

    • +

  • bridge – The bridge to attach the VNET interface

    • +

  • mtu – The mtu of the VNET interface

    • +

  • jid – The jails ID

    • +
+
+
Returns:
+

If an error occurs it returns the error. Otherwise, it’s None

+
+
+
+ +
+ +
+
+

iocage_lib.ioc_stop module

+

This stops jails.

+
+
+class iocage_lib.ioc_stop.IOCStop(uuid, path, silent=False, callback=None, force=False, suppress_exception=False)
+

Bases: object

+

Stops a jail and unmounts the jails mountpoints.

+
+ +
+
+

iocage_lib.ioc_upgrade module

+

iocage upgrade module

+
+
+class iocage_lib.ioc_upgrade.IOCUpgrade(new_release, path, interactive=True, silent=False, callback=None)
+

Bases: object

+

Will upgrade a jail to the specified RELEASE.

+
+
+upgrade_basejail(snapshot=True, snap_name=None)
+
+ +
+
+upgrade_jail()
+
+ +
+ +
+
+

iocage_lib.iocage module

+
+
+class iocage_lib.iocage.IOCage(jail=None, rc=False, callback=None, silent=False, activate=False, skip_jails=False, reset_cache=False)
+

Bases: object

+
+
+activate(zpool)
+

Activates the zpool for iocage usage

+
+ +
+
+chroot(command)
+

Deprecated: Chroots into a jail and runs a command, or the shell.

+
+ +
+
+clean(d_type)
+

Destroys all of a specified dataset types.

+
+ +
+
+create(release, props, count=0, pkglist=None, template=False, short=False, _uuid=None, basejail=False, thickjail=False, empty=False, clone=None, skip_batch=False, thickconfig=False, clone_basejail=False)
+

Creates the jail dataset

+
+ +
+
+deactivate(zpool)
+
+ +
+
+debug(directory)
+
+ +
+
+destroy_jail(force=False)
+

Destroys the supplied jail, to reduce perfomance hit, +call IOCage with skip_jails=True

+
+ +
+
+destroy_release(download=False)
+

Destroy supplied RELEASE and the download dataset if asked

+
+ +
+
+df()
+

Returns a list containing the resource usage of all jails

+
+ +
+
+exec(command, host_user='root', jail_user=None, console=False, start_jail=False, interactive=False, unjailed=False, msg_return=False)
+

Executes a command in the jail as the supplied users.

+
+ +
+
+exec_all(command, host_user='root', jail_user=None, console=False, start_jail=False, interactive=False, unjailed=False, msg_return=False)
+

Runs exec for all jails

+
+ +
+
+export(compression_algo='zip')
+

Will export a jail

+
+ +
+
+fetch(**kwargs)
+

Fetches a release or plugin.

+
+ +
+
+fstab(action, source, destination, fstype, options, dump, _pass, index=None, add_path=False, header=False)
+

Adds an fstab entry for a jail

+
+ +
+
+get(prop, recursive=False, plugin=False, pool=False, start_jail=False)
+

Get a jail property

+
+ +
+
+import_(compression_algo='zip', path=None)
+

Imports a jail

+
+ +
+
+list(lst_type, header=False, long=False, sort='name', uuid=None, plugin=False, quick=False, **kwargs)
+

Returns a list of lst_type

+
+ +
+
+rename(new_name)
+
+ +
+
+static reset_cache()
+
+ +
+
+restart(soft=False)
+
+ +
+
+rollback(name)
+

Rolls back a jail and all datasets to the supplied snapshot

+
+ +
+
+set(prop, plugin=False, rename=False)
+

Sets a property for a jail or plugin

+
+ +
+
+snap_list(long=True, _sort='created')
+

Gathers a list of snapshots and returns it

+
+ +
+
+snap_remove(snapshot)
+

Removes user supplied snapshot from jail

+
+ +
+
+snapshot(name)
+

Will create a snapshot for the given jail

+
+ +
+
+start(jail=None, ignore_exception=False, used_ports=None)
+

Checks jails type and existence, then starts the jail

+
+ +
+
+stop(jail=None, force=False, ignore_exception=False)
+

Stops the jail.

+
+ +
+
+update(pkgs=False)
+

Updates a jail to the latest patchset.

+
+ +
+
+update_all(pkgs=False)
+

Runs update for all jails

+
+ +
+
+upgrade(release)
+
+ +
+
+upgrade_all(release)
+

Runs upgrade for all jails

+
+ +
+ +
+
+class iocage_lib.iocage.PoolAndDataset
+

Bases: object

+
+
+get_iocroot()
+

Helper to get the iocroot.

+
+
Return:

string: with the iocroot name.

+
+
+
+ +
+
+get_pool()
+

Helper to get the current pool.

+
+
Return:

string: with the pool name.

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/jailtypes.html b/docs/jailtypes.html new file mode 100644 index 00000000..6acc7f37 --- /dev/null +++ b/docs/jailtypes.html @@ -0,0 +1,186 @@ + + + + + + + + + Jail Types — iocage 1.9 documentation + + + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+

Jail Types

+

iocage supports several different jail types:

+
    +

  • Clone (default)

    • +

  • Basejail

    • +

  • Template

    • +

  • Empty

    • +

  • Thickjail

    • +
+

All jail types have specific benefits and drawbacks, serving a variety +of unique needs. This section describes and has creation examples for +each of these jail types.

+
+

Clone (default)

+

Clone jails are created with:

+

# iocage create -r 11.0-RELEASE

+

Clone jails are duplicated from the appropriate RELEASE at creation +time. These consume a small amount of space, preserving only the +changing data.

+
+
+

Basejail

+

The original basejail concept was based on nullfs mounts. It was +popularized by ezjail, +but iocage basejails are a little different. Basejails in +iocage are mounts in a jail fstab that are mounted at +jail startup.

+

Create a basejail by typing:

+

iocage create -r [RELEASE] -b

+

Basejails mount their fstab mounts at each startup. They are ideal +for environments where immediate patching or upgrading of multiple +jails is required.

+
+
+

Template

+

Template jails are customized jails used to quickly create further +custom jails.

+

For example, after creating a jail, the user customizes +that jail’s networking properties. Once satisfied, the user then changes +the jail into a template with:

+

# iocage set template=yes examplejail

+

After this operation the jail is found in the templates list:

+

# iocage list -t

+

And new jails with the user customized networking can be created:

+

# iocage create -t examplejail -n newexamplejail

+

Template jails are convertable by setting the template= +property.

+
+
+

Empty

+

Empty jails are intended for unsupported jail setups or testing. Create +an empty jail with iocage create -e.

+

These are ideal for experimentation with unsupported RELEASES or Linux +jails.

+
+
+

Thickjail

+

Thickjails jails are created with:

+

# iocage create -T -r 11.2-RELEASE

+

Thickjails are copied from the appropriate RELEASE at creation +time. These consume a large amount of space, but are fully independent.

+

These are ideal for transmission or synchronization between different +hosts with zfs send and zfs receive.

+
+
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ previous | + next | + modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/known-issues.html b/docs/known-issues.html new file mode 100644 index 00000000..fa7eb748 --- /dev/null +++ b/docs/known-issues.html @@ -0,0 +1,185 @@ + + + + + + + + + Known Issues — iocage 1.9 documentation + + + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+

Known Issues

+

This section provides a short list of known issues.

+
+

Mount Path Limit

+

There is a known mountpoint path length limitation issue on FreeBSD. +Path length has an historical 88 character limit.

+

This issue does not affect iocage jails from functioning +properly, but can present challenges when diving into ZFS snapshots, +like cd into .zfs/snapshots, tar, etc.

+

ZFS snapshot creation and rollback is not affected.

+

To work around this issue, iocage allows the user to +assign and use a unique NAME for the jail. Alternately, using the +[-s | –short] flag at jail creation tells iocage to +assign a shortened UUID to the jail.

+
+
+

VNET/VIMAGE Issues

+

VNET/VIMAGE can cause unexpected system crashes when VNET enabled jails +are destroyed. In other words, when the jail process is killed, removed, +or stopped.

+

As a workaround, iocage allows a soft restart without +destroying the jail. iocage restart -s [UUID | NAME] executes +a soft restart of the jail.

+

Example:

+

# iocage restart -s examplejail

+

FreeBSD 10.1-RELEASE is stable enough to run with VNET and soft +restarts. There are production machines with iocage and VNET +jails running well over 100 days of uptime running both PF and IPFW.

+
+

VNET/VIMAGE issues w/ ALTQ

+

As recent as FreeBSD 10.1-RELEASE-p10, there are some interesting +interactions between VNET/VIMAGE and the ALTernate Queueing (ALTQ) +system used by PF and other routing software. When compiling a kernel, +be sure these lines are not in the kernconf file (unless +disabling VNET):

+
options     ALTQ
+options     ALTQ_CBQ
+options     ALTQ_RED
+options     ALTQ_RIO
+options     ALTQ_HFSC
+options     ALTQ_CDNR
+options     ALTQ_PRIQ
+
+
+

Otherwise, when starting a jail with VNET support enabled, the host +system is likely to crash. Read a more about this issue from a +2014 mailing list post.

+
+
+
+

IPv6 host bind failures

+

In some cases, a jail with an ip6 address may take too long adding the +address to the interface. Services defined to bind specifically to the +address may then fail. If this happens, add this to sysctl.conf +to disable DAD (duplicate address detection) probe packets:

+
# disable duplicated address detection probe packets for jails
+net.inet6.ip6.dad_count=0
+
+
+

Adding these lines permanently disables DAD. To set this for ONLY the +current system boot, type sysctl net.inet6.ip6.dad_count=0 in +a command line interface (CLI). More information about this issue is +available from a +2013 mailing list post.

+
+
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ previous | + next | + modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html new file mode 100644 index 00000000..da637941 --- /dev/null +++ b/docs/modules.html @@ -0,0 +1,513 @@ + + + + + + + + + iocage — iocage 1.9 documentation + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+

iocage

+
+ +
+
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/networking.html b/docs/networking.html new file mode 100644 index 00000000..837568e7 --- /dev/null +++ b/docs/networking.html @@ -0,0 +1,283 @@ + + + + + + + + + Networking — iocage 1.9 documentation + + + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+

Networking

+

Jails have multiple networking options to better serve a user’s needs. +Traditionally, jails have only supported IP alias based networking. This +is where an IP address is assigned to the host’s interface and then used +by the jail for network communication. This is typically known as +“shared IP” based jails.

+

Another recently developed option is called VNET or sometimes VIMAGE. +VNET is a fully virtualized networking stack which is isolated per jail. +VNET abstracts virtual network interfaces to jails, which then behave in +the same way as physical interfaces.

+

By default, iocage does not enable VNET, but users can enable and +configure VNET for a jail by configuring that jail’s properties using +the instructions in the Configure a Jail section of this +documentation.

+

The rest of this section shows more depth of the Shared IP and +VNET networking options, along with instructions for +Configuring Network Interfaces.

+
+

Warning

+

In the examples in this section, em0 is used as the +network adapter. em0 is a placeholder and must be replaced with +the user’s specific network adapter. A network adapter is a computer +hardware component that connects a computer to a computer network. +In order to find the network adapter on the system run +ifconfig.

+
+
+

Shared IP

+

The Shared IP networking option is rock solid, with over a decade of +heavy use and testing.

+

It has no specific system requirements, as everything needed is built +directly into the default GENERIC kernel.

+
+

Using Shared IP

+

There are a few steps to follow when setting up Shared IP:

+

Check the VNET property status

+

# iocage get vnet examplejail1

+

If vnet is on, disable it:

+

# iocage set vnet=off examplejail1

+

Configure an IP address

+

# iocage set ip4_addr="em0|10.1.1.10/24" examplejail1

+

If multiple addresses are desired, separate the configuration directives +with a ,:

+

# iocage set ip4_addr="em0|10.1.1.10/24,em0|10.1.1.11/24" examplejail1

+

Start the jail

+

iocage start examplejail1

+

Verify visible IP configuration in the jail

+

# iocage exec examplejail1 ifconfig

+
+
+
+

VIMAGE/VNET

+

VNET is considered experimental. Unexpected system crashes +can occur. More details about issues with VNET are available in the +Known Issues section of this documentation.

+

There are a number of required steps when configuring a jail to use +VNET:

+

Kernel

+
+

Tip

+

If not required, disable SCTP.

+
+

Rebuild the kernel with these options:

+
nooptions       SCTP   # Stream Control Transmission Protocol
+options         VIMAGE # VNET/Vimage support
+options         RACCT  # Resource containers
+options         RCTL   # same as above
+
+
+

/etc/rc.conf

+

On the host node, add this bridge configuration to /etc/rc.conf:

+
# set up bridge interface for iocage
+cloned_interfaces="bridge0"
+
+# plumb interface em0 into bridge0
+ifconfig_bridge0="addm em0 up"
+ifconfig_em0="up"
+
+
+

/etc/sysctl.conf

+

Add these tunables to /etc/sysctl.conf:

+
net.inet.ip.forwarding=1       # Enable IP forwarding between interfaces
+net.link.bridge.pfil_onlyip=0  # Only pass IP packets when pfil is enabled
+net.link.bridge.pfil_bridge=0  # Packet filter on the bridge interface
+net.link.bridge.pfil_member=0  # Packet filter on the member interface
+
+
+

Enable vnet for the jail

+

# iocage set vnet=on examplejail

+

Configure jail’s default gateway

+

# iocage set defaultrouter=10.1.1.254 examplejail

+

Configure an IP address

+

iocage set ip4_addr="vnet0|10.1.1.10/24" examplejail

+

Start jail and ping the default gateway

+

Start the jail:

+

# iocage start examplejail

+

Open the system console inside the jail:

+

iocage console examplejail

+

Ping the previously configured default gateway:

+

# ping 10.1.1.254

+
+

Tips

+

Routes

+

Be sure the default gateway knows the route back to the VNET subnets.

+

Using VLANs

+

To assign a jail’s traffic to a VLAN, add the VLAN interface as a bridge +member, but not the VLAN’s parent. For example:

+
sysrc vlans_em0="666"
+sysrc ifconfig_em0_666="up"
+iocage set vnet_default_interface="em0.666" examplejail
+iocage set interfaces="vnet1:bridge1" examplejail
+
+
+

If using VLAN interfaces for the jail host only, on the other hand, add the +parent as a bridge member, but not the VLAN interface.

+
sysrc vlans_em0="666"
+sysrc ifconfig_em0_666="1.2.3.4/24"
+iocage set vnet_default_interface="auto" examplejail # "em0" would also work
+iocage set interfaces="vnet1:bridge1" examplejail
+
+
+
+
+
+

Configuring Network Interfaces

+

iocage transparently handles network configuration for both +Shared IP and VNET jails.

+
+

Configuring a Shared IP Jail

+

IPv4

+

# iocage set ip4_addr="em0|192.168.0.10/24" examplejail

+

IPv6

+

# iocage set ip6_addr="em0|2001:123:456:242::5/64" examplejail

+

These examples add IP alias 192.168.0.10/24 and 2001:123:456::5/64 +to interface em0 of the shared IP jail, at start time.

+
+
+

Configuring a VNET Jail

+

To configure both IPv4 and IPv6:

+

# iocage set ip4_addr="vnet0|192.168.0.10/24" examplejail

+

# iocage set ip6_addr="vnet0|2001:123:456:242::5/64" examplejail

+

# iocage set defaultrouter6="2001:123:456:242::1" examplejail

+
+

Note

+

For VNET jails, a default route has to also be specified.

+
+

To create a a jail with a DHCP interface add the dhcp=on property:

+

# iocage create -r 11.0-RELEASE --name myjail dhcp=on

+

The dhcp=on property implies creating a VNET virtual network stack and +enabling the Berkley Packet Filter. DHCP cannot work without VNET. +More information about VNET is available in the VNET(9) FreeBSD manual page.

+
+
+

Tips for Configuring VNET

+

To start a jail with no IPv4/6 address, set the ip4_addr and +ip6_addr properties, then the defaultrouter and defaultrouter6 +properties:

+

# iocage set ip4_addr=none ip6_addr=none examplejail

+

# iocage set defaultrouter=none defaultrouter6=none examplejail

+

Force iocage to regenerate the MAC and HW address (e.g.: after cloning a jail). This will cause the MAC and HW addresses to be regenerated when the jail is next started.

+

# iocage set vnet0_mac=none examplejail

+
+
+
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ previous | + next | + modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/objects.inv b/docs/objects.inv new file mode 100644 index 0000000000000000000000000000000000000000..906fd1dfdff715f7bd12e2443a7642261ca73565 GIT binary patch literal 3852 zcmV+n5A*ONAX9K?X>NERX>N99Zgg*Qc_4OWa&u{KZXhxWBOp+6Z)#;@bUGkuZ)0I+ zWeOu8R%LQ?X>V>iATcgE3L_v?Xk{RBWo=<;Ze(S0Aa78b#rNMXCQiPX<{x4c-pm{S&!p3635^5DFo~+kN}ah0T%m^x1K(-o$a1+ z`k2K&3A9Ap%t)d}q}=WK^jo}iSw2)$o~A9;|3``}lEp)sH4%~)vf7uN6;g!d{@0wR zbw<{-R=3!ZjHU3TP%(8O2TkBiDJ8}gF=J1|4lnPn#Jzfc}!Ll@# z@M~g@*N8;vJ55lsl2;h_T~nECu{y5`T?J%8ZS+eYku=v4B70WJ|{#=TfbTZLS?;5S28HG4ZjH{*r{1 zRwwKrQxk5)CgO-mHX1}u=CtFgFNx(~B4$DTNmw=ysiN?Ym?>M5=4A%0WI7GPXO8wA zEnciR*O@3QUdHqtIx{ie&!5l8A|Y-6ivy_k;|ez}=$nc0Jy^1;<#z7};k7JliDy7y z4B1GecV+-o=QM_COq}tJ2dCW2ic&OSLyNc|GG?V0qAqGd)uVWVs0xXo$Jwn#T!FXS zu^fq$v7YbIwzoiowjAcT8_3)n+0Q_-?ZOMB9x7f#<*!6~I&7e@IiZEduE~Zt*@r6`T zSuqMdB1v-wkpd8jN6*;cSozO*%`4r7;AwRsl8TjhM*=5|VU`P{i0=2jI8~xLK|DfL z7TFO$z{)N;;t6J9E%k+X=E5T?u=;=b0sds3Mc~uZYk*e=pb6ikr#JcbXci*;07BYj z1U$k`vpgyL(vwho6sCHHHOo8zc^Rif64hDh$ql|<%xng_P8CMdct^6DdegiqdliO4 zj_`d?v-(_S^#;bfoD^(*beaAn@aV?ICG&H$xuMny8qAc{oq^nLmUM#jNh=LUXbh&d zFzI&zi`Q+1{KJOHwT>QL4h+ibgWs~s?i^u?6Sd04TEuQrNTjUTs)jN_Q7Zb)pOP1no7HJQP6>rkaDR>{P2b>0 zaT9+($_{?}fRxjsy~T;mA*r}IxiZ1o^=>@U*|k<>;@&|fJV9SX!vhH#3Q(lx0w`4^Cz0+fj9ZRn~R`6w~OnxP8>5tkrg^@XL(e#7dfcd4Sq8y!yAU0xa@(f$kfX zbm8297umk`g^A;DkEoi!y3Txi7R}P$Z#paALb5Eg01nX{&*M7DW+r}L3xA^SL)5I? zABCAU9a8Mc>bS01s!kP1GDEG}9fTPl))MD=W(yPZWp5so-3#(v!K*;#J7~&-d<+A!U=tGBa`^YuJcYK9&t; zLM;#Fi<{fKtJjB@c=_~s`HbjE4}i;u*Wd0x#b0ipp6@?@nuAE+OEnE7D`t-BswFYD zW;DgF#vY_#)?+*MG8ZgnMM~f2MY`h(4Dr&%X|kOc|3y?2fX`YkrJlv8w}0aeQwOz5 z?#*l_rQMvOhQ_n#W(m#*s^5u2oD&%V@p29hZd+pn)4oGDfphc~!3+9UtyNigc901@ zYhP>^@F1?j3|a%$8hkKbRV)RQT-Kg6HEKB+%~#MmX8^iY3j4yyj6{99c})`P$u#Xm zy*>mJ(1c_vW}5}syu?#c!L!{g%!0}{UVWXD)fQyDE2f9LC(#NRlQga7r!rjCkH7DG zQ6IodlOcnc&;y)!>-U0$ty-o1+JdGh-vPKjR7cL3J)#px1P;CVX1Ba1@4L0S{%24o zW!VurUqiv^n^&cA^7c3`N}p2yBEXz+?8(t*3r8rp*uM)}D;Zuj|6Ckl) zJ!k}KDR2O3K1G5f_|-!bsG!uSnbv{cuP4Gy(+&a1T&RP)S4Dbb*7T-_2YtPsc;Jp3 z9D%7r3};Er$ZUfoA=6(ovZ7fS{Srd##*(NO)Yv=Q$l6}@wE;ro?!jDS6bU%Z^-EI~RSqEa>z$(To zCimxRMHxqp@kb?H+FybB^3i3Urfr?4nXer^7*8`F9z0!b*V^U>yDage(TMZDsdbQq zdyyg};h~cZYP>OyNTiLgJ8HG()Zo;c4{ zVDFb>Y3fCUsmUqPSV~_$-M$wG->=Zdov8VleGHEGKhgz%mzY0Xf8tL42$QWK|bZ_(MVT+x`!%sNa8VQ#pHH)Xzxs za+sfkhJLGT0{UI+&B>aBp~DUfMq*5(*7VW*1#YIcJi=Rpl03XOWAvJQ>lQQoG-Z5u z^+$8BNy^=YoSFOmPYw4thoAW!UJT75OJF8|By_XrQ$?z6p+KGOoz*^>-@%3!W;>?` zaaT3~PDtgeQA>DPk46%iAnb}d24A|;EIENW!;%TZiloLnEsIn}^)jT$pu z8!zh5pfTz`TVL5V*SQT%ZqGeO_e%I5Exgx1g5I4@x(AHDOh*u5!c}4LDwJF38q>3p zfL29X74a%^Djk8q&}3mR=CVtptZjU_+K1rq3AE%3qI#QDS(~6STJ58b*rvFAHDRGb z|J|mSRwTb{;$V_c_BJpz)SIWPM*z@3PwrJ{&me#>=e*7m!PBfFG75c)<;p^AsHV(R z&uTt!cB=cZmXWc1usY>LB7k0Sq{}Mzk-K54{n0E{o6gJhoIOXem%1$v%=Bk})xjrI zsAt?$+egaYgr<IKtSOAmYhrYz(2c z`D$oQ7tT7Ixtn-AIk|D@@P`MwA;~`c{ORF;KL&PX?`-xyD2}oW1SJ&=$30_n%@o43 zxxZAtDJG4-;$ZxJJ{W(&Mpq6kcC6w>4t-3xBNbCe9>qDjuIP?3YL(BHd)wiDad%a! zb=mb)eZf4hxo5+ic4Bn0AvCj~cFGepYlFEC7jzEJRJD^t9m%u9JT}(?vuLQ-{@hCL z*$UTYkI&?GHAX?bUK=Tv1UR0q1aBn zH5X0Yy{hj6G!hZ0uhI?dg$r!WJs0EXubZ69iu(deAk_y5*HBvB*`}V*o^%r>i$E52 zCz@LJ;(*;brkd0SvaX5{I-!ZZhLT0Rh=#q#i^UCkkw7oy9vK%8>CW1Yjjv8@21m0Z zI{{|R8=8|_oUYUhTcS2@S0$`Rw5`&>`o7e_`rc$&t?kgecKT(?^VR+#{Br+z_1o>w zx + + + + + + + Plugins — iocage 1.9 documentation + + + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+

Plugins

+

iocage plugins are a simple and very fast method to get application +containers installed and configured. At its core, a plugin is a jail +specifically running one program. Popular programs can be installed +repeatedly with one line. Additionally, plugins are easily extended by +users, offering a high level of customizability and functionality.

+

In structure, a plugin consists of .json manifest and +.png icon files.

+

See what’s available

+

To see a list of all currently available plugins, open a command line +and type iocage list -PR or +iocage list --plugins --remote. The full +iocage plugin list +is also available on GitHub.

+

Check which plugins are installed on the system with +iocage list --plugins or iocage list -P.

+

Getting started with plugins

+
+

Note

+

iocage needs to be activated before +plugins can be installed or modified!

+
+

To get started, open a command line and type +iocage fetch --plugins ip4_addr="IF|IP". This initial +fetch also supports dhcp in the same manner as +iocage create. The IP listed for the plugin needs to +be a valid IP not already in use. Use the - -name flag to easily fetch a +specific plugin:

+

$ iocage fetch --plugins --name plexmediaserver ip4_addr="igb0|192.168.0.91"

+

If available, plugins can also be fetched locally with +iocage fetch -P the/path/to/plugin.json ip4_addr="re0|192.168.0.100"

+
+

Tip

+

Using iocage fetch locally is very useful when +testing an in-development plugin.

+
+

After fetching a plugin, view of all its properties with +iocage get -a NAME|UUID | less. Individual properties are +found with iocage get PROPERTY:

+

$ iocage get type quasselcore

+

Adjust the plugin properties with iocage set:

+

$ iocage set PROPERTY quasselcore

+

iocage set is used to configure +that plugin. In this example, a complete Quasselcore plugin is +installed to a FreeNAS system, then the note of the plugin is changed:

+
[root@freenas ~]# iocage fetch --plugins --name quasselcore ip4_addr="em0|192.168.1.50"
+[root@freenas ~]# iocage set notes="Hello world" quasselcore
+[root@freenas ~]# iocage get notes quasselcore
+Hello world
+
+
+

Upgrading and updating plugins

+

The process for upgrading and updating plugins is exactly the same as +normal jails. See Updating Jails or Upgrading Jails .

+

Plugin Manifest Example

+

Following is an example of a plugin manifest:

+
{
+    "name": "default_jail_name_here",
+    "release": "11.3-RELEASE",
+    "artifact": "https://github.com/git_path_to_plugin_repo",
+    "official": false,
+    "properties": {
+        "nat": 1,
+        "nat_forwards": "tcp(7878:7878)"
+    },
+    "devfs_ruleset": {
+        "paths": {"bpf*": null},
+        "includes": []
+    },
+    "pkgs": [
+    ],
+    "packagesite": "http://pkg.FreeBSD.org/${ABI}/latest",
+    "fingerprints": {
+        "iocage-plugins": [
+            {
+                "function": "sha256",
+                "fingerprint": "b0170035af3acc5f3f3ae1859dc717101b4e6c1d0a794ad554928ca0cbb2f438"
+            }
+        ]
+    },
+    "revision": 0
+}
+
+
+
    +

  • devfs_ruleset: It should be a valid dictionary object where “paths” must be specified. Value of “paths” is a +dictionary where keys are the path to be added and the value is the mode to be used. null translates to unhide. +For any include specified, please refer to the following example which shows how each path specified is added as +iocage dynamically generates a devfs ruleset and how an include is added to the ruleset:

    • +
+
devfs rule -s ruleset_number add path bpf* unhide
+devfs rule -s ruleset_number add include include_value
+
+
+
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ previous | + next | + modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/py-modindex.html b/docs/py-modindex.html new file mode 100644 index 00000000..c871c95d --- /dev/null +++ b/docs/py-modindex.html @@ -0,0 +1,373 @@ + + + + + + + + Python Module Index — iocage 1.9 documentation + + + + + + + + + + + + + + + + +
+
+
+ +
+
+
+ + +

Python Module Index

+ +
+ f | + i +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ f
+ fastentrypoints +
 
+ i
+ iocage_cli +
    + iocage_cli.activate +
    + iocage_cli.chroot +
    + iocage_cli.clean +
    + iocage_cli.clone +
    + iocage_cli.console +
    + iocage_cli.create +
    + iocage_cli.debug +
    + iocage_cli.destroy +
    + iocage_cli.df +
    + iocage_cli.exec +
    + iocage_cli.export +
    + iocage_cli.fetch +
    + iocage_cli.fstab +
    + iocage_cli.get +
    + iocage_cli.import +
    + iocage_cli.list +
    + iocage_cli.migrate +
    + iocage_cli.pkg +
    + iocage_cli.rename +
    + iocage_cli.restart +
    + iocage_cli.rollback +
    + iocage_cli.set +
    + iocage_cli.snaplist +
    + iocage_cli.snapremove +
    + iocage_cli.snapshot +
    + iocage_cli.start +
    + iocage_cli.stop +
    + iocage_cli.update +
    + iocage_cli.upgrade +
+ iocage_lib +
    + iocage_lib.ioc_check +
    + iocage_lib.ioc_clean +
    + iocage_lib.ioc_common +
    + iocage_lib.ioc_create +
    + iocage_lib.ioc_debug +
    + iocage_lib.ioc_destroy +
    + iocage_lib.ioc_exceptions +
    + iocage_lib.ioc_exec +
    + iocage_lib.ioc_fetch +
    + iocage_lib.ioc_fstab +
    + iocage_lib.ioc_image +
    + iocage_lib.ioc_json +
    + iocage_lib.ioc_list +
    + iocage_lib.ioc_plugin +
    + iocage_lib.ioc_start +
    + iocage_lib.ioc_stop +
    + iocage_lib.ioc_upgrade +
    + iocage_lib.iocage +
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/search.html b/docs/search.html new file mode 100644 index 00000000..f476dc17 --- /dev/null +++ b/docs/search.html @@ -0,0 +1,137 @@ + + + + + + + + Search — iocage 1.9 documentation + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +

Search

+ + + + +

+ Searching for multiple words only shows matches that contain + all words. +

+ + +
+ + + +
+ + + +
+ +
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/searchindex.js b/docs/searchindex.js new file mode 100644 index 00000000..3d265f0d --- /dev/null +++ b/docs/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["advanced-use", "basic-use", "best-practices", "debian", "faq", "fastentrypoints", "index", "install", "iocage_cli", "iocage_lib", "jailtypes", "known-issues", "modules", "networking", "plugins", "setup", "templates", "tests"], "filenames": ["advanced-use.rst", "basic-use.rst", "best-practices.rst", "debian.rst", "faq.rst", "fastentrypoints.rst", "index.rst", "install.rst", "iocage_cli.rst", "iocage_lib.rst", "jailtypes.rst", "known-issues.rst", "modules.rst", "networking.rst", "plugins.rst", "setup.rst", "templates.rst", "tests.rst"], "titles": ["Advanced Usage", "Basic Usage", "Best Practices", "Create a Debian Buster Jail (native Linux)", "FAQ", "fastentrypoints module", "iocage - A FreeBSD Jail Manager", "Install iocage", "iocage_cli package", "iocage_lib package", "Jail Types", "Known Issues", "iocage", "Networking", "Plugins", "setup module", "Using Templates", "tests package"], "terms": {"when": [0, 1, 2, 7, 11, 13, 14], "i": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 14, 16], "iocag": [0, 2, 3, 4, 10, 11, 13, 14, 16], "zf": [0, 3, 4, 6, 9, 10, 11], "filesystem": [0, 7, 9], "essenti": [0, 1, 4, 16], "ar": [0, 1, 2, 4, 7, 9, 10, 11, 13, 14, 16], "cheap": 0, "lightweight": 0, "writabl": [0, 4], "A": [0, 1, 4, 9, 13], "its": [0, 14, 16], "sourc": [0, 4, 7, 9], "To": [0, 1, 7, 11, 13, 14, 16], "destroi": [0, 6, 9, 11, 12], "preserv": [0, 10], "must": [0, 4, 7, 13, 14], "first": [0, 1, 9], "www01": [0, 1], "www02": [0, 1], "run": [0, 2, 3, 4, 7, 9, 11, 13, 14], "name": [0, 1, 2, 3, 4, 8, 9, 11, 13, 14, 16], "from": [0, 1, 2, 3, 5, 6, 9, 10, 11, 16], "an": [0, 1, 3, 4, 7, 8, 9, 10, 11, 13, 14], "exist": [0, 1, 7, 8, 9, 12, 16], "snapshotnam": 0, "www03": 0, "thi": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 13, 14, 16], "function": [0, 1, 9, 11, 14], "isn": [0, 7], "t": [0, 1, 7, 9, 10, 16], "fulli": [0, 4, 10, 13], "ad": [0, 1, 7, 11, 14], "mai": [0, 11], "expect": [0, 9], "uuid": [0, 1, 3, 4, 9, 11, 14, 16], "revers": 0, "relationship": 0, "The": [0, 1, 3, 7, 8, 9, 10, 13, 14, 16], "becom": [0, 4], "demot": 0, "can": [0, 1, 3, 4, 7, 9, 10, 11, 13, 14, 16], "now": [0, 1, 7], "remov": [0, 2, 7, 8, 9, 11, 12], "handl": [0, 13], "freebsd": [0, 1, 4, 7, 9, 11, 13, 14], "8": [0, 1, 3, 4, 6, 9], "util": 0, "while": [0, 9], "thei": [0, 8, 9, 10], "stop": [0, 2, 6, 7, 9, 11, 12, 16], "command": [0, 1, 2, 6, 7, 8, 9, 11, 14], "backup": 0, "given": [0, 1, 8, 9], "manual": [0, 1, 4, 13], "n": [0, 1, 2, 3, 7, 10, 16], "latest": [0, 1, 9, 14], "patch": [0, 1, 5, 9, 10], "level": [0, 8, 9, 14], "finish": [0, 2, 16], "appear": [0, 8], "properli": [0, 11], "snapremov": [0, 12], "test": [0, 1, 2, 3, 8, 10, 12, 13, 14], "without": [0, 11, 13], "affect": [0, 11], "same": [0, 1, 4, 9, 13, 14], "wai": [0, 4, 13], "outlin": 0, "abov": [0, 1, 7, 13], "testupd": 0, "flag": [0, 1, 11, 14], "option": [0, 1, 2, 8, 9, 11, 13], "assign": [0, 1, 4, 9, 11, 13], "By": [0, 1, 13], "default": [0, 1, 2, 4, 6, 7, 9, 13], "user": [0, 1, 2, 4, 9, 10, 11, 13, 14], "suppli": [0, 1, 9], "new": [0, 1, 9, 10, 16], "releas": [0, 2, 3, 6, 9, 10, 11, 13, 14, 16], "": [0, 1, 2, 3, 5, 7, 8, 9, 10, 11, 13, 14, 16], "For": [0, 1, 4, 9, 10, 13, 14], "exampl": [0, 1, 2, 3, 10, 11, 13, 14], "examplejail": [0, 10, 11, 13], "r": [0, 1, 2, 10, 13, 16], "11": [0, 1, 2, 7, 10, 13, 14, 16], "0": [0, 1, 2, 3, 7, 8, 9, 10, 11, 13, 14, 16], "tell": [0, 11], "It": [0, 2, 6, 7, 9, 10, 13, 14, 16], "recommend": [0, 2, 3, 16], "keep": 0, "host": [0, 2, 3, 4, 6, 7, 9, 10, 13], "synchron": [0, 10], "1": [0, 1, 3, 7, 9, 11, 13, 14], "method": [0, 7, 9, 14, 16], "also": [0, 1, 2, 3, 9, 13, 14], "basejail": [0, 1, 6, 7, 9], "make": [0, 4, 7, 9, 16], "sure": [0, 1, 4, 7, 9, 11, 13], "iocage_en": 0, "ye": [0, 2, 3, 4, 10, 16], "set": [0, 2, 3, 4, 6, 9, 10, 11, 12, 13, 14, 16], "etc": [0, 2, 3, 7, 9, 11, 13], "rc": [0, 2, 9, 13], "conf": [0, 2, 9, 11, 13], "enabl": [0, 1, 3, 4, 11, 13], "dure": 0, "system": [0, 1, 4, 6, 7, 9, 11, 13, 14], "simpli": 0, "creation": [0, 1, 2, 9, 10, 11], "start": [0, 2, 3, 6, 9, 11, 12, 13, 14, 16], "after": [0, 1, 10, 13, 14], "order": [0, 8, 13], "specifi": [0, 1, 8, 9, 13, 14], "valu": [0, 1, 7, 8, 9, 14], "20": 0, "lower": 0, "higher": 0, "requir": [0, 1, 9, 10, 13, 16], "other": [0, 1, 7, 11, 13], "befor": [0, 1, 7, 9, 14], "one": [0, 1, 7, 9, 14], "space": [0, 10], "delimit": [0, 9], "wait": 0, "those": 0, "have": [0, 1, 9, 10, 13], "foo": [0, 9], "bar": [0, 9], "baz": 0, "support": [0, 4, 9, 10, 11, 13, 14], "transpar": [0, 6, 13], "out": [0, 4], "box": 0, "point": [0, 5], "time": [0, 1, 4, 10, 13, 16], "copi": [0, 4, 9, 10], "data": [0, 2, 9, 10], "safeti": 0, "which": [0, 1, 2, 13, 14, 16], "revert": 0, "ani": [0, 1, 7, 8, 9, 14, 16], "initi": [0, 1, 14], "take": [0, 8, 9, 11], "up": [0, 3, 7, 9, 13, 16], "almost": [0, 3], "chang": [0, 1, 2, 7, 9, 10, 14, 16], "record": [0, 8], "snaplist": [0, 9, 12], "base": [0, 1, 6, 8, 9, 10, 13, 16], "current": [0, 1, 7, 9, 11, 14], "avail": [0, 1, 11, 13, 14, 16], "version": [0, 4, 7, 8, 9], "yet": 0, "implement": [0, 8], "all": [0, 7, 9, 10, 14, 16], "subsect": 0, "procedur": 0, "here": [0, 1], "meant": [0, 1], "provid": [0, 1, 2, 9, 11], "singl": 0, "cpuset": 0, "tag": [0, 9], "4": [0, 1, 3, 9, 13], "gb": 0, "memori": [0, 4], "rss": 0, "done": [0, 1, 16], "fly": 0, "memoryus": [0, 9], "4g": 0, "deni": [0, 9], "rlimit": 0, "cap": 0, "activ": [0, 6, 9, 12, 14], "In": [0, 1, 3, 11, 13, 14], "testjail": [0, 2], "execut": [0, 7, 9, 11], "pcpu": [0, 9], "doubl": 0, "confirm": 0, "p": [0, 14], "pkglist": [0, 9], "need": [0, 1, 4, 7, 9, 10, 13, 14, 16], "json": [0, 9, 14], "file": [0, 1, 3, 7, 9, 11, 14], "contain": [0, 4, 6, 7, 9, 13, 14], "per": [0, 4, 9, 13], "line": [0, 1, 3, 7, 9, 11, 14], "internet": 0, "connect": [0, 13, 16], "pkg": [0, 3, 6, 9, 12, 14], "obtain": 0, "onlin": 0, "repositori": [0, 7], "add": [0, 3, 9, 11, 13, 14, 16], "nginx": [0, 16], "tmux": 0, "path": [0, 3, 6, 7, 9, 12, 14], "newli": [0, 1], "section": [1, 2, 3, 4, 10, 11, 13], "about": [1, 2, 9, 11, 13], "how": [1, 4, 14], "refer": [1, 4, 14], "rememb": [1, 3, 7, 16], "help": [1, 2], "alwai": [1, 2], "type": [1, 6, 7, 9, 11, 12, 14], "subcommand": [1, 8], "ha": [1, 2, 6, 9, 10, 11, 13, 16], "flow": 1, "us": [1, 2, 3, 4, 6, 9, 10, 11, 14], "As": [1, 11], "interact": [1, 9, 11], "guid": 1, "them": [1, 9], "through": 1, "experiment": [1, 10, 13], "color": 1, "mode": [1, 3, 9, 14], "iocage_color": 1, "true": [1, 3, 9], "four": 1, "accept": [1, 9], "descript": 1, "iocage_logfil": 1, "locat": [1, 7, 9], "log": [1, 8, 9], "fals": [1, 8, 9, 14], "turn": 1, "cli": [1, 8, 9, 11], "output": [1, 9], "iocage_forc": 1, "automat": [1, 6], "migrat": [1, 6, 9, 12], "iocage_plugin_ip": 1, "ip_addr": [1, 9], "plugin": [1, 6, 9], "quickli": [1, 10], "queri": 1, "anoth": [1, 7, 13, 16], "program": [1, 4, 14], "script": [1, 9], "process": [1, 3, 9, 11, 14, 16], "depend": [1, 8], "shell": [1, 9], "being": 1, "csh": 1, "tcsh": 1, "bash": 1, "sh": 1, "differ": [1, 10, 16], "slightli": 1, "setenv": 1, "export": [1, 6, 7, 9, 12], "link": [1, 7, 13], "usabl": 1, "zpool": [1, 9], "most": 1, "case": [1, 9, 11], "primari": 1, "more": [1, 2, 4, 6, 7, 11, 13], "advanc": [1, 6], "design": [1, 4], "onc": [0, 1, 2, 10, 16], "readi": 1, "abl": 1, "immedi": [1, 10], "begin": [1, 2], "download": [1, 9], "open": [1, 2, 9, 13, 14], "menu": 1, "choos": [1, 9], "seen": 1, "9": [1, 13], "3": [1, 9, 13, 14], "eol": [1, 9], "10": [1, 7, 11, 13], "2": [1, 4, 7, 9, 10, 13], "number": [1, 13], "desir": [1, 13], "press": 1, "enter": [1, 9], "select": 1, "exit": [1, 5, 8, 9], "quit": 1, "recent": [1, 11, 13], "appli": 1, "fine": [1, 2, 7], "tune": 1, "If": [1, 4, 7, 9, 11, 13, 14], "specif": [1, 10, 11, 13, 14, 16], "mirror": 1, "ftp": 1, "hostnam": [1, 9], "org": [1, 9, 14], "pull": 1, "directori": [1, 7, 8, 9], "d": 1, "dir": [1, 9], "With": 1, "There": [1, 2, 7, 11, 13], "two": 1, "normal": [1, 6, 14], "detail": [1, 4, 13], "found": [1, 7, 9, 10, 14], "document": [1, 4, 13], "adjust": [1, 14], "either": 1, "invok": 1, "b": [1, 10], "clone": [1, 4, 6, 7, 9, 12, 13], "multipl": [1, 4, 9, 10, 13], "c": [1, 5], "show": [1, 3, 9, 13, 14], "numer": 1, "simpl": [1, 7, 14], "myjail": [1, 13], "boot": [1, 6, 9, 11], "custom": [1, 2, 3, 4, 10, 16], "inform": [1, 7, 11, 13], "page": [1, 4, 6, 13], "access": [1, 9], "man": 1, "see": [1, 2, 9, 14], "view": [1, 14], "templat": [1, 2, 4, 6, 9], "down": [1, 7], "state": [1, 9], "statu": [1, 9, 13], "read": [1, 9, 11], "column": 1, "each": [1, 10, 14], "partial": 1, "entri": [1, 5, 7, 9], "long": [1, 9, 11], "charact": [1, 11], "enough": [1, 11], "identifi": [1, 2], "altern": [1, 11], "oper": [1, 4, 6, 7, 10], "complex": 1, "do": [1, 3, 4, 8], "like": [1, 3, 9, 11], "26e8e027": 1, "f00c": 1, "11e4": 1, "8f7f": 1, "3c970e80eb61": 1, "iocaget": 1, "www": 1, "26e8": 1, "syntax": [1, 6, 7], "alreadi": [1, 9, 14], "best": [1, 6, 7, 9], "Be": [1, 13], "note": [1, 2, 14, 16], "full": [1, 9, 14], "displai": [1, 4, 9], "irreversibli": 1, "allow": [1, 2, 4, 9, 11], "alter": 1, "jail1": 1, "testingjail": 1, "some": [2, 4, 6, 7, 11], "gener": [2, 4, 9, 13, 14], "guidelin": 2, "tip": 2, "work": [2, 4, 7, 11, 13], "manag": [2, 4, 7], "jail": [2, 4, 9, 11, 14, 16], "pf": [2, 4, 11], "modul": [2, 6, 12], "kernel": [2, 11, 13], "seem": 2, "vnet": [2, 3, 4, 6, 9], "bug": 2, "onli": [2, 4, 6, 9, 10, 11, 13], "trigger": 2, "directli": [2, 3, 13], "compil": [2, 11], "creat": [2, 4, 6, 9, 10, 12, 13, 14, 16], "avoid": 2, "mistak": 2, "easili": [2, 7, 14, 16], "properti": [2, 9, 10, 13, 14, 16], "someth": 2, "meaning": 2, "especi": 2, "infrequ": 2, "root": [2, 3, 7, 9, 14], "tester": 2, "been": 2, "updat": [2, 6, 9, 12, 14], "get": [2, 3, 9, 12, 13, 14], "control": [2, 13], "isol": [2, 13], "own": 2, "firewal": [2, 4], "known": [2, 6, 9, 13], "issu": [2, 6, 13], "discov": 2, "simplifi": [2, 4], "give": 2, "try": [2, 9], "restart": [2, 6, 9, 11, 12], "instead": 2, "perform": 2, "soft": [2, 9, 11], "leav": [2, 9, 16], "stack": [2, 4, 6, 9, 13], "alon": 2, "less": [2, 14], "stress": 2, "both": [2, 4, 11, 13], "check": [2, 4, 9, 13, 14], "rule": [2, 3, 9, 14], "ipfw": [2, 4, 11], "insid": [2, 4, 6, 9, 13], "put": 2, "firewall_en": 2, "firewall_typ": 2, "exclud": 2, "accident": 2, "block": 2, "right": [2, 9], "re": [2, 9], "lock": 2, "mix": [2, 9], "delet": [0, 2, 7, 9], "old": [2, 9], "snapshot": [2, 6, 9, 11, 12], "unnecessari": 2, "where": [2, 4, 10, 13, 14], "constantli": 2, "debjail": 3, "replac": [3, 7, 9, 13], "your": [3, 4, 7], "product": [3, 11], "intent": 3, "anyth": [3, 9], "empti": [3, 6, 7, 9], "e": [3, 7, 10, 13], "exec_start": 3, "bin": [3, 7], "exec_stop": 3, "instal": [3, 6, 9, 14, 16], "debootstrap": 3, "sysrc": [3, 13], "linux_en": 3, "linux_mounts_en": 3, "NO": 3, "servic": [3, 7, 11], "grab": 3, "mountpoint": [3, 7, 9, 11], "append": [3, 7], "apart": 3, "you": [0, 3, 4, 16], "ubuntu": 3, "eg": 3, "bionic": 3, "fstab": [3, 9, 10, 12], "edit": [3, 7], "devf": [3, 9, 14], "dev": 3, "rw": [3, 7], "tmpf": 3, "shm": 3, "size": [3, 9], "1g": 3, "1777": 3, "fdescf": 3, "fd": 3, "linrdlnk": 3, "linproc": 3, "proc": 3, "linprocf": 3, "linsi": 3, "sy": [3, 5], "linsysf": 3, "attach": [3, 4, 9], "consol": [3, 9, 12, 13], "result": 3, "64": [3, 13], "bit": 3, "userland": 3, "what": [4, 9, 14], "administr": 4, "task": 4, "o": 4, "virtual": [4, 6, 13], "technologi": [4, 6, 7], "term": 4, "zone": 4, "independ": [4, 10, 16], "network": [4, 6, 7, 9, 10, 16], "configur": [4, 6, 9, 14, 16], "interfac": [4, 6, 9, 11], "share": [4, 6], "ipjail": 4, "ip4_add": 4, "ip": [4, 6, 9, 14], "netmask": 4, "info": [4, 7], "pleas": [4, 14], "my": 4, "gatewai": [4, 9, 13], "address": [4, 9, 11, 13], "bridg": [4, 9, 13], "howev": [4, 7], "still": 4, "plan": 4, "securelevel": 4, "traffic": [4, 13], "thin": [4, 6], "provis": [4, 6], "too": [4, 11], "These": [4, 10, 13], "limit": [4, 6], "cpu": 4, "legaci": [4, 6], "resourc": [4, 6, 9, 13], "consumpt": 4, "df": [4, 9, 12], "nat": [4, 9, 14], "built": [4, 13], "treat": 4, "server": [4, 9], "core": [4, 14], "router": [4, 9], "chapter": 4, "Will": [4, 9], "pool": [4, 9], "No": [4, 16], "should": [4, 8, 14], "written": 6, "python": 6, "combin": 6, "featur": [6, 7], "offer": [6, 14], "gear": [6, 7], "eas": [6, 7], "simplist": 6, "easi": 6, "learn": 6, "rapid": 6, "within": [6, 7, 16], "second": [6, 16], "packag": [6, 12, 16], "non": 6, "dedic": 6, "dataset": [6, 9], "binari": 6, "import": [5, 6, 9, 12], "And": [6, 10], "mani": 6, "github": [5, 6, 14], "build": 6, "port": 6, "upgrad": [6, 9, 10, 12, 14], "iocage_legaci": 6, "ezjail": [6, 10], "basic": 6, "usag": [6, 9], "environ": [6, 10], "variabl": 6, "fetch": [6, 9, 12, 14], "list": [6, 7, 9, 10, 11, 12, 14, 16], "renam": [6, 9, 12], "vimag": 6, "thickjail": [6, 9], "practic": 6, "auto": [6, 13], "debian": 6, "buster": 6, "nativ": 6, "linux": [6, 10], "mount": [6, 7, 9, 10], "ipv6": [6, 9, 13], "bind": 6, "failur": 6, "faq": 6, "index": [6, 9], "search": 6, "merg": 7, "visit": 7, "sudo": 7, "py38": 7, "tree": [7, 9], "src_base": 7, "usr": 7, "src": [7, 9], "python38": 7, "git": 7, "lite": 7, "cython": 7, "libzf": 7, "pip": 7, "http": [5, 7, 9, 14], "com": [5, 7, 9, 14], "subsequ": 7, "possibl": 7, "pre": 7, "sysutil": 7, "py": 7, "cd": [7, 11], "clean": [7, 9, 12], "back": [7, 9, 13, 16], "onestart": 7, "assumpt": 7, "act": 7, "newjail": 7, "symlink": [7, 9], "reli": 7, "utlil": 7, "look": [7, 9], "l": 7, "oldjail": 7, "lrwxr": 7, "xr": 7, "x": [7, 9], "wheel": 7, "13": 7, "feb": 7, "22": 7, "2017": 7, "would": [7, 13], "doesn": [7, 9], "becaus": [7, 9], "ln": 7, "rsync": 7, "main": [5, 7, 8, 12], "part": 7, "via": 7, "grep": 7, "userland_vers": 7, "p6": 7, "goe": 7, "local": [7, 14], "jail_oldjail_ip": 7, "em0": [7, 13, 14], "192": [7, 13, 14], "168": [7, 13, 14], "ip4_addr": [7, 13, 14], "24": [7, 13], "subnet": [7, 9, 13], "mask": 7, "shut": 7, "so": [7, 8, 9, 16], "won": 7, "conflict": 7, "admin": 7, "well": [7, 9, 11], "cat": 7, "nullf": [7, 10], "ro": 7, "remain": [7, 16], "validate_count": [8, 12], "ctx": 8, "param": 8, "string": [8, 9], "comma": [8, 9], "return": [8, 9], "int": 8, "child_test": [8, 12], "iocroot": [8, 9], "_type": 8, "forc": [0, 8, 9, 13], "recurs": [8, 9], "children": [8, 9], "ioc": 8, "class": [8, 9], "ioclogg": [8, 12], "object": [8, 9, 14], "setconsoleloglevel": [8, 12], "iocagecli": [8, 12], "str": 8, "none": [8, 9, 13], "invoke_without_command": 8, "bool": [8, 9], "no_args_is_help": 8, "subcommand_metavar": 8, "chain": 8, "result_callback": 8, "callabl": [8, 9], "attr": 8, "multicommand": 8, "iter": [8, 9], "load": [8, 9], "definit": [8, 9], "get_command": [8, 12], "context": [8, 9], "list_command": [8, 12], "infohandl": [8, 12], "handler": 8, "emit": [8, 12], "whatev": 8, "actual": [8, 9], "intend": [8, 10], "subclass": 8, "rais": 8, "notimplementederror": 8, "print_vers": [8, 12], "print": 8, "ioccheck": [9, 12], "silent": 9, "callback": [9, 12], "reset_cach": [9, 12], "present": [9, 11], "iocclean": [9, 12], "clean_al": [9, 12], "everyth": [9, 13], "relat": 9, "clean_debug": [9, 12], "debug": [9, 12], "clean_imag": [9, 12], "imag": 9, "clean_jail": [9, 12], "respect": 9, "clean_releas": [9, 12], "clean_templ": [9, 12], "common": 9, "we": 9, "reus": 9, "boolean_prop_exist": [9, 12], "supplied_prop": 9, "props_to_check": 9, "_log": 9, "callback_except": 9, "helper": 9, "call": [9, 13], "appropri": [9, 10], "check_release_new": [9, 12], "raise_error": 9, "major_onli": 9, "greater": 9, "than": 9, "target": [0, 9], "check_truthi": [9, 12], "checkoutput": [9, 12], "arg": 9, "kwarg": 9, "just": [9, 16], "wrapper": 9, "utf": 9, "check_output": 9, "construct_truthi": [9, 12], "item": 9, "invers": 9, "truthi": 9, "variat": 9, "consume_and_log": [9, 12], "exec_gen": 9, "consum": [9, 10], "massag": 9, "copytre": [9, 12], "dst": 9, "ignor": 9, "overwrit": 9, "gen_nat_ip": [9, 12], "ip_prefix": 9, "effort": 9, "alloc": 9, "privat": 9, "gen_unused_lo_ip": [9, 12], "localhost": 9, "generate_devfs_ruleset": [9, 12], "includ": [3, 9, 14], "ruleset": [9, 14], "equal": 9, "devfs_ruleset": [9, 14], "get_active_jail": [9, 12], "get_host_gatewai": [9, 12], "get_host_releas": [9, 12], "sanit": 9, "get_jail_freebsd_vers": [9, 12], "get_jails_with_config": [9, 12], "filter": [9, 13], "mapping_func": 9, "get_name_sortkei": [9, 12], "get_natural_sortkei": [9, 12], "text": 9, "get_nested_kei": [9, 12], "_dict": 9, "kei": [9, 14], "nest": 9, "dictionari": [9, 14], "get_size_sortkei": [9, 12], "get_used_ip": [9, 12], "ifconfig": [9, 13], "everi": 9, "iterat": 9, "inus": 9, "ioc_sort": [9, 12], "caller": 9, "s_type": 9, "logit": [9, 12], "_callback": 9, "except": 9, "runtimeerror": 9, "our": 9, "lowercase_set": [9, 12], "match_to_dir": [9, 12], "old_uuid": 9, "dot": 9, "underscor": 9, "pattern": 9, "_": 9, "match": 9, "wa": [9, 10], "background": 9, "foo_bar": 9, "consid": [9, 13], "ident": 9, "cannot": [9, 13, 16], "coexist": 9, "open_atom": [9, 12], "filepath": 9, "temporari": 9, "atom": 9, "move": 9, "destin": 9, "upon": 9, "write": [5, 9], "filenam": 9, "fsync": 9, "whether": [9, 16], "disk": 9, "valid": [9, 14], "argument": [5, 9], "keyword": 9, "parse_latest_releas": [9, 12], "upstream": 9, "parse_package_nam": [9, 12], "raise_sort_error": [9, 12], "sort_list": 9, "retrieve_admin_port": [9, 12], "jail_run": 9, "admin_port": 9, "default_gatewai": 9, "full_ipv4_dict": 9, "retrieve_ip4_for_jail": [9, 12], "runscript": [9, 12], "custom_env": 9, "tupl": [5, 9], "stdout": 9, "last": 9, "stderr": 9, "set_interact": [9, 12], "tty": 9, "set_rcconf": [9, 12], "jail_path": 9, "sort_ava": [9, 12], "ava": 9, "sort": 9, "sort_boot": [9, 12], "sort_creat": [9, 12], "crt": 9, "sort_crt": [9, 12], "sort_ip": [9, 12], "sort_row": 9, "follow": [9, 13, 14], "dhcp": [9, 13, 14], "5": [9, 13], "accept_rtadv": 9, "obvious": 9, "forget": 9, "sort_ip6": [9, 12], "sort_jid": [9, 12], "jid": 9, "sort_kei": [9, 12], "sort_nam": [9, 12], "sort_qta": [9, 12], "qta": 9, "sort_releas": [9, 12], "split": 9, "fetch_releas": [9, 12], "sort_r": [9, 12], "rsize": 9, "sort_stat": [9, 12], "sort_templ": [9, 12], "sort_typ": [9, 12], "jail_typ": 9, "sort_us": [9, 12], "tempfil": [9, 12], "suffix": 9, "find": [9, 13, 16], "free": 9, "even": 9, "save": [9, 16], "tmp_dataset_check": [9, 12], "truthy_inverse_valu": [9, 12], "truthy_valu": [9, 12], "try_convert": [9, 12], "validate_plugin_manifest": [9, 12], "manifest": [9, 14], "ioccreat": [9, 12], "prop": 9, "num": 9, "config": 9, "short": [9, 11], "thickconfig": 9, "clone_basejail": 9, "create_config": [9, 12], "jail_uuid": 9, "source_templ": 9, "minim": 9, "self": 9, "create_install_packag": [9, 12], "repo": 9, "resolv": 9, "create_jail": [9, 12], "catch": 9, "sigint": 9, "create_rc": [9, 12], "host_hostnam": 9, "boilerpl": 9, "otherwis": [9, 11], "create_thickjail": [9, 12], "collect": 9, "iocdebug": [9, 12], "h": 9, "nsswitch": 9, "netstat": 9, "nr": 9, "run_debug": [9, 12], "run_host_debug": [9, 12], "run_jail_debug": [9, 12], "iocdestroi": [9, 12], "destroy_jail": [9, 12], "conveni": 9, "__stop_jails__": 9, "__destroy_parse_datasets__": 9, "commandfail": [9, 12], "messag": 9, "exceptionwithmsg": [9, 12], "commandneedsroot": [9, 12], "attribut": 9, "jailcorruptconfigur": [9, 12], "jailmisconfigur": [9, 12], "jailmissingconfigur": [9, 12], "jailrun": [9, 12], "poolnotactiv": [9, 12], "validationfail": [9, 12], "valuenotfound": [9, 12], "ignore_except": [9, 12], "suppress_except": 9, "exec": [9, 12, 13], "iocexec": [9, 12], "host_us": 9, "jail_us": 9, "unjail": 9, "skip": 9, "stdin_bytestr": 9, "su_env": 9, "decod": 9, "jexec": 9, "exec_jail": [9, 12], "flight_check": [9, 12], "interactiveexec": [9, 12], "silentexec": [9, 12], "iocfetch": [9, 12], "anonym": 9, "password": 9, "auth": 9, "root_dir": 9, "_file": 9, "verifi": [9, 13], "harden": 9, "txz": 9, "lib32": 9, "fetch_download": [9, 12], "_list": 9, "miss": 9, "fetch_extract": [9, 12], "f": [0, 9], "dest": 9, "fetch_http_releas": [9, 12], "xx": 9, "small": [9, 10], "fetch_upd": [9, 12], "update_progress": [9, 12], "progress": 9, "display_text": 9, "elaps": 9, "chunk_siz": 9, "origin": [9, 10], "stackoverflow": 9, "15860757": 9, "1391441": 9, "manipul": 9, "structur": [9, 14], "fs_file": [9, 12], "union": 9, "member": [9, 13], "fs_freq": [9, 12], "fs_mntop": [9, 12], "fs_passno": [9, 12], "fs_spec": [9, 12], "fs_type": [9, 12], "fs_vfstype": [9, 12], "iocfstab": [9, 12], "action": 9, "fstype": 9, "fsoption": 9, "fsdump": 9, "fspass": 9, "header": 9, "umount": 9, "fstab_list": [9, 12], "tabl": 9, "iocimag": [9, 12], "export_jail": [9, 12], "compression_algo": 9, "zip": 9, "import_jail": [9, 12], "convert": [9, 10, 16], "iocconfigur": [9, 12], "checking_dataset": 9, "backup_iocage_jail_conf": [9, 12], "check_config": [9, 12], "input": 9, "check_default_config": [9, 12], "check_jail_config": [9, 12], "fix_properti": [9, 12], "bad": 9, "previous": [9, 13], "fix": 9, "correct": 9, "equival": 9, "aren": 9, "config_vers": 9, "bump": 9, "static": 9, "get_mac_prefix": [9, 12], "get_pool_and_iocroot": [9, 12], "intern": 9, "get_vers": [9, 12], "json_writ": [9, 12], "retrieve_default_prop": [9, 12], "validate_mac_prefix": [9, 12], "mac_prefix": 9, "ioccpuset": [9, 12], "retrieve_cpu_set": [9, 12], "set_cpuset": [9, 12], "validate_cpuset_prop": [9, 12], "iocjson": [9, 12], "suppress_log": 9, "ucl": 9, "format": [5, 9], "default_only_prop": [9, 12], "nat_prefix": 9, "nat_interfac": 9, "nat_backend": 9, "get_full_config": [9, 12], "json_check_prop": [9, 12], "good": 9, "json_convert_from_ucl": [9, 12], "json_convert_from_zf": [9, 12], "json_get_valu": [9, 12], "json_load": [9, 12], "json_migrate_uuid_to_tag": [9, 12], "json_plugin_get_valu": [9, 12], "json_plugin_load": [9, 12], "json_plugin_set_valu": [9, 12], "json_set_valu": [9, 12], "_import": 9, "truthy_prop": [9, 12], "bpf": [3, 9, 14], "host_tim": 9, "rtsold": 9, "jail_zf": 9, "hostid_strict_check": 9, "exec_clean": 9, "mount_linprocf": 9, "mount_procf": 9, "allow_vmm": 9, "allow_tun": 9, "allow_socket_af": [3, 9], "allow_quota": 9, "allow_mount_zf": 9, "allow_mount_tmpf": 9, "allow_mount_procf": 9, "allow_mount_nullf": 9, "allow_mount_fusef": 9, "allow_mount_devf": [3, 9], "allow_mount_fdescf": 9, "allow_mount": [3, 9], "allow_mlock": 9, "allow_chflag": 9, "allow_raw_socket": [3, 9], "allow_sysvipc": 9, "allow_set_hostnam": 9, "mount_fdescf": 9, "mount_devf": 9, "ip6_saddrsel": 9, "ip4_saddrsel": 9, "ip_hostnam": 9, "assign_localhost": 9, "iocrctl": [9, 12], "rctl_rules_exist": [9, 12], "remove_rctl_rul": [9, 12], "set_rctl_rul": [9, 12], "coredumps": 9, "cputim": 9, "datas": 9, "maxproc": 9, "memorylock": 9, "msgqqueu": 9, "msgqsize": 9, "nmsgq": 9, "nsem": 9, "nsemop": 9, "nshm": 9, "nthr": 9, "openfil": 9, "pseudotermin": 9, "readbp": 9, "readiop": 9, "shmsize": 9, "stacksiz": 9, "swapus": 9, "vmemoryus": 9, "wallclock": 9, "writebp": 9, "writeiop": 9, "validate_rctl_prop": [9, 12], "validate_rctl_tun": [9, 12], "jailruntimeconfigur": [9, 12], "jail_nam": 9, "normalize_data": [9, 12], "sync_chang": [9, 12], "ioclist": [9, 12], "lst_type": 9, "hdr": 9, "_sort": 9, "quick": 9, "uid": 9, "ip4": 9, "list_al": [9, 12], "list_all_quick": [9, 12], "list_bas": [9, 12], "list_dataset": [9, 12], "classmethod": 9, "list_get_jid": [9, 12], "id": 9, "iocplugin": [9, 12], "branch": 9, "keep_jail_on_failur": 9, "respons": 9, "life": 9, "cycl": 9, "default_prop": [9, 12], "plugin_vers": [9, 12], "expand_abi_with_specified_releas": [9, 12], "packagesit": [9, 14], "fetch_plugin": [9, 12], "accept_licens": 9, "fetch_plugin_index": [9, 12], "list_head": 9, "list_long": 9, "icon": [9, 14], "offici": [9, 14], "index_onli": 9, "fetch_plugin_packagesit": [9, 12], "package_sit": 9, "fetch_plugin_vers": [9, 12], "fetch_plugin_versions_from_plugin_index": [9, 12], "plugins_index": 9, "pull_clone_git_repo": [9, 12], "depth": [9, 13], "retrieve_plugin_index_data": [9, 12], "plugin_index_path": 9, "expand_abi": 9, "retrieve_plugin_json": [9, 12], "start_rc": [9, 12], "stop_rc": [9, 12], "iocstart": [9, 12], "is_depend": 9, "unit_test": 9, "used_port": 9, "exec_": 9, "check_alias": [9, 12], "alia": [9, 13], "find_bridge_mtu": [9, 12], "get_bridge_memb": [9, 12], "get_default_gatewai": [9, 12], "address_famili": 9, "ipv4": [9, 13], "get_default_interfac": [9, 12], "start_copy_localtim": [9, 12], "start_generate_resolv": [9, 12], "start_network": [9, 12], "larg": [9, 10], "pass": [9, 13], "boolean": 9, "start_network_interface_vnet": [9, 12], "nic_def": 9, "net_config": 9, "nat_addr": 9, "separ": [9, 13], "nic": 9, "pair": 9, "start_network_vnet_addr": [9, 12], "ifac": 9, "defaultgw": 9, "error": 9, "occur": [9, 13], "start_network_vnet_ifac": [9, 12], "mtu": 9, "real": 9, "meat": 9, "potato": 9, "iocstop": [9, 12], "unmount": 9, "iocupgrad": [9, 12], "new_releas": 9, "upgrade_basejail": [9, 12], "snap_nam": 9, "upgrade_jail": [9, 12], "skip_jail": 9, "chroot": [9, 12], "deprec": 9, "d_type": 9, "count": 9, "_uuid": 9, "skip_batch": 9, "deactiv": [9, 12], "reduc": 9, "perfom": 9, "hit": 9, "destroy_releas": [9, 12], "ask": 9, "start_jail": 9, "msg_return": 9, "exec_al": [9, 12], "dump": 9, "_pass": 9, "add_path": 9, "import_": [9, 12], "new_nam": 9, "rollback": [9, 11, 12], "roll": 9, "snap_list": [9, 12], "gather": 9, "snap_remov": [9, 12], "patchset": 9, "update_al": [9, 12], "upgrade_al": [9, 12], "poolanddataset": [9, 12], "get_iocroot": [9, 12], "get_pool": [9, 12], "sever": 10, "benefit": 10, "drawback": 10, "serv": [10, 13], "varieti": 10, "uniqu": [10, 11], "describ": 10, "duplic": [10, 11], "amount": 10, "concept": 10, "popular": [10, 14], "littl": 10, "startup": 10, "ideal": 10, "further": 10, "satisfi": 10, "newexamplejail": 10, "unsupport": 10, "setup": [10, 12], "transmiss": [10, 13], "between": [10, 11, 13, 16], "send": 10, "receiv": 10, "length": 11, "histor": 11, "88": 11, "doe": [11, 13], "challeng": 11, "dive": 11, "tar": 11, "around": 11, "shorten": 11, "caus": [11, 13], "unexpect": [11, 13], "crash": [11, 13], "word": 11, "kill": 11, "workaround": 11, "stabl": 11, "machin": 11, "over": [11, 13], "100": [11, 14], "dai": 11, "uptim": 11, "p10": 11, "interest": 11, "queue": 11, "rout": [11, 13], "softwar": 11, "kernconf": 11, "unless": 11, "disabl": [11, 13], "altq_cbq": 11, "altq_r": 11, "altq_rio": 11, "altq_hfsc": 11, "altq_cdnr": 11, "altq_priq": 11, "2014": 11, "mail": 11, "post": 11, "ip6": 11, "defin": 11, "fail": 11, "happen": 11, "sysctl": [11, 13], "dad": 11, "detect": 11, "probe": 11, "packet": [11, 13], "net": [11, 13], "inet6": 11, "dad_count": 11, "perman": 11, "2013": 11, "fastentrypoint": 12, "iocage_cli": 12, "submodul": 12, "content": [12, 16], "iocage_lib": 12, "ioc_check": 12, "ioc_clean": 12, "ioc_common": 12, "ioc_creat": 12, "ioc_debug": 12, "ioc_destroi": 12, "ioc_except": 12, "ioc_exec": 12, "ioc_fetch": 12, "ioc_fstab": 12, "ioc_imag": 12, "ioc_json": 12, "ioc_list": 12, "ioc_plugin": 12, "ioc_start": 12, "ioc_stop": 12, "ioc_upgrad": 12, "conftest": 12, "data_class": 12, "better": [5, 13], "tradition": 13, "commun": 13, "typic": 13, "develop": [13, 14], "sometim": 13, "abstract": 13, "behav": 13, "physic": 13, "instruct": 13, "rest": 13, "along": 13, "adapt": 13, "placehold": 13, "comput": 13, "hardwar": 13, "compon": 13, "rock": 13, "solid": 13, "decad": 13, "heavi": 13, "few": 13, "step": 13, "examplejail1": 13, "off": 13, "direct": 13, "visibl": 13, "sctp": 13, "rebuild": 13, "nooption": 13, "stream": 13, "protocol": 13, "racct": 13, "rctl": 13, "On": 13, "node": 13, "cloned_interfac": 13, "bridge0": 13, "plumb": 13, "ifconfig_bridge0": 13, "addm": 13, "ifconfig_em0": 13, "tunabl": 13, "inet": 13, "forward": 13, "pfil_onlyip": 13, "pfil": 13, "pfil_bridg": 13, "pfil_memb": 13, "defaultrout": 13, "254": 13, "vnet0": 13, "ping": 13, "know": [13, 16], "vlan": 13, "parent": 13, "vlans_em0": 13, "666": 13, "ifconfig_em0_666": 13, "vnet_default_interfac": 13, "vnet1": 13, "bridge1": 13, "hand": 13, "ip6_addr": 13, "2001": 13, "123": 13, "456": 13, "242": 13, "defaultrouter6": 13, "impli": 13, "berklei": 13, "6": [3, 13], "regener": 13, "mac": 13, "hw": 13, "g": 13, "next": 13, "vnet0_mac": 13, "veri": 14, "fast": [5, 14], "applic": 14, "At": 14, "repeatedli": 14, "addition": 14, "extend": 14, "high": 14, "customiz": 14, "consist": 14, "png": 14, "pr": 14, "remot": 14, "modifi": [14, 16], "IF": 14, "manner": 14, "plexmediaserv": 14, "igb0": 14, "91": 14, "re0": 14, "individu": 14, "quasselcor": 14, "complet": 14, "freena": 14, "50": 14, "hello": 14, "world": 14, "exactli": 14, "default_jail_name_her": 14, "artifact": 14, "git_path_to_plugin_repo": 14, "nat_forward": 14, "tcp": 14, "7878": 14, "null": 14, "abi": 14, "fingerprint": 14, "sha256": 14, "b0170035af3acc5f3f3ae1859dc717101b4e6c1d0a794ad554928ca0cbb2f438": 14, "revis": 14, "translat": 14, "unhid": [3, 14], "dynam": 14, "ruleset_numb": 14, "include_valu": 14, "preciou": 16, "preconfigur": 16, "deploy": 16, "mytempl": 16, "php": 16, "jailfromtempl": 16, "sinc": 16, "wish": 16, "unaffect": 16, "thick": 16, "newtempl": 16, "get_arg": [5, 12], "monkei": 5, "setuptool": 5, "faster": 5, "console_script": 5, "mymodul": 5, "entry_funct": 5, "2016": 5, "aaron": 5, "christianson": 5, "ninjaaron": 5, "entry_point": 5, "implicit": [], "instanc": [], "declar": [], "idiom": [], "def": [], "cl": [], "arg1": [], "arg2": [], "deriv": [], "java": [], "want": 0, "staticmethod": [], "builtin": [], "allow_mount_linprocf": [3, 9], "allow_nfsd": 9, "devfsrules_jail_linux": 3, "devfsrules_hide_al": 3, "devfsrules_unhide_bas": 3, "devfsrules_unhide_login": 3, "tun": 3, "bookworm": 3, "allow_mount_linsysf": [3, 9], "yield": 5, "write_script": 5, "distribut": 5, "gui_script": 5}, "objects": {"": [[5, 0, 0, "-", "fastentrypoints"], [8, 0, 0, "-", "iocage_cli"], [9, 0, 0, "-", "iocage_lib"]], "fastentrypoints": [[5, 1, 1, "", "get_args"], [5, 1, 1, "", "main"]], "iocage_cli": [[8, 2, 1, "", "IOCLogger"], [8, 2, 1, "", "IOCageCLI"], [8, 2, 1, "", "InfoHandler"], [8, 0, 0, "-", "activate"], [8, 0, 0, "-", "chroot"], [8, 0, 0, "-", "clean"], [8, 0, 0, "-", "clone"], [8, 0, 0, "-", "console"], [8, 0, 0, "-", "create"], [8, 0, 0, "-", "debug"], [8, 0, 0, "-", "destroy"], [8, 0, 0, "-", "df"], [8, 0, 0, "-", "exec"], [8, 0, 0, "-", "export"], [8, 0, 0, "-", "fetch"], [8, 0, 0, "-", "fstab"], [8, 0, 0, "-", "get"], [8, 0, 0, "-", "import"], [8, 0, 0, "-", "list"], [8, 0, 0, "-", "migrate"], [8, 0, 0, "-", "pkg"], [8, 1, 1, "", "print_version"], [8, 0, 0, "-", "rename"], [8, 0, 0, "-", "restart"], [8, 0, 0, "-", "rollback"], [8, 0, 0, "-", "set"], [8, 0, 0, "-", "snaplist"], [8, 0, 0, "-", "snapremove"], [8, 0, 0, "-", "snapshot"], [8, 0, 0, "-", "start"], [8, 0, 0, "-", "stop"], [8, 0, 0, "-", "update"], [8, 0, 0, "-", "upgrade"]], "iocage_cli.IOCLogger": [[8, 3, 1, "", "setConsoleLogLevel"]], "iocage_cli.IOCageCLI": [[8, 3, 1, "", "get_command"], [8, 3, 1, "", "list_commands"]], "iocage_cli.InfoHandler": [[8, 3, 1, "", "emit"]], "iocage_cli.clone": [[8, 1, 1, "", "validate_count"]], "iocage_cli.create": [[8, 1, 1, "", "validate_count"]], "iocage_cli.destroy": [[8, 1, 1, "", "child_test"]], "iocage_cli.fetch": [[8, 1, 1, "", "validate_count"]], "iocage_lib": [[9, 0, 0, "-", "ioc_check"], [9, 0, 0, "-", "ioc_clean"], [9, 0, 0, "-", "ioc_common"], [9, 0, 0, "-", "ioc_create"], [9, 0, 0, "-", "ioc_debug"], [9, 0, 0, "-", "ioc_destroy"], [9, 0, 0, "-", "ioc_exceptions"], [9, 0, 0, "-", "ioc_exec"], [9, 0, 0, "-", "ioc_fetch"], [9, 0, 0, "-", "ioc_fstab"], [9, 0, 0, "-", "ioc_image"], [9, 0, 0, "-", "ioc_json"], [9, 0, 0, "-", "ioc_list"], [9, 0, 0, "-", "ioc_plugin"], [9, 0, 0, "-", "ioc_start"], [9, 0, 0, "-", "ioc_stop"], [9, 0, 0, "-", "ioc_upgrade"], [9, 0, 0, "-", "iocage"]], "iocage_lib.ioc_check": [[9, 2, 1, "", "IOCCheck"]], "iocage_lib.ioc_clean": [[9, 2, 1, "", "IOCClean"]], "iocage_lib.ioc_clean.IOCClean": [[9, 3, 1, "", "clean_all"], [9, 3, 1, "", "clean_debug"], [9, 3, 1, "", "clean_images"], [9, 3, 1, "", "clean_jails"], [9, 3, 1, "", "clean_releases"], [9, 3, 1, "", "clean_templates"]], "iocage_lib.ioc_common": [[9, 1, 1, "", "boolean_prop_exists"], [9, 1, 1, "", "callback"], [9, 1, 1, "", "check_release_newer"], [9, 1, 1, "", "check_truthy"], [9, 1, 1, "", "checkoutput"], [9, 1, 1, "", "construct_truthy"], [9, 1, 1, "", "consume_and_log"], [9, 1, 1, "", "copytree"], [9, 1, 1, "", "gen_nat_ip"], [9, 1, 1, "", "gen_unused_lo_ip"], [9, 1, 1, "", "generate_devfs_ruleset"], [9, 1, 1, "", "get_active_jails"], [9, 1, 1, "", "get_host_gateways"], [9, 1, 1, "", "get_host_release"], [9, 1, 1, "", "get_jail_freebsd_version"], [9, 1, 1, "", "get_jails_with_config"], [9, 1, 1, "", "get_name_sortkey"], [9, 1, 1, "", "get_natural_sortkey"], [9, 1, 1, "", "get_nested_key"], [9, 1, 1, "", "get_size_sortkey"], [9, 1, 1, "", "get_used_ips"], [9, 1, 1, "", "ioc_sort"], [9, 1, 1, "", "logit"], [9, 1, 1, "", "lowercase_set"], [9, 1, 1, "", "match_to_dir"], [9, 1, 1, "", "open_atomic"], [9, 1, 1, "", "parse_latest_release"], [9, 1, 1, "", "parse_package_name"], [9, 1, 1, "", "raise_sort_error"], [9, 1, 1, "", "retrieve_admin_portals"], [9, 1, 1, "", "retrieve_ip4_for_jail"], [9, 1, 1, "", "runscript"], [9, 1, 1, "", "set_interactive"], [9, 1, 1, "", "set_rcconf"], [9, 1, 1, "", "sort_ava"], [9, 1, 1, "", "sort_boot"], [9, 1, 1, "", "sort_created"], [9, 1, 1, "", "sort_crt"], [9, 1, 1, "", "sort_ip"], [9, 1, 1, "", "sort_ip6"], [9, 1, 1, "", "sort_jid"], [9, 1, 1, "", "sort_key"], [9, 1, 1, "", "sort_name"], [9, 1, 1, "", "sort_qta"], [9, 1, 1, "", "sort_release"], [9, 1, 1, "", "sort_res"], [9, 1, 1, "", "sort_state"], [9, 1, 1, "", "sort_template"], [9, 1, 1, "", "sort_type"], [9, 1, 1, "", "sort_use"], [9, 1, 1, "", "tempfile"], [9, 1, 1, "", "tmp_dataset_checks"], [9, 1, 1, "", "truthy_inverse_values"], [9, 1, 1, "", "truthy_values"], [9, 1, 1, "", "try_convert"], [9, 1, 1, "", "validate_plugin_manifest"]], "iocage_lib.ioc_create": [[9, 2, 1, "", "IOCCreate"]], "iocage_lib.ioc_create.IOCCreate": [[9, 3, 1, "", "create_config"], [9, 3, 1, "", "create_install_packages"], [9, 3, 1, "", "create_jail"], [9, 3, 1, "", "create_rc"], [9, 3, 1, "", "create_thickjail"]], "iocage_lib.ioc_debug": [[9, 2, 1, "", "IOCDebug"]], "iocage_lib.ioc_debug.IOCDebug": [[9, 3, 1, "", "run_debug"], [9, 3, 1, "", "run_host_debug"], [9, 3, 1, "", "run_jail_debug"]], "iocage_lib.ioc_destroy": [[9, 2, 1, "", "IOCDestroy"]], "iocage_lib.ioc_destroy.IOCDestroy": [[9, 3, 1, "", "destroy_jail"]], "iocage_lib.ioc_exceptions": [[9, 4, 1, "", "CommandFailed"], [9, 4, 1, "", "CommandNeedsRoot"], [9, 4, 1, "", "ExceptionWithMsg"], [9, 4, 1, "", "Exists"], [9, 4, 1, "", "JailCorruptConfiguration"], [9, 4, 1, "", "JailMisconfigured"], [9, 4, 1, "", "JailMissingConfiguration"], [9, 4, 1, "", "JailRunning"], [9, 4, 1, "", "PoolNotActivated"], [9, 4, 1, "", "ValidationFailed"], [9, 4, 1, "", "ValueNotFound"], [9, 1, 1, "", "ignore_exceptions"]], "iocage_lib.ioc_exec": [[9, 2, 1, "", "IOCExec"], [9, 2, 1, "", "InteractiveExec"], [9, 2, 1, "", "SilentExec"]], "iocage_lib.ioc_exec.IOCExec": [[9, 3, 1, "", "exec_jail"], [9, 3, 1, "", "flight_checks"]], "iocage_lib.ioc_fetch": [[9, 2, 1, "", "IOCFetch"]], "iocage_lib.ioc_fetch.IOCFetch": [[9, 3, 1, "", "fetch_download"], [9, 3, 1, "", "fetch_extract"], [9, 3, 1, "", "fetch_http_release"], [9, 3, 1, "", "fetch_release"], [9, 3, 1, "", "fetch_update"], [9, 3, 1, "", "update_progress"]], "iocage_lib.ioc_fstab": [[9, 2, 1, "", "Fstab"], [9, 2, 1, "", "IOCFstab"]], "iocage_lib.ioc_fstab.Fstab": [[9, 5, 1, "", "fs_file"], [9, 5, 1, "", "fs_freq"], [9, 5, 1, "", "fs_mntops"], [9, 5, 1, "", "fs_passno"], [9, 5, 1, "", "fs_spec"], [9, 5, 1, "", "fs_type"], [9, 5, 1, "", "fs_vfstype"]], "iocage_lib.ioc_fstab.IOCFstab": [[9, 3, 1, "", "fstab_list"]], "iocage_lib.ioc_image": [[9, 2, 1, "", "IOCImage"]], "iocage_lib.ioc_image.IOCImage": [[9, 3, 1, "", "export_jail"], [9, 3, 1, "", "import_jail"]], "iocage_lib.ioc_json": [[9, 2, 1, "", "IOCConfiguration"], [9, 2, 1, "", "IOCCpuset"], [9, 2, 1, "", "IOCJson"], [9, 2, 1, "", "IOCRCTL"], [9, 2, 1, "", "JailRuntimeConfiguration"]], "iocage_lib.ioc_json.IOCConfiguration": [[9, 3, 1, "", "backup_iocage_jail_conf"], [9, 3, 1, "", "check_config"], [9, 3, 1, "", "check_default_config"], [9, 3, 1, "", "check_jail_config"], [9, 3, 1, "", "fix_properties"], [9, 3, 1, "", "get_mac_prefix"], [9, 3, 1, "", "get_pool_and_iocroot"], [9, 3, 1, "", "get_version"], [9, 3, 1, "", "json_write"], [9, 3, 1, "", "retrieve_default_props"], [9, 3, 1, "", "validate_mac_prefix"]], "iocage_lib.ioc_json.IOCCpuset": [[9, 3, 1, "", "retrieve_cpu_sets"], [9, 3, 1, "", "set_cpuset"], [9, 3, 1, "", "validate_cpuset_prop"]], "iocage_lib.ioc_json.IOCJson": [[9, 5, 1, "", "default_only_props"], [9, 3, 1, "", "get_full_config"], [9, 3, 1, "", "json_check_prop"], [9, 3, 1, "", "json_convert_from_ucl"], [9, 3, 1, "", "json_convert_from_zfs"], [9, 3, 1, "", "json_get_value"], [9, 3, 1, "", "json_load"], [9, 3, 1, "", "json_migrate_uuid_to_tag"], [9, 3, 1, "", "json_plugin_get_value"], [9, 3, 1, "", "json_plugin_load"], [9, 3, 1, "", "json_plugin_set_value"], [9, 3, 1, "", "json_set_value"], [9, 5, 1, "", "truthy_props"]], "iocage_lib.ioc_json.IOCRCTL": [[9, 3, 1, "", "rctl_rules_exist"], [9, 3, 1, "", "remove_rctl_rules"], [9, 3, 1, "", "set_rctl_rules"], [9, 5, 1, "", "types"], [9, 3, 1, "", "validate_rctl_props"], [9, 3, 1, "", "validate_rctl_tunable"]], "iocage_lib.ioc_json.JailRuntimeConfiguration": [[9, 3, 1, "", "normalize_data"], [9, 6, 1, "", "path"], [9, 3, 1, "", "remove"], [9, 3, 1, "", "set"], [9, 3, 1, "", "sync_changes"]], "iocage_lib.ioc_list": [[9, 2, 1, "", "IOCList"]], "iocage_lib.ioc_list.IOCList": [[9, 3, 1, "", "list_all"], [9, 3, 1, "", "list_all_quick"], [9, 3, 1, "", "list_bases"], [9, 3, 1, "", "list_datasets"], [9, 3, 1, "", "list_get_jid"]], "iocage_lib.ioc_plugin": [[9, 2, 1, "", "IOCPlugin"]], "iocage_lib.ioc_plugin.IOCPlugin": [[9, 5, 1, "", "DEFAULT_PROPS"], [9, 5, 1, "", "PLUGIN_VERSION"], [9, 3, 1, "", "expand_abi_with_specified_release"], [9, 3, 1, "", "fetch_plugin"], [9, 3, 1, "", "fetch_plugin_index"], [9, 3, 1, "", "fetch_plugin_packagesites"], [9, 3, 1, "", "fetch_plugin_versions"], [9, 3, 1, "", "fetch_plugin_versions_from_plugin_index"], [9, 3, 1, "", "pull_clone_git_repo"], [9, 3, 1, "", "retrieve_plugin_index_data"], [9, 3, 1, "", "retrieve_plugin_json"], [9, 3, 1, "", "start_rc"], [9, 3, 1, "", "stop_rc"], [9, 3, 1, "", "update"], [9, 3, 1, "", "upgrade"]], "iocage_lib.ioc_start": [[9, 2, 1, "", "IOCStart"]], "iocage_lib.ioc_start.IOCStart": [[9, 3, 1, "", "check_aliases"], [9, 3, 1, "", "find_bridge_mtu"], [9, 3, 1, "", "get_bridge_members"], [9, 3, 1, "", "get_default_gateway"], [9, 3, 1, "", "get_default_interface"], [9, 3, 1, "", "start_copy_localtime"], [9, 3, 1, "", "start_generate_resolv"], [9, 3, 1, "", "start_network"], [9, 3, 1, "", "start_network_interface_vnet"], [9, 3, 1, "", "start_network_vnet_addr"], [9, 3, 1, "", "start_network_vnet_iface"]], "iocage_lib.ioc_stop": [[9, 2, 1, "", "IOCStop"]], "iocage_lib.ioc_upgrade": [[9, 2, 1, "", "IOCUpgrade"]], "iocage_lib.ioc_upgrade.IOCUpgrade": [[9, 3, 1, "", "upgrade_basejail"], [9, 3, 1, "", "upgrade_jail"]], "iocage_lib.iocage": [[9, 2, 1, "", "IOCage"], [9, 2, 1, "", "PoolAndDataset"]], "iocage_lib.iocage.IOCage": [[9, 3, 1, "", "activate"], [9, 3, 1, "", "chroot"], [9, 3, 1, "", "clean"], [9, 3, 1, "", "create"], [9, 3, 1, "", "deactivate"], [9, 3, 1, "", "debug"], [9, 3, 1, "", "destroy_jail"], [9, 3, 1, "", "destroy_release"], [9, 3, 1, "", "df"], [9, 3, 1, "", "exec"], [9, 3, 1, "", "exec_all"], [9, 3, 1, "", "export"], [9, 3, 1, "", "fetch"], [9, 3, 1, "", "fstab"], [9, 3, 1, "", "get"], [9, 3, 1, "", "import_"], [9, 3, 1, "", "list"], [9, 3, 1, "", "rename"], [9, 3, 1, "", "reset_cache"], [9, 3, 1, "", "restart"], [9, 3, 1, "", "rollback"], [9, 3, 1, "", "set"], [9, 3, 1, "", "snap_list"], [9, 3, 1, "", "snap_remove"], [9, 3, 1, "", "snapshot"], [9, 3, 1, "", "start"], [9, 3, 1, "", "stop"], [9, 3, 1, "", "update"], [9, 3, 1, "", "update_all"], [9, 3, 1, "", "upgrade"], [9, 3, 1, "", "upgrade_all"]], "iocage_lib.iocage.PoolAndDataset": [[9, 3, 1, "", "get_iocroot"], [9, 3, 1, "", "get_pool"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method", "4": "py:exception", "5": "py:attribute", "6": "py:property"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "exception", "Python exception"], "5": ["py", "attribute", "Python attribute"], "6": ["py", "property", "Python property"]}, "titleterms": {"advanc": 0, "usag": [0, 1], "clone": [0, 8, 10], "creat": [0, 1, 3, 7, 8], "promot": 0, "updat": [0, 7, 8], "jail": [0, 1, 3, 6, 7, 10, 13], "upgrad": [0, 7, 8], "auto": 0, "boot": 0, "prioriti": 0, "depend": 0, "properti": [0, 1], "snapshot": [0, 8], "manag": [0, 6], "resourc": 0, "limit": [0, 11], "legaci": 0, "onli": 0, "core": 0, "thread": 0, "list": [0, 1, 8], "appli": 0, "dram": 0, "us": [0, 7, 13, 16], "turn": 0, "check": 0, "cpu": 0, "automat": 0, "packag": [0, 7, 8, 9, 17], "instal": [0, 7], "basic": 1, "set": [1, 8], "environ": 1, "variabl": 1, "iocag": [1, 6, 7, 9, 12], "activ": [1, 8], "fetch": [1, 8], "releas": [1, 7], "start": [1, 7, 8], "stop": [1, 8], "restart": [1, 8], "configur": [1, 13], "get": [1, 8], "all": 1, "destroi": [1, 8], "renam": [1, 8], "best": 2, "practic": 2, "debian": 3, "buster": 3, "nativ": 3, "linux": 3, "faq": 4, "fastentrypoint": 5, "modul": [5, 8, 9, 15, 17], "A": 6, "freebsd": 6, "document": 6, "indic": 6, "tabl": 6, "binari": 7, "github": 7, "pkg": [7, 8], "8": 7, "build": 7, "port": 7, "from": 7, "iocage_legaci": 7, "migrat": [7, 8], "ezjail": 7, "target": 7, "copi": 7, "old": 7, "data": 7, "popul": 7, "config": 7, "json": 7, "ip": [7, 13], "address": 7, "new": 7, "option": 7, "fstab": [7, 8], "iocage_cli": 8, "submodul": [8, 9, 17], "chroot": 8, "clean": 8, "consol": 8, "debug": 8, "df": 8, "exec": 8, "export": 8, "import": 8, "rollback": 8, "snaplist": 8, "snapremov": 8, "content": [8, 9, 17], "iocage_lib": 9, "ioc_check": 9, "ioc_clean": 9, "ioc_common": 9, "paramet": 9, "ioc_creat": 9, "ioc_debug": 9, "ioc_destroi": 9, "ioc_except": 9, "ioc_exec": 9, "ioc_fetch": 9, "ioc_fstab": 9, "ioc_imag": 9, "ioc_json": 9, "ioc_list": 9, "ioc_plugin": 9, "ioc_start": 9, "ioc_stop": 9, "ioc_upgrad": 9, "type": 10, "default": 10, "basejail": 10, "templat": [10, 16], "empti": 10, "thickjail": 10, "known": 11, "issu": 11, "mount": 11, "path": 11, "vnet": [11, 13], "vimag": [11, 13], "w": 11, "altq": 11, "ipv6": 11, "host": 11, "bind": 11, "failur": 11, "network": 13, "share": 13, "tip": 13, "interfac": 13, "plugin": 14, "setup": 15, "test": 17, "conftest": 17, "data_class": 17}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"Advanced Usage": [[0, "advanced-usage"]], "Clones": [[0, "clones"]], "Create a Clone": [[0, "create-a-clone"]], "Promoting a Clone": [[0, "promoting-a-clone"]], "Updating Jails": [[0, "updating-jails"]], "Upgrading Jails": [[0, "upgrading-jails"]], "Auto-boot": [[0, "auto-boot"]], "Boot Priority": [[0, "boot-priority"]], "Depends Property": [[0, "depends-property"]], "Snapshot Management": [[0, "snapshot-management"]], "Resource Limits (Legacy ONLY)": [[0, "resource-limits-legacy-only"]], "Limit Cores or Threads": [[0, "limit-cores-or-threads"]], "List Applied Limits": [[0, "list-applied-limits"]], "Limit DRAM use": [[0, "limit-dram-use"]], "Turn on Resource Limits": [[0, "turn-on-resource-limits"]], "Apply limits": [[0, "apply-limits"]], "Check Limits": [[0, "check-limits"]], "Limit CPU Usage by %": [[0, "limit-cpu-usage-by"]], "Automatic Package Installation": [[0, "automatic-package-installation"]], "Basic Usage": [[1, "basic-usage"]], "Setting Environment Variables": [[1, "setting-environment-variables"]], "iocage Environment Variables": [[1, "id11"]], "Activate iocage": [[1, "activate-iocage"]], "Fetch a Release": [[1, "fetch-a-release"]], "Create a Jail": [[1, "create-a-jail"]], "Listing Jails": [[1, "listing-jails"]], "Start, Stop, or Restart a Jail": [[1, "start-stop-or-restart-a-jail"]], "Start": [[1, "start"]], "Stop": [[1, "stop"]], "Restart": [[1, "restart"]], "Configure a Jail": [[1, "configure-a-jail"]], "Set Jail Property": [[1, "set-jail-property"]], "Get Jail Property": [[1, "get-jail-property"]], "Get all properties:": [[1, "get-all-properties"]], "Destroy a Jail": [[1, "destroy-a-jail"]], "Rename a Jail": [[1, "rename-a-jail"]], "Best Practices": [[2, "best-practices"]], "Create a Debian Buster Jail (native Linux)": [[3, "create-a-debian-buster-jail-native-linux"]], "FAQ": [[4, "faq"]], "fastentrypoints module": [[5, "module-fastentrypoints"]], "iocage - A FreeBSD Jail Manager": [[6, "iocage-a-freebsd-jail-manager"]], "Documentation:": [[6, "documentation"]], "Indices and tables": [[6, "indices-and-tables"]], "Install iocage": [[7, "install-iocage"]], "Using binary packages": [[7, "using-binary-packages"]], "Using github": [[7, "using-github"]], "Using pkg(8)": [[7, "using-pkg-8"]], "Building Ports": [[7, "building-ports"]], "Upgrading from iocage_legacy": [[7, "upgrading-from-iocage-legacy"]], "Migrating from Ezjail to Iocage": [[7, "migrating-from-ezjail-to-iocage"]], "Create Target": [[7, "create-target"]], "Copy Old Data": [[7, "copy-old-data"]], "Populate iocage config.json": [[7, "populate-iocage-config-json"]], "Release": [[7, "release"]], "IP Address": [[7, "ip-address"]], "Start the New Jail": [[7, "start-the-new-jail"]], "(Optional) Update fstab": [[7, "optional-update-fstab"]], "iocage_cli package": [[8, "iocage-cli-package"]], "Submodules": [[8, "submodules"], [9, "submodules"], [17, "submodules"]], "iocage_cli.activate module": [[8, "module-iocage_cli.activate"]], "iocage_cli.chroot module": [[8, "module-iocage_cli.chroot"]], "iocage_cli.clean module": [[8, "module-iocage_cli.clean"]], "iocage_cli.clone module": [[8, "module-iocage_cli.clone"]], "iocage_cli.console module": [[8, "module-iocage_cli.console"]], "iocage_cli.create module": [[8, "module-iocage_cli.create"]], "iocage_cli.debug module": [[8, "module-iocage_cli.debug"]], "iocage_cli.destroy module": [[8, "module-iocage_cli.destroy"]], "iocage_cli.df module": [[8, "module-iocage_cli.df"]], "iocage_cli.exec module": [[8, "module-iocage_cli.exec"]], "iocage_cli.export module": [[8, "module-iocage_cli.export"]], "iocage_cli.fetch module": [[8, "module-iocage_cli.fetch"]], "iocage_cli.fstab module": [[8, "module-iocage_cli.fstab"]], "iocage_cli.get module": [[8, "module-iocage_cli.get"]], "iocage_cli.import module": [[8, "module-iocage_cli.import"]], "iocage_cli.list module": [[8, "module-iocage_cli.list"]], "iocage_cli.migrate module": [[8, "module-iocage_cli.migrate"]], "iocage_cli.pkg module": [[8, "module-iocage_cli.pkg"]], "iocage_cli.rename module": [[8, "module-iocage_cli.rename"]], "iocage_cli.restart module": [[8, "module-iocage_cli.restart"]], "iocage_cli.rollback module": [[8, "module-iocage_cli.rollback"]], "iocage_cli.set module": [[8, "module-iocage_cli.set"]], "iocage_cli.snaplist module": [[8, "module-iocage_cli.snaplist"]], "iocage_cli.snapremove module": [[8, "module-iocage_cli.snapremove"]], "iocage_cli.snapshot module": [[8, "module-iocage_cli.snapshot"]], "iocage_cli.start module": [[8, "module-iocage_cli.start"]], "iocage_cli.stop module": [[8, "module-iocage_cli.stop"]], "iocage_cli.update module": [[8, "module-iocage_cli.update"]], "iocage_cli.upgrade module": [[8, "module-iocage_cli.upgrade"]], "Module contents": [[8, "module-iocage_cli"], [9, "module-iocage_lib"], [17, "module-contents"]], "iocage_lib package": [[9, "iocage-lib-package"]], "iocage_lib.ioc_check module": [[9, "module-iocage_lib.ioc_check"]], "iocage_lib.ioc_clean module": [[9, "module-iocage_lib.ioc_clean"]], "iocage_lib.ioc_common module": [[9, "module-iocage_lib.ioc_common"]], "Parameters": [[9, "parameters"], [9, "id5"]], "iocage_lib.ioc_create module": [[9, "module-iocage_lib.ioc_create"]], "iocage_lib.ioc_debug module": [[9, "module-iocage_lib.ioc_debug"]], "iocage_lib.ioc_destroy module": [[9, "module-iocage_lib.ioc_destroy"]], "iocage_lib.ioc_exceptions module": [[9, "module-iocage_lib.ioc_exceptions"]], "iocage_lib.ioc_exec module": [[9, "module-iocage_lib.ioc_exec"]], "iocage_lib.ioc_fetch module": [[9, "module-iocage_lib.ioc_fetch"]], "iocage_lib.ioc_fstab module": [[9, "module-iocage_lib.ioc_fstab"]], "iocage_lib.ioc_image module": [[9, "module-iocage_lib.ioc_image"]], "iocage_lib.ioc_json module": [[9, "module-iocage_lib.ioc_json"]], "iocage_lib.ioc_list module": [[9, "module-iocage_lib.ioc_list"]], "iocage_lib.ioc_plugin module": [[9, "module-iocage_lib.ioc_plugin"]], "iocage_lib.ioc_start module": [[9, "module-iocage_lib.ioc_start"]], "iocage_lib.ioc_stop module": [[9, "module-iocage_lib.ioc_stop"]], "iocage_lib.ioc_upgrade module": [[9, "module-iocage_lib.ioc_upgrade"]], "iocage_lib.iocage module": [[9, "module-iocage_lib.iocage"]], "Jail Types": [[10, "jail-types"]], "Clone (default)": [[10, "clone-default"]], "Basejail": [[10, "basejail"]], "Template": [[10, "template"]], "Empty": [[10, "empty"]], "Thickjail": [[10, "thickjail"]], "Known Issues": [[11, "known-issues"]], "Mount Path Limit": [[11, "mount-path-limit"]], "VNET/VIMAGE Issues": [[11, "vnet-vimage-issues"]], "VNET/VIMAGE issues w/ ALTQ": [[11, "vnet-vimage-issues-w-altq"]], "IPv6 host bind failures": [[11, "ipv6-host-bind-failures"]], "iocage": [[12, "iocage"]], "Networking": [[13, "networking"]], "Shared IP": [[13, "shared-ip"]], "Using Shared IP": [[13, "using-shared-ip"]], "VIMAGE/VNET": [[13, "vimage-vnet"]], "Tips": [[13, "tips"]], "Configuring Network Interfaces": [[13, "configuring-network-interfaces"]], "Configuring a Shared IP Jail": [[13, "configuring-a-shared-ip-jail"]], "Configuring a VNET Jail": [[13, "configuring-a-vnet-jail"]], "Tips for Configuring VNET": [[13, "tips-for-configuring-vnet"]], "Plugins": [[14, "plugins"]], "Using Templates": [[16, "using-templates"]], "setup module": [[15, "setup-module"]], "tests package": [[17, "tests-package"]], "tests.conftest module": [[17, "tests-conftest-module"]], "tests.data_classes module": [[17, "tests-data-classes-module"]]}, "indexentries": {}}) \ No newline at end of file diff --git a/docs/setup.html b/docs/setup.html new file mode 100644 index 00000000..d4107f35 --- /dev/null +++ b/docs/setup.html @@ -0,0 +1,106 @@ + + + + + + + + + setup module — iocage 1.9 documentation + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+

setup module

+
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/templates.html b/docs/templates.html new file mode 100644 index 00000000..b799ecfb --- /dev/null +++ b/docs/templates.html @@ -0,0 +1,186 @@ + + + + + + + + + Using Templates — iocage 1.9 documentation + + + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+

Using Templates

+

Templates can save precious time!

+

Set up a jail and create a template from it. All packages and +preconfigured settings remain available for deployment to new jails +within seconds.

+

Any jail can be converted between jail and template as needed. +Essentially, a template is just another jail which has the property +template set to yes. The difference is templates are not started +by iocage.

+

Create a template with iocage:

+
    +

  1. Create a jail: # iocage create -r 11.0-RELEASE -n mytemplate.

    2. +

  2. Configure the jail’s networking.

    3. +

  3. Install packages and/or customize the jail as needed.

    4. +

  4. Once finished with customization, stop the jail: +# iocage stop mytemplate.

    5. +

  5. It is recommended to add notes to the jail, so the specific jail +customizations are easily remembered: +# iocage set notes="customized PHP,nginx jail" mytemplate

    6. +

  6. Set the template property on: +# iocage set template=yes mytemplate.

    7. +

  7. Find the new template with iocage list -t.

    8. +
+

Use the created template:

+

Use iocage create -t to create a new jail from the new +template:

+
    +

  1. # iocage create -t mytemplate -n jailfromtemplate

    2. +

  2. Find the new jail with iocage list.

    3. +

  3. Start the jail with # iocage start jailfromtemplate.

    4. +
+

Done!

+

Customizing a template:

+

To make changes to the template, you will need to know whether any existing +jails are based on the template. Since modifying the template will require +converting it back into a jail, it cannot be the base for any jails.

+

* No jails based on the template *

+
    +

  1. Convert the template back into a jail:

    +

    iocage set template=no [UUID | NAME].

    +
    2. +

  2. Start the jail:

    +

    iocage start [UUID | NAME].

    +
    3. +

  3. Use any method you wish to connect to the jail and modify its contents.

    4. +

  4. Stop the jail:

    +

    iocage stop [UUID | NAME].

    +
    5. +

  5. Convert the jail back into a template:

    +

    iocage set template=yes [UUID | NAME].

    +
    6. +
+

* Jails based on the template *

+

This process will create a new template, leaving the existing template +and jails unaffected.

+
    +

  1. Create a ‘thick’ jail from the template, so that it will be independent +from the template:

    +

    iocage create -T -t [UUID | NAME] -n newtemplate.

    +
    2. +

  2. Start the jail:

    +

    iocage start newtemplate.

    +
    3. +

  3. Use any method you wish to connect to the jail and modify its contents.

    4. +

  4. Stop the jail:

    +

    iocage stop newtemplate.

    +
    5. +

  5. Convert the jail into a template:

    +

    iocage set template=yes newtemplate.

    +
    6. +
+
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ previous | + next | + modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/tests.html b/docs/tests.html new file mode 100644 index 00000000..25df203f --- /dev/null +++ b/docs/tests.html @@ -0,0 +1,118 @@ + + + + + + + + + tests package — iocage 1.9 documentation + + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+

tests package

+
+

Submodules

+
+
+

tests.conftest module

+
+
+

tests.data_classes module

+
+
+

Module contents

+
+
+ + +
+
+
+
+
+
+ +

Table of Contents

+ + +
+

Search

+
+ + +
+
+ +
+
+
+
+ +
+
+
+
+ modules | + index +
+
+
+
+ +
+ + +
+
+
+
+ + + \ No newline at end of file