Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
config(1M)							    config(1M)

NAME
       config -	configure and build an HP-UX system

SYNOPSIS
       c_file] m_file] master] path]
			system_file

       module_name]...]
			master]

DESCRIPTION
       is used to configure the	following parts	of the operating system:

       o   an entire new kernel	and associated components

       o   individual kernel modules (including	device drivers)

       o   swap	and dump devices

       o   tunable system parameters

       supports	the following forms of kernel configurations:

       o   whole kernel	configuration (first form)

	   Both	 the static portion of the kernel and the dynamically loadable
	   kernel module images	are generated.	A system update	and reboot are
	   necessary to	run the	newly generated	kernel.

       o   loadable  module  configuration  (second  form, also	referred to as
	   kernel module configuration)

	   Specified dynamically loadable kernel module	images are  generated.
	   If  an  update of the current system	with the newly configured mod-
	   ules	is successful, new services can	be made	available immediately,
	   without requiring a system reboot.

       Kernel  modules are portions of the kernel responsible for supporting a
       specific	feature	(e.g. device drivers, file system types).  Kernel mod-
       ules  can either	be statically linked to	the kernel (static modules) or
       dynamically linked to the kernel	at run time (dynamically loadable ker-
       nel modules, or DLKM modules).  Not all modules have DLKM capability.

       To generate kernels and loadable	module images, takes as	input a	set of
       kernel archive libraries	(traditional), a set of	kernel	module	object
       files  (modular),  and  a set of	distributed kernel configuration files
       describing the kernel modules installed on the system.  also reads  ad-
       ditional	 system-wide  information  maintained  in the HP-UX system de-
       scription file (also known as the traditional system file).

       Modularly packaged kernel modules are maintained	in  individual	object
       files.	The configuration information associated to modularly packaged
       modules is described in individual  configuration  files,  including  a
       modular system file and a modular master	file per kernel	module.	 Modu-
       larly packaged modules must be installed	on the system using the	 kmin-
       stall(1M)  command.   Dynamically loadable kernel modules must be modu-
       larly packaged.

       Traditionally packaged kernel modules are maintained in archive library
       files.	Configuration information about	traditionally packaged modules
       is maintained in	several	traditional master files in the	directory, and
       the single traditional system file.

       The  set	of traditional and modular master files	describe configuration
       information supplied by kernel developers as part of the	HP-UX  operat-
       ing system, and should not be modified by system	administrators.

       The  traditional	 system	 file and modular system files contain config-
       urable attribute	values used to tailor the system and kernel  before  a
       call  to	 The  kmsystem(1M) administration command must be used to plan
       the configuration of a kernel module in or out of  the  kernel,	or  to
       modify  any  kernel module related information, prior to	a whole	kernel
       or loadable module configuration.  The kmtune(1M) system	administration
       command must be used to modify any kernel tunable parameters prior to a
       whole kernel or loadable	module configuration.  Such information	should
       not be modified by editing the system files, since the format and loca-
       tion of such information	is subject to change.

       See master(4) and system(4) for more information	about kernel  configu-
       ration  file  formats.  See the manual for information on how to	tailor
       the kernel or system (set planned configuration values) before a	 whole
       kernel  or  module  configuration, how to update	the kernel, and	how to
       boot the	system.

   WHOLE KERNEL	CONFIGURATION (First Form)
       When generating a whole kernel, based on	the input configuration	infor-
       mation, generates the following output files and	directories:

       o   C  program  source  files and which define the configuration	tables
	   for various parts of	the system.

       o   C program header file which defines tunable parameters of the  sys-
	   tem required	by kernel and kernel modules.

       o   C program source files used to generate dynamically loadable	images
	   of kernel modules.

	   If a	header file is provided	with a module, it is included  by  the
	   source file.

       o   a  makefile,	 used to generate the static portion of	the newly con-
	   figured kernel into the resulting main kernel file and to  generate
	   the kernel symbol table

       o   another  makefile, used to generate all dynamically loadable	module
	   images scheduled to be configured.

	   is not generated if	there  are  no	dynamically  loadable  modules
	   scheduled for configuration.

       o   a directory to store	dynamically loadable images and	other DLKM in-
	   formation

       o   a kernel registry (KRS) file	to store module	registration  informa-
	   tion	and other kernel-specific persistent information.

       After  the  above files are created, executes the make(1) command using
       the and makefiles.  The command creates several files in	a working  di-
       rectory whose location depends on the name of the specified traditional
       system file.  See the sections below on options.

       Upon successful completion of the make(1) command, the following	 files
       are generated:

       o   main	kernel file

	   This	is the kernel file which contains the kernel image correspond-
	   ing to the static portion of	the kernel.

       o   associated kernel component set

	   This	is the distributed set of associated kernel files required  to
	   boot	 and run the generated kernel.	The files in the kernel	compo-
	   nent	set are	associated to each other via a unique kernel ID	string
	   (KIS).  Among other files, the files	under are generated, including
	   the loadable	kernel module images, and the kernel symbol table.

       If the option is	specified, the kmupdate(1M) command is executed	 auto-
       matically to schedule the update	of the system with the newly generated
       kernel.	This makes the newly generated kernel  the  new	 default  boot
       kernel.	 Note  that  this  option  must	be used	(or alternately, kmup-
       date(1M)	must be	executed directly) in order to	ensure	that  all  the
       components  of  the  newly  generated  kernel are in place for the boot
       process.	 [See kmupdate(1M).]

   Options for Whole Kernel Configuration
       When configuring	a whole	kernel,	the command recognizes	the  following
       arguments:

       Specify the name	of the C program source	file produced by
	    The	default	file name is

       Specify the name	of the makefile	which is generated by
	    This  is  the makefile which will be used by to compile the	C pro-
	    gram source	file and make the new kernel.  The default  file  name
	    is

       Specify the name	of the master kernel configuration file	or
	    directory  that should use in creating source files	and makefiles.
	    If master is a directory, reads all	files  in  that	 directory  to
	    create  its	 data structures.  If master is	a file,	only that file
	    is read for	creating data structures for  By  default,  reads  the
	    files in the directory

       Search
	    path  for  the  directory  structure  containing the libraries and
	    header files needed	for making the kernel.	By default,  uses  the
	    directory structure	under

       This option will	force all modules that are scheduled for configuration
	    to	be  statically linked into the main kernel file, including the
	    kernel modules with	planned	linkage	set to dynamic.	  [See	kmsys-
	    tem(1M)].

       Stop after generating source files and makefiles.
	    make(1)  is	 not executed and no kernel or kernel modules are cre-
	    ated.  The option cannot be	used with the option.

       Give a short table of major device numbers for the character and
	    block devices, the card drivers, the streams drivers  and  modules
	    that  require  link	 routines, the streams devices and the streams
	    modules named in system_file.  These tables	 may  be  useful  when
	    creating special device files.

       Invoke the
	    kmupdate(1M) command after successfully configuring	the new	kernel
	    environment.  This will make the newly generated  kernel  the  new
	    default  boot kernel.  The option cannot be	used together with the
	    option.

       system_file
	    The	HP-UX system description file (traditional system  file)  con-
	    taining system-wide	configuration information.  The	default	system
	    file is and	when this file is used as input	to the resulting  out-
	    put	 is  placed  in	the directory If a file	other than is used for
	    system_file, places	its output files in the	current	directory.

   LOADABLE MODULE CONFIGURATION (Second Form)
       Based on	the input configuration	information, generates	the  following
       output files:

       o   C program source file for each kernel module.

       o   C  program  header file that	defines	tunable	parameters of the sys-
	   tem.

       o   a makefile, used to generate	dynamically loadable module images for
	   the specified modules.

       o   kernel module registration information for the specified modules.

       After the above files have been generated, executes the make(1) command
       with With a successful the module loadable image	and related components
       required	by the DLKM loader are generated.

       If  the	option is specified in conjunction with	the option, then calls
       kmupdate(1M) to update the running kernel with the new  loadable	 image
       of the specified	module.	 Updating the loadable image implies replacing
       the existing loadable image(if any) with	the newly created loadable im-
       age, registering	the new	module with the	running	kernel,	and performing
       any type-specific initialization; e.g. recreating  the  special	device
       file, if	needed.	 After a successful module update, the module is ready
       to be automatically loaded by the running kernel	 (auto-load),  or  de-
       mand-loaded by the administrator.

   Options for Loadable	Module Configuration
       For loadable module configuration, recognizes the following options:

       Configure the specified loadable	module.
	    A  main kernel file	is not generated in this case.	If successful,
	    the	module's loadable image	and related components required	by the
	    DLKM loader	are generated.

	    If	the  specified	module requires	a kernel stub (see master(4)),
	    prints a message and fails.	 A whole kernel	configuration  is  re-
	    quired to configure	stub modules.

       Specify the name	of the master kernel configuration information file
	    or	directory  that	 should	use in creating	source files and make-
	    files.  If master is a directory, reads all	files in  that	direc-
	    tory  to  create  its  data	structures.  If	master is a file, only
	    that file is read for creating data	 structures  for  By  default,
	    reads the files in the directory

       Invoke
	    kmupdate(1M) to update the running kernel with the new module.

EXTERNAL INFLUENCES
   Environment Variables
       determines the location of commands invoked by

RETURN VALUE
       returns	0  upon	successful completion.	If an error occurs, a non-zero
       value is	returned.

DIAGNOSTICS
       All error messages and warning messages of are sent to stderr.	Status
       report  messages	 are sent to stdout.  These messages are self-explana-
       tory.  Some messages are	generated by make(1) or	commands  called  from
       the makefiles.

WARNINGS
       is obsolescent and will be removed in a future release.	Callers	should
       use mk_kernel(1M) instead.

FILES
       Default input master configuration files

       Skeleton	makefile for whole kernel configuration

       Skeleton	makefile for kernel modules

       Default traditional system file

       Modular system files

       Default output configuration table

       Default output system parameter table

       Default output whole kernel	       make(1) script

       Default kernel module		       make(1) script

       Default main kernel file	generated by

       Kernel symbol table (KIS	is the kernel ID string	that
					       uniquely	identifies the	gener-
					       ated kernel).

       Kernel module loadable images (KIS is   the   kernel   ID  string  that
					       uniquely	identifies the	gener-
					       ated kernel).

       Default kernel-specific registry	file generated by

SEE ALSO
       kmadmin(1M),  kminstall(1M),  kmmodreg(1M),  kmsystem(1M),  kmtune(1M),
       kmupdate(1M), make(1), mk_kernel(1M), master(4),	system(4).

								    config(1M)

NAME | SYNOPSIS | DESCRIPTION | EXTERNAL INFLUENCES | RETURN VALUE | DIAGNOSTICS | WARNINGS | FILES | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=config&sektion=1m&manpath=HP-UX+11.22>

home | help