usr.sbin/pc-sysinstall/pc-sysinstall/pc-sysinstall.8

   1 .\" Copyright (c) 2010
   2 .\"     iXsystems, Inc.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Jordan Hubbard OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd June 24, 2010
  28 .Dt PC-SYSINSTALL 8
  29 .Os
  30 .Sh NAME
  31 .Nm pc-sysinstall
  32 .Nd System installer backend
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl c Ar file
  36 .Op Ar command
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 utility is a hybrid backend for installing FreeBSD.  When run in install mode
  41 it takes a configuration file and performs an installation according to the
  42 parameters specified in the configuration file.  When called with one of
  43 the system query commands it provides information about the system to aid a
  44 front end in building an appropriate configuration file.
  45 .Pp
  46 The following options are available:
  47 .Bl -tag -width indent
  48 .It Fl c Ar file
  49 Perform an installation as directed by
  50 .Ar file.
  51 .El
  52 .Sh COMMANDS
  53 The
  54 .Cm command
  55 can be any one of the following:
  56 .Bl -tag -width indent
  57 .It help
  58 Display a list of all commands.
  59 .It help Ar command
  60 Display the help data for the specified command.
  61 .It disk-list
  62 Provide a listing of the storage devices detected on this system.
  63 .It disk-part Ar disk
  64 Queries the specified storage device and returns information about its
  65 partitions.
  66 .It disk-info Ar disk
  67 Returns information about a storage device's size, cylinders, heads, and
  68 sectors.
  69 .It detect-laptop
  70 Tests to see if this system is a laptop or desktop.
  71 .It detect-emulation
  72 Tests to see if this system is running in an emulator
  73 .It detect-nics
  74 Returns a listing of the detected network cards on this system.
  75 .It list-components
  76 Returns a listing of the available components which can be installed.
  77 .It list-rsync-backups Ar user Ar host Ar port
  78 Returns a listing of available rsync-backups on the target server in the
  79 life-preserver/ directory.
  80 .It list-tzones
  81 Returns a listing of available timezones.
  82 .It query-langs
  83 Returns a list of languages that the installer supports.
  84 .It sys-mem
  85 Returns the size of installed system RAM in MegaBytes.
  86 .It test-netup
  87 test if an internet connection is available.
  88 .It update-part-list
  89 Returns a list of PC-BSD and FreeBSD installs on this system for updates.
  90 .It xkeyboard-layouts
  91 Returns a list of keyboard layouts that xorg supports.
  92 .It xkeyboard-models
  93 Returns a list of keyboard models that xorg supports.
  94 .It xkeyboard-variants
  95 Returns a list of keyboard variants that xorg supports.
  96 .It create-part Ar disk Ar size
  97 Create a new MBR primary slice on the target disk using size MB.
  98 .It delete-part Ar partition
  99 Delete the disk partition specified.  If this is the last partition, the
 100 disk partition layout will also be scrubbed, leaving a clean disk ready
 101 for MBR or GPT file system layouts.
 102 .It start-autoinstall Ar file
 103 Start an automated installation with the specified file.  Normally only
 104 used by automated install scripts.
 105 .It setup-ssh-keys Ar user Ar host Ar port
 106 Setup SSH without a password for the target host, user, and port.  Used to
 107 prompt the user to log into a server before doing a rsync + ssh restore.
 108 .El
 109 .Sh HISTORY
 110 This version of
 111 .Nm
 112 first appeared in
 113 .Fx 9.0 .
 114 .Sh AUTHORS
 115 .An Kris Moore Aq kmoore@FreeBSD.org
 116 .Sh BUGS
 117 This utility was written to install PC-BSD and has seen limited use as an
 118 installer for FreeBSD.  It's likely that usage to install FreeBSD will expose
 119 edge cases that PC-BSD doesn't, as well as generate feature requests based
 120 on unforeseen needs.