man2/setup.2

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" Copyright (c) 1992 Drew Eckhardt (drew@cs.colorado.edu), March 28, 1992
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .\" Modified by Michael Haardt <michael@moria.de>
  26 .\" Modified Sun Jul 25 10:14:13 1993 by Rik Faith <faith@cs.unc.edu>
  27 .\" Modified 15 April 1995 by Michael Chastain <mec@shell.portal.com>
  28 .\"   Update calling parameters to Linux 1.2.4 values.
  29 .\" Modified 10 June 1995 by Andries Brouwer <aeb@cwi.nl>
  30 .\" Modified 3 May 1996 by Martin Schulze <joey@infodrom.north.de>
  31 .\" Modified Wed Nov  6 04:05:28 1996 by Eric S. Raymond <esr@thyrsus.com>
  32 .\" Modified Sat Jan 29 01:08:23 2000 by aeb
  33 .\"
  34 .TH SETUP 2 1996-05-03 "Linux 1.2.9" "Linux Programmer's Manual"
  35 .SH NAME
  36 setup \- setup devices and file systems, mount root file system
  37 .SH SYNOPSIS
  38 .B #include <unistd.h>
  39 .sp
  40 .B _syscall0(int, setup)
  41 .sp
  42 .B int setup(void);
  43 .SH DESCRIPTION
  44 .B setup
  45 is called once from within
  46 .IR linux/init/main.c .
  47 It calls initialization functions for devices and file systems
  48 configured into the kernel and then mounts the root file system.
  49 .PP
  50 No user process may call
  51 .BR setup .
  52 Any user process, even a process with superuser permission,
  53 will receive
  54 .BR EPERM .
  55 .SH "RETURN VALUE"
  56 .B setup
  57 always returns \-1 for a user process.
  58 .SH ERRORS
  59 .TP
  60 .B EPERM
  61 Always, for a user process.
  62 .SH "CONFORMING TO"
  63 This function is Linux specific, and should not be used in programs
  64 intended to be portable, or indeed in any programs at all.
  65 Since Linux 2.1.121, no such function exists anymore.
  66 The calling sequence varied: it has had a single parameter
  67 .I "void * BIOS"
  68 and at other times a single parameter
  69 .IR "int magic" .