summaryrefslogtreecommitdiffstats
path: root/scripts/lib/image/help.py
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/lib/image/help.py')
-rw-r--r--scripts/lib/image/help.py114
1 files changed, 114 insertions, 0 deletions
diff --git a/scripts/lib/image/help.py b/scripts/lib/image/help.py
index bf2f773266..a7e7830a65 100644
--- a/scripts/lib/image/help.py
+++ b/scripts/lib/image/help.py
@@ -631,3 +631,117 @@ DESCRIPTION
631 kickstart commands available for use in .wks files from 'wic help 631 kickstart commands available for use in .wks files from 'wic help
632 kickstart'. 632 kickstart'.
633""" 633"""
634
635wic_kickstart_help = """
636
637NAME
638 wic kickstart - wic kickstart reference
639
640DESCRIPTION
641 This section provides the definitive reference to the wic
642 kickstart language. It also provides documentation on the list of
643 --source plugins available for use from the 'part' command (see
644 the 'Platform-specific Plugins' section below).
645
646 The current wic implementation supports only the basic kickstart
647 partitioning commands: partition (or part for short) and
648 bootloader.
649
650 The following is a listing of the commands, their syntax, and
651 meanings. The commands are based on the Fedora kickstart
652 documentation but with modifications to reflect wic capabilities.
653
654 http://fedoraproject.org/wiki/Anaconda/Kickstart#part_or_partition
655 http://fedoraproject.org/wiki/Anaconda/Kickstart#bootloader
656
657 Commands
658
659 * 'part' or 'partition'
660
661 This command creates a partition on the system and uses the
662 following syntax:
663
664 part <mountpoint>
665
666 The <mountpoint> is where the partition will be mounted and
667 must take of one of the following forms:
668
669 /<path>: For example: /, /usr, or /home
670
671 swap: The partition will be used as swap space.
672
673 The following are supported 'part' options:
674
675 --size: The minimum partition size in MBytes. Specify an
676 integer value such as 500. Do not append the number
677 with "MB". You do not need this option if you use
678 --source.
679
680 --source: This option is a wic-specific option that names the
681 source of the data that will populate the
682 partition. The most common value for this option
683 is 'rootfs', but can be any value which maps to a
684 valid 'source plugin' (see 'wic help plugins').
685
686 If '--source rootfs' is used, it tells the wic
687 command to create a partition as large as needed
688 and to fill it with the contents of the root
689 filesystem pointed to by the '-r' wic command-line
690 option (or the equivalent rootfs derived from the
691 '-e' command-line option). The filesystem type
692 that will be used to create the partition is driven
693 by the value of the --fstype option specified for
694 the partition (see --fstype below).
695
696 If --source <plugin-name>' is used, it tells the
697 wic command to create a partition as large as
698 needed and to fill with the contents of the
699 partition that will be generated by the specified
700 plugin name using the data pointed to by the '-r'
701 wic command-line option (or the equivalent rootfs
702 derived from the '-e' command-line option).
703 Exactly what those contents and filesystem type end
704 up being are depend on the given plugin
705 implementation.
706
707 --ondisk or --ondrive: Forces the partition to be created on
708 a particular disk.
709
710 --fstype: Sets the file system type for the partition. These
711 apply to partitions created using '--source rootfs' (see
712 --source above). Valid values are:
713
714 ext2
715 ext3
716 ext4
717 btrfs
718 swap
719
720 --label label: Specifies the label to give to the filesystem
721 to be made on the partition. If the given
722 label is already in use by another filesystem,
723 a new label is created for the partition.
724
725 --active: Marks the partition as active.
726
727 --align (in KBytes): This option is specific to wic and says
728 to start a partition on an x KBytes
729 boundary.
730
731 * bootloader
732
733 This command allows the user to specify various bootloader
734 options. The following are supported 'bootloader' options:
735
736 --timeout: Specifies the number of seconds before the
737 bootloader times out and boots the default option.
738
739 --append: Specifies kernel parameters. These will be added to
740 bootloader command-line - for example, the syslinux
741 APPEND or grub kernel command line.
742
743 Note that bootloader functionality and boot partitions are
744 implemented by the various --source plugins that implement
745 bootloader functionality; the bootloader command essentially
746 provides a means of modifying bootloader configuration.
747"""