Added a bunch of instance variables and documented them.

git-svn-id: svn+ssh://svn.gentoo.org/var/svnroot/gli/trunk@6 f8877401-5920-0410-a79b-8e2d7e04ca0d

1 files changed, 95 insertions, 0 deletions

diff --git a/docs/GLIIP.doc b/docs/GLIIP.doc
new file mode 100644
index 0000000..9fb65a3
--- /dev/null
+++ b/docs/GLIIP.doc
@@ -0,0 +1,95 @@
+Name: cron_daemon
+Set Function: (void) set_cron_daemon(self, cron_daemon)
+Get Function: (cron_daemon) get_cron_daemon(self)
+Description: string to determine which cron daemon to install and configure (ie. 'vixie-cron')
+
+Name: logging_daemon
+Set Function: (void) set_logging_daemon(self, logging_daemon)
+Get Function: (logging_daemon) get_logging_daemon(self)
+Description: string to determine which logging daemon to install and configure (ie. 'sysklogd')
+
+Name: boot_loader_mbr
+Set Function: (void) set_boot_loader_mbr(self, boot_loader_mbr)
+Get Function: (boot_loader_mbr) get_boot_loader_mbr(self)
+Description: bool to decide whether or not to install the boot loader to the MBR. True installs boot loader to MBR.  False installs boot loader to the boot or root partition.
+
+Name: boot_loader
+Set Function: (void) set_boot_loader(self, boot_loader)
+Get Function: (boot_loader) get_boot_loader(self)
+Description: string to decide which boot loader to install. (ie. 'grub')
+
+Name: kernel_modules
+Set Function: (void) set_kernel_modules(self, kernel_modules)
+Get Function: (kernel_modules) get_kernel_modules(self)
+Description: tuple of strings containing names of modules to automatically load at boot time. (ie. '( 'ide-scsi', )')
+
+Name: kernel_config
+Set Function: (void) set_kernel_config(self, kernel_config)
+Get Function: (kernel_config) get_kernel_config(self)
+Description: string that is the path to the kernel config file you wish to use.  Can also be a http:// or ftp:// path.
+
+Name: kernel_initrd
+Set Function: (void) set_kernel_initrd(self, kernel_initrd)
+Get Function: (kernel_initrd) get_kernel_initrd(self)
+Description: bool to determine whether or not to build an initrd kernel.  False builds a non-initrd kernel. (overwritten by kernel_bootsplash)
+
+Name: kernel_bootsplash
+Set Function: (void) set_kernel_bootsplash(self, kernel_bootsplash)
+Get Function: (kernel_bootsplash) get_kernel_bootsplash(self)
+Description: bool to determine whether or not to install bootsplash into the kernel.  True builds in bootsplash support to the initrd.  WARNING: kernel_source must contain a kernel with bootsplash support or the bootsplash will not appear.  If you set this to true, it will build an initrd kernel even if you chose false for kernel_initrd!
+
+Name: kernel_source
+Set Function: (void) set_kernel_source(self, kernel_source)
+Get Function: (kernel_source) get_kernel_source(self)
+Description: string to define which kernel source to use.  (ie. 'gentoo-sources')
+
+Name: users
+Set Function: (void) set_users(self, users)
+Get Function: (users) get_users(self)
+Description: tuple of users.  A 'user' is defined as a tuple with the following format: ( 'user_name', 'user_pass_hash', 'user_groups', 'users_shell', 'users_homedir', uid, 'users_comment' ). Therefore, a user is a tuple embeded in another tuple containing all users.
+
+Name: root_pass_hash
+Set Function: (void) set_root_pass_hash(self, root_pass_hash)
+Get Function: (root_pass_hash) get_root_pass_hash(self)
+Description: string containing an md5 password hash to be assinged as the password for the root user.
+
+Name: time_zone
+Set Function: (void) set_time_zone(self, time_zone)
+Get Function: (time_zone) get_time_zone(self)
+Description: string defining the time zone to use.  Time zones are found in /usr/share/zoneinfo/.  Syntax is 'UTC' or 'US/Eastern'.
+
+Name: custom_stage3_tarball
+Set Function: (void) set_custom_stage3_tarball(self, custom_stage3_tarball)
+Get Function: (custom_stage3_tarball) get_custom_stage3_tarball(self)
+Description: string that is the full path to your own custom stage3 tarball. (ie. '/path/to/mytarball.tar.bz2')
+
+Name: install_stage
+Set Function: (void) set_install_stage(self, install_stage)
+Get Function: (install_stage) get_install_stage(self)
+Description: integer to define which stage install to use.  Appropriate stages are 1-3.
+
+Name: portage_tree_sync
+Set Function: (void) set_portage_tree_sync(self, portage_tree_sync)
+Get Function: (portage_tree_sync) get_portage_tree_sync(self)
+Description: bool to determine whether or not to run 'emerge sync' to get the latest portage tree.
+
+Name: portage_tree_snapshot
+Set Function: (void) set_portage_tree_snapshot(self, portage_tree_snapshot)
+Get Function: (portage_tree_snapshot) get_portage_tree_snapshot(self)
+Description: string defining the path to a portage tree snapshot. (ie. '/mnt/cdrom/snapshots/portage-*.tar.bz2')
+
+Name: domainname
+Set Function: (void) set_domainname(self, domainname)
+Get Function: (domainname) get_domainname(self)
+Description: string containing the domainname for the new system. (ie. 'mydomain.com'; NOT FQDN)
+
+Name: hostname
+Set Function: (void) set_hostname(self, hostname)
+Get Function: (hostname) get_hostname(self)
+Description: string containing the hostname for the new system. (ie. 'myhost'; NOT 'myhost.mydomain.com')
+
+Name: nisdomainname
+Set Function: (void) set_nisdomainname(self, nisdomainname)
+Get Function: (nisdomainname) get_nisdomainname(self)
+Description: string containing the NIS domainname for the new system.
+