Initial import from FreeBSD RELENG_4:
[games.git] / release / sysinstall / help / shortcuts.hlp
1 /stand/sysinstall now supports command-line "shortcuts" which can
2 often replace outdated commands, like pkg_manage.  Multiple commands
3 can be invoked in sequence, and variables may be set on-the-fly to
4 customize the installation program's behavior in various ways.
5
6 Syntax:
7
8 /stand/sysinstall [var=value ..] [command ..]
9
10 Where "var" can be one or more of:
11
12 blanktime               Screen blank time setting in seconds
13 bootManager             Select boot manager: booteasy, standard or none
14 browserBinary           Which doc browser to use (default: links)
15 browserPackage          Which package to get browser from (default: links)
16 cpioVerbose             How verbose to be with cpio: high, medium or low
17 debug                   Extra debugging?
18 disk                    Which disk to operate on (wd0, da0, etc).
19 domainname              Domain name
20 editor                  Which screen editor to use
21 ifconfig_<iface>        For each <iface> in network_devices
22 ftpDirectory            Root of the FreeBSD distribution tree on FTP server
23 ftpOnError              Set to retry or abort
24 ftpPass                 Which password to use when logging into FTP server
25 ftp                     Which FTP site/dir to use (URL ftp://site/dir/..)
26 ftpPort                 Which FTP port to use (default: 21)
27 ftpRetryCount           How many times to retry a fetch operation
28 ftpUser                 Which username to use when logging into FTP server
29 ftpHost                 Which FTP hostname to use (overrides ftp variable)
30 gated                   Use gated instead of routed
31 defaultrouter           IP address of default route
32 geometry                Geometry to use for selected disk ("cyl/hd/sec")
33 hostname                Fully qualified domain name for host.
34 network_interfaces      Which network interfaces to configure
35 ipaddr                  IP address for this host's primary interface
36 nameserver              IP address of name server
37 netmask                 Netmask for this host's primary interface
38 nfs                     Full host:/path/ specification to NFS media
39 nfsHost                 Host portion of nfs path
40 nfsSecure               Use NFS secure mount (-P flag)
41 nfs_server              Configure this machine as an NFS server
42 noConfirm               Don't ask for confirmation on non-fatal errors
43 ntpDate                 Which ntp clock synchronization server to use
44 pcnfsd                  Install the PCNFSD package 
45 ports                   Path to the ports collection
46 releaseName             Which FreeBSD release to install
47 rootSize                Size of the root partition to create for Auto
48 routedflags             Which flags to pass to routed, if enabled
49 serialSpeed             How fast to run a SLIP/PPP connection
50 slowEthernetCard        PC ethernet card is uncommonly slow
51 swapSize                Size of the swap partition to create for Auto
52 tapeBlocksize           Tape size in blocks
53 ufs                     Full path to UFS media directory
54 usrSize                 Size of the /usr partition to create for Auto
55 varSize                 Size of the /var partition to create for Auto
56
57 And "command" can be one or more of:
58
59 addUser                 Add a new user to the system
60 addGroup                Add a new group to the system
61 configAnonFTP           Configure system for anonymous FTP
62 configGated             Configure and install gated
63 configNFSServer         Configure host as an NFS server
64 configPackages          Browse / install packages
65 diskPartitionEditor     Partition a new or existing disk
66 diskPartitionWrite      Write out any changed partition information
67 diskLabelEditor         Label/Newfs/Mount new or existing filesystems
68 diskLabelCommit         Write out any changed label information
69 distReset               Reset distribution information
70 distSetDeveloper        Select developer distribution
71 distSetXDeveloper       Select X developer distribution
72 distSetKernDeveloper    Select kernel developer distribution
73 distSetUser             Select user distribution
74 distSetXUser            Select X user distribution
75 distSetMinimum          Select minimal distribution
76 distSetEverything       Select all distributions
77 distSetSrc              Select source sub-distributions
78 distSetXF86             Select XFree86 sub-distributions
79 distExtractAll          Extract all selected distributions
80 docBrowser              Browse documentation
81 installCommit           Commit any pending installation operations
82 installExpress          Express installation
83 installUpgrade          Upgrade installation
84 installFixup            Go into "fixit" mode
85 mediaSetCDROM           Select CDROM media
86 mediaSetFloppy          Select floppy media
87 mediaSetDOS             Select DOS media
88 mediaSetTape            Select tape media
89 mediaSetFTP             Select FTP media
90 mediaSetFTPPassive      Select FTP media in passive mode
91 mediaSetUFS             Select UFS media
92 mediaSetNFS             Select NFS media
93 mediaSetFtpUserPass     Prompt for FTP username and password
94 mediaSetCPIOVerbosity   Prompt for CPIO verbosity
95 mediaGetType            Prompt for media type
96 optionsEditor           Go to options editor
97
98 Examples:
99
100 /stand/sysinstall       mediaSetFTP configPackages
101
102 Selects an FTP site and then goes to the package configuration menu.
103
104
105 /stand/sysinstall       disk=da0 diskPartitionEditor
106
107 Invokes the disk partition editor on disk da0.
108
109
110 If /stand/sysinstall is linked to another filename, say
111 `/usr/local/bin/configPackages', then the basename will be used
112 as an implicit command name.