summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-classes.xml38
-rw-r--r--documentation/ref-manual/ref-variables.xml34
2 files changed, 72 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 7124c49560..9752767c69 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -535,6 +535,44 @@
535 </para> 535 </para>
536</section> 536</section>
537 537
538<section id='ref-classes-extrausers'>
539 <title><filename>extrausers.bbclass</filename></title>
540
541 <para>
542 The extra users (<filename>extrausers</filename>) class allows
543 additional user and group configuration to be applied at the image
544 level.
545 Inheriting this class either globally or from an image recipe allows
546 additional user and group operations to be performed using the
547 <link linkend='var-EXTRA_USERS_PARAMS'><filename>EXTRA_USERS_PARAMS</filename></link>
548 variable.
549 <note>
550 The user and group operations added using the
551 <filename>extrausers</filename> class are not tied to a specific
552 recipe but can be performed across the image as a whole.
553 See the
554 <link linkend='ref-classes-useradd'><filename>useradd</filename></link>
555 class for information on how to add user and group configuration
556 to a specific recipe.
557 </note>
558 </para>
559
560 <para>
561 Here is an example that uses this class in an image recipe:
562 <literallayout class='monospaced'>
563 inherit extrausers
564 EXTRA_USERS_PARAMS = "\
565 useradd -p '' tester; \
566 groupadd developers; \
567 userdel nobody; \
568 groupdel -g video; \
569 groupmod -g 1020 developers; \
570 usermod -s /bin/sh tester; \
571 "
572 </literallayout>
573 </para>
574</section>
575
538<section id='ref-classes-debian'> 576<section id='ref-classes-debian'>
539 <title>Debian Renaming - <filename>debian.bbclass</filename></title> 577 <title>Debian Renaming - <filename>debian.bbclass</filename></title>
540 578
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 22a0505523..70d510887a 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -1788,6 +1788,40 @@
1788 </glossdef> 1788 </glossdef>
1789 </glossentry> 1789 </glossentry>
1790 1790
1791 <glossentry id='var-EXTRA_USERS_PARAMS'><glossterm>EXTRA_USERS_PARAMS</glossterm>
1792 <glossdef>
1793 <para>
1794 When a recipe inherits the
1795 <link linkend='ref-classes-extrausers'><filename>extrausers</filename></link>
1796 class, this variable provides image level user and group
1797 operations.
1798 This is a more global method of providing user and group
1799 configuration as compared to using the
1800 <link linkend='ref-classes-useradd'><filename>useradd</filename></link>
1801 class, which ties user and group configurations to a
1802 specific recipe.
1803 </para>
1804
1805 <para>
1806 The set list of commands you can configure using the
1807 <filename>EXTRA_USERS_PARAMS</filename> is shown in the
1808 <filename>extrausers</filename> class.
1809 These commands map to the normal Unix commands of the same
1810 names:
1811 <literallayout class='monospaced'>
1812 # EXTRA_USERS_PARAMS = "\
1813 # useradd -p '' tester; \
1814 # groupadd developers; \
1815 # userdel nobody; \
1816 # groupdel -g video; \
1817 # groupmod -g 1020 developers; \
1818 # usermod -s /bin/sh tester; \
1819 # "
1820 </literallayout>
1821 </para>
1822 </glossdef>
1823 </glossentry>
1824
1791 </glossdiv> 1825 </glossdiv>
1792 1826
1793 <glossdiv id='var-glossary-f'><title>F</title> 1827 <glossdiv id='var-glossary-f'><title>F</title>