summaryrefslogtreecommitdiffstats
path: root/usr/sbin/pc-sysinstall/doc
diff options
context:
space:
mode:
Diffstat (limited to 'usr/sbin/pc-sysinstall/doc')
-rw-r--r--usr/sbin/pc-sysinstall/doc/Makefile8
-rw-r--r--usr/sbin/pc-sysinstall/doc/help-disk-list1
-rw-r--r--usr/sbin/pc-sysinstall/doc/help-disk-size1
-rw-r--r--usr/sbin/pc-sysinstall/doc/help-index95
-rw-r--r--usr/sbin/pc-sysinstall/doc/help-start-autoinstall39
5 files changed, 144 insertions, 0 deletions
diff --git a/usr/sbin/pc-sysinstall/doc/Makefile b/usr/sbin/pc-sysinstall/doc/Makefile
new file mode 100644
index 0000000..22fb7a0
--- /dev/null
+++ b/usr/sbin/pc-sysinstall/doc/Makefile
@@ -0,0 +1,8 @@
+# $FreeBSD: src/usr.sbin/pc-sysinstall/doc/Makefile,v 1.1 2010/06/24 22:21:47 imp Exp $
+
+FILES= help-disk-list help-disk-size help-index help-start-autoinstall
+
+FILESDIR=${SHAREDIR}/pc-sysinstall/doc
+NO_OBJ=
+
+.include <bsd.prog.mk>
diff --git a/usr/sbin/pc-sysinstall/doc/help-disk-list b/usr/sbin/pc-sysinstall/doc/help-disk-list
new file mode 100644
index 0000000..0d4bff9
--- /dev/null
+++ b/usr/sbin/pc-sysinstall/doc/help-disk-list
@@ -0,0 +1 @@
+Holder
diff --git a/usr/sbin/pc-sysinstall/doc/help-disk-size b/usr/sbin/pc-sysinstall/doc/help-disk-size
new file mode 100644
index 0000000..0d4bff9
--- /dev/null
+++ b/usr/sbin/pc-sysinstall/doc/help-disk-size
@@ -0,0 +1 @@
+Holder
diff --git a/usr/sbin/pc-sysinstall/doc/help-index b/usr/sbin/pc-sysinstall/doc/help-index
new file mode 100644
index 0000000..d9e52b5
--- /dev/null
+++ b/usr/sbin/pc-sysinstall/doc/help-index
@@ -0,0 +1,95 @@
+pc-sysinstall Help Index
+-----------------------------------------------
+Help Commands
+
+ help
+ Display this index file
+
+ help <command>
+ Display the help data for the specified command
+
+System Query Commands
+
+ disk-list
+ Provides a listing of the disk drives detected on this system
+
+ disk-part <disk>
+ Queries the specified disk and returns information about its partitions
+
+ disk-info <disk>
+ Returns information about the disks size, cyls, heads, and sectors
+
+ detect-laptop
+ Tests to see if this system is a laptop or desktop
+
+ detect-emulation
+ Tests to see if this system is actually running in an emulator such as VirtualBox
+
+ detect-nics
+ Returns a listing of the detected network cards on this system
+
+ list-config
+ Returns a listing of the pc-sysinstall configuration
+
+ list-components
+ Returns a listing of the available components which can be installed
+
+ list-mirrors
+ Returns a listing of the available FTP mirrors
+
+ list-packages
+ Returns a listing of the available packages
+
+ list-rsync-backups <user> <host> <port>
+ Returns a listing of available rsync-backups on the target server in the life-preserver/ dir
+
+ list-tzones
+ Returns a listing of available timezones
+
+ query-langs
+ Return a list of languages that the installer supports
+
+ get-packages
+ Retrieves the list of packages from an FTP mirror
+
+ sys-mem
+ Return the size of installed system RAM in MegaBytes
+
+ test-netup
+ Test if an internet connection is available
+
+ update-part-list
+ Return a list of PC-BSD & FreeBSD installs on this system for updates
+
+ xkeyboard-layouts
+ Return a list of keyboard layouts that xorg supports
+
+ xkeyboard-models
+ Return a list of keyboard models that xorg supports
+
+ xkeyboard-variants
+ Return a list of keyboard variants that xorg supports
+
+Partition Management Commands
+
+ create-part <disk> <size>
+ Create a new MBR primary slice on the target <disk> using <size> MB
+
+ delete-part <partition>
+ Deletes the disk partition specified. If this is the last partition,
+ the disk partition layout will also be scrubbed, leaving a clean disk
+ ready for MBR or GPT file system layouts.
+
+
+Installation Commands
+
+ -c <cfg>
+ Begin a install / upgrade with the specified cfg file
+
+ start-autoinstall <conf>
+ Start an automated installation with the specified conf file
+ Normally only used by automated install scripts
+
+ setup-ssh-keys <user> <host> <port>
+ Setup SSH without a password for the target host and user and port
+ Use to prompt the user to log into a server before doing a rsync + ssh restore
diff --git a/usr/sbin/pc-sysinstall/doc/help-start-autoinstall b/usr/sbin/pc-sysinstall/doc/help-start-autoinstall
new file mode 100644
index 0000000..1cb1e6a
--- /dev/null
+++ b/usr/sbin/pc-sysinstall/doc/help-start-autoinstall
@@ -0,0 +1,39 @@
+start-autoinstall - HELP
+-----------------------------------------------
+
+About:
+ start-autoinstall is used when performing automated installationsr. It is able
+ to configure networking with provided settings, and fetch an installation script from
+ http / ftp server. This allows media to be created which fetches dynamic configuration
+ options from a server-side supplier.
+
+Usage:
+ pc-sysinstall start-autoinstall <config>
+
+Config Syntax:
+
+ The configuration file for start-autoinstall can contain the following options:
+
+ pc_config: <value>
+ - Location of the pc-sysinstall installation configuration file, can be local
+ or start with http:// or ftp:// to fetch from a remote system.
+
+ shutdown_cmd: <value>
+ - Command to execute post-installation, such as "shutdown -p now" or other.
+
+ confirm_install: (YES/NO)
+ - Prompt on the console to begin installation. Defaults to YES.
+ Warning: Setting this to NO will start an installation as soon as start-autoinstall
+ is run. (I.E. after booting some install media) It may be dangerous if a disk is left
+ in a drive and the system is turned on!
+
+ nic_config: (DHCP-ALL / <cfg>)
+ - When set to DHCP-ALL, the software will attempt to get a network address from DHCP on
+ any / all detected NICS. If set to some other command, it will be used as an argument
+ to "ifconfig" to enable networking.
+
+ nic_dns: <value>
+ - Use the following DNS server for networking
+
+ nic_gateway: <gateway>
+ - Use the following default route / gateway for networking
OpenPOWER on IntegriCloud