summaryrefslogtreecommitdiffstats
path: root/man/runlevel.xml
blob: 976753a737ff8ae0da9053266ea5c6b90897ade5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  This file is part of systemd.

  Copyright 2010 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

<refentry id="runlevel"
          xmlns:xi="http://www.w3.org/2001/XInclude">

        <refentryinfo>
                <title>runlevel</title>
                <productname>systemd</productname>

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Lennart</firstname>
                                <surname>Poettering</surname>
                                <email>lennart@poettering.net</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
                <refentrytitle>runlevel</refentrytitle>
                <manvolnum>8</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>runlevel</refname>
                <refpurpose>Print previous and current SysV runlevel</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <cmdsynopsis>
                        <command>runlevel <arg choice="opt" rep="repeat">options</arg></command>
                </cmdsynopsis>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para><command>runlevel</command> prints the previous
                and current SysV runlevel if they are known.</para>

                <para>The two runlevel characters are separated by a
                single space character. If a runlevel cannot be
                determined, N is printed instead. If neither can be
                determined, the word "unknown" is printed.</para>

                <para>Unless overridden in the environment, this will
                check the utmp database for recent runlevel
                changes.</para>
        </refsect1>

        <refsect1>
                <title>Options</title>

                <para>The following option is understood:</para>

                <variablelist>
                        <varlistentry>
                                <term><option>--help</option></term>

                                <xi:include href="standard-options.xml" xpointer="help-text" />
                        </varlistentry>
                </variablelist>

        </refsect1>

        <refsect1>
                <title>Exit status</title>

                <para>If one or both runlevels could be determined, 0
                is returned, a non-zero failure code otherwise.</para>

        </refsect1>

        <refsect1>
                <title>Environment</title>

                <variablelist class='environment-variables'>
                        <varlistentry>
                                <term><varname>$RUNLEVEL</varname></term>

                                <listitem><para>If
                                <varname>$RUNLEVEL</varname> is set,
                                <command>runlevel</command> will print
                                this value as current runlevel and
                                ignore utmp.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>$PREVLEVEL</varname></term>

                                <listitem><para>If
                                <varname>$PREVLEVEL</varname> is set,
                                <command>runlevel</command> will print
                                this value as previous runlevel and
                                ignore utmp.</para></listitem>
                        </varlistentry>
                </variablelist>
        </refsect1>

        <refsect1>
                <title>Files</title>

                <variablelist>
                        <varlistentry>
                                <term><filename>/var/run/utmp</filename></term>

                                <listitem><para>The utmp database
                                <command>runlevel</command> reads the
                                previous and current runlevel
                                from.</para></listitem>

                        </varlistentry>
                </variablelist>
        </refsect1>

        <refsect1>
                <title>Notes</title>

                <para>This is a legacy command available for compatibility
                only. It should not be used anymore, as the concept of
                runlevels is obsolete.</para>
        </refsect1>

        <refsect1>
                <title>See Also</title>
                <para>
                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>