Skip to content

Commit 8c6a980

Browse files
DougieLawsonJamesH65
authored andcommitted
The Raspi-Config doc page doesn't match (raspberrypi#783)
* The Raspi-Config doc page doesn't match The documentation page no longer matches the menu structure for the current version of the raspi-config tool. * copy edits
1 parent 1e3d269 commit 8c6a980

File tree

1 file changed

+111
-66
lines changed

1 file changed

+111
-66
lines changed

configuration/raspi-config.md

+111-66
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,23 @@ You should see a blue screen with options in a grey box in the centre, like so:
2020
It has the following options available:
2121

2222
```
23-
Raspberry Pi Software Configuration Tool (raspi-config)
24-
25-
Setup Options
26-
27-
1 Expand Filesystem Ensures that all of the SD card storage is available to the OS
28-
2 Change User Password Change password for the default user (pi)
29-
3 Enable Boot to Desktop/Scratch Choose whether to boot into a desktop environment, Scratch, or the command line
30-
4 Internationalisation Options Set up language and regional settings to match your location
31-
5 Enable Camera Enable this Pi to work with the Raspberry Pi camera
32-
6 Overclock Configure overclocking for your Pi
33-
7 Advanced Options Configure advanced settings
34-
8 About `raspi-config` Information about this configuration tool
35-
36-
<Select> <Finish>
23+
┌───────────────────┤ Raspberry Pi Software Configuration Tool (raspi-config) ├────────────────────┐
24+
│ │
25+
│ 1 Change User Password Change password for the current user │
26+
│ 2 Network Options Configure network settings │
27+
│ 3 Boot Options Configure options for start-up │
28+
│ 4 Localisation Options Set up language and regional settings to match your location │
29+
│ 5 Interfacing Options Configure connections to peripherals │
30+
│ 6 Overclock Configure overclocking for your Pi │
31+
│ 7 Advanced Options Configure advanced settings │
32+
│ 8 Update Update this tool to the latest version │
33+
│ 9 About raspi-config Information about this configuration tool │
34+
│ │
35+
│ │
36+
│ │
37+
│ <Select> <Finish> │
38+
│ │
39+
└──────────────────────────────────────────────────────────────────────────────────────────────────┘
3740
```
3841

3942
<a name="moving-around-the-menu"></a>
@@ -51,57 +54,101 @@ Generally speaking, `raspi-config` aims to provide the functionality to make the
5154
<a name="menu-options"></a>
5255
## Menu options
5356

54-
<a name="expand-filesystem"></a>
55-
### Expand filesystem
57+
<a name="change-user-password"></a>
58+
### Change User Password
5659

57-
If you have installed Raspbian using NOOBS, the filesystem will have been expanded automatically. There may be a rare occasion where this is not the case, e.g. if you have copied a smaller SD card onto a larger one. In this case, you should use this option to expand your installation to fill the whole SD card, giving you more space to use for files. You will need to reboot the Raspberry Pi to make this available. Note that there is no confirmation: selecting the option begins the partition expansion immediately.
60+
The default user on Raspbian is ```pi``` with the password ```raspberry```. You can change that here. Read about other [users](/linux/usage/users.md).
61+
62+
<a name="network-options"></a>
63+
### Network Options
5864

59-
<a name="change-user-password"></a>
60-
### Change user password
65+
From this submenu you can set the host name, your WiFi SSID, and pre-shared key, or enable/disable predictable network interface names.
66+
67+
<a name="hostname"></a>
68+
#### Hostname
6169

62-
The default user on Raspbian is `pi` with the password `raspberry`. You can change that here. Read about other [users](../linux/usage/users.md).
70+
Set the visible name for this Pi on a network.
6371

64-
<a name="change-boot-to-desktop"></a>
65-
### Enable boot to desktop or Scratch
72+
<a name="boot-options"></a>
73+
### Boot Options
6674

67-
You can change what happens when your Pi boots. Use this option to change your boot preference to command line, desktop, or straight to Scratch.
75+
From here you can change what happens when your Pi boots. Use this option to change your boot preference to command line or desktop. You can choose whether boot-up waits for the network to be available, and whether the Plymouth splash screen is displayed at boot-up.
6876

69-
<a name="internationalisation-options"></a>
70-
### Internationalisation options
77+
<a name="localisation-options"></a>
78+
### Localisation Options
7179

72-
Select `Internationalisation Options` and press `Enter` to be taken to a sub-menu containing the following options:
80+
The localisation submenu gives you these options to choose from: keyboard layout, time zone, locale, and WiFi country code. All options on these menus default to British or GB until you change them.
7381

74-
<a name="change-locale"></a>
7582
#### Change locale
76-
7783
Select a locale, for example `en_GB.UTF-8 UTF-8`.
7884

79-
<a name="change-timezone"></a>
80-
#### Change timezone
85+
#### Change time zone
86+
Select your local time zone, starting with the region, e.g. Europe, then selecting a city, e.g. London. Type a letter to skip down the list to that point in the alphabet.
8187

82-
Select your local timezone, starting with the region such as `Europe`, then selecting a city, for example `London`. Type a letter to skip down the list to that point in the alphabet.
83-
84-
<a name="change-keyboard-layout"></a>
8588
#### Change keyboard layout
86-
8789
This option opens another menu which allows you to select your keyboard layout. It will take a long time to display while it reads all the keyboard types. Changes usually take effect immediately, but may require a reboot.
8890

89-
<a name="enable-camera"></a>
90-
### Enable camera
91+
#### Change WiFi Country
92+
This option sets the country code for your WiFi network.
9193

92-
In order to use the Raspberry Pi Camera Module, you must enable it here. Select the option and proceed to `Enable`. This will make sure at least 128MB of RAM is dedicated to the GPU.
94+
<a name="interfacing-options"></a>
95+
### Interfacing Options
9396

94-
<a name="overclock"></a>
97+
In this submenu there are the following options to enable/disable: Camera, SSH, VNC, SPI, I2C, Serial, 1-wire, and Remote GPIO.
98+
99+
<a name="camera"></a>
100+
#### Camera
101+
102+
Enable/disable the CSI camera interface.
103+
104+
<a name="ssh"></a>
105+
#### SSH
106+
107+
Enable/disable remote command line access to your Pi using SSH.
108+
109+
SSH allows you to remotely access the command line of the Raspberry Pi from another computer. SSH is disabled by default. Read more about using SSH on the [SSH documentation page](../remote-access/ssh/README.md). If connecting your Pi directly to a public network, you should not enable SSH unless you have set up secure passwords for all users.
110+
111+
<a name="VNC"></a>
112+
#### VNC
113+
114+
Enable/disable the RealVNC virtual network computing server.
115+
116+
<a name="spi"></a>
117+
#### SPI
118+
119+
Enable/disable SPI interfaces and automatic loading of the SPI kernel module, needed for products such as PiFace.
120+
121+
<a name="i2c"></a>
122+
#### I2C
123+
124+
Enable/disable I2C interfaces and automatic loading of the I2C kernel module.
125+
126+
<a name="serial"></a>
127+
#### Serial
128+
129+
Enable/disable shell and kernel messages on the serial connection.
130+
131+
<a name="1-wire"></a>
132+
#### 1-wire
133+
134+
Enable/disable the Dallas 1-wire interface. This is usually used for DS18B20 temperature sensors.
135+
136+
<a name="overclock"></a>
95137
### Overclock
96138

97139
It is possible to overclock your Raspberry Pi's CPU. The default is 700MHz but it can be set up to 1000MHz. The overclocking you can achieve will vary; overclocking too high may result in instability. Selecting this option shows the following warning:
98140

99-
```
100-
Be aware that overclocking may reduce the lifetime of your Raspberry Pi. If overclocking at a certain level causes system instability, try a more modest overclock. Hold down `shift` during boot to temporarily disable overclock.
101-
```
141+
**Be aware that overclocking may reduce the lifetime of your Raspberry Pi.** If overclocking at a certain level causes system instability, try a more modest overclock. Hold down the Shift key during boot to temporarily disable overclocking.
142+
143+
See http://elinux.org/RPi_Overclocking for more information.
102144

103145
<a name="advanced-options"></a>
104-
### Advanced options
146+
### Advanced Options
147+
148+
<a name="expand-filesystem"></a>
149+
#### Expand Filesystem
150+
151+
If you have installed Raspbian using NOOBS, the filesystem will have been expanded automatically. There may be a rare occasion where this is not the case, e.g. if you have copied a smaller SD card onto a larger one. In this case, you should use this option to expand your installation to fill the whole SD card, giving you more space to use for files. You will need to reboot the Raspberry Pi to make this available. Note that there is no confirmation: selecting the option begins the partition expansion immediately.
105152

106153
<a name="overscan"></a>
107154
#### Overscan
@@ -112,47 +159,45 @@ Any changes will take effect after a reboot. You can have greater control over t
112159

113160
On some displays, particularly monitors, disabling overscan will make the picture fill the whole screen and correct the resolution. For other displays, it may be necessary to leave overscan enabled and adjust its values.
114161

115-
<a name="hostname"></a>
116-
#### Hostname
117-
118-
Set the visible name for this Pi on a network.
119-
120162
<a name="memory-split"></a>
121163
#### Memory split
122164

123165
Change the amount of memory made available to the GPU.
124166

125-
<a name="ssh"></a>
126-
#### SSH
167+
<a name="audio"></a>
168+
#### Audio
127169

128-
Enable/disable remote command line access to your Pi using SSH.
170+
Force audio out through HDMI or a 3.5mm jack. Read more on the [audio configuration documentation page](audio-config.md).
129171

130-
SSH allows you to remotely access the command line of the Raspberry Pi from another computer. SSH is disabled by default. Read more about using SSH on the [SSH documentation page](../remote-access/ssh/README.md). If connecting your Pi directly to a public network, you should not enable SSH unless you have set up secure passwords for all users.
172+
<a name="resolution"></a>
173+
#### Resolution
131174

132-
<a name="device-tree"></a>
133-
#### Device Tree
175+
Define the default HDMI/DVI video resolution to use when the system boots without a TV or monitor being connected. This can have an effect on RealVNC if the VNC option is enabled.
134176

135-
Enable/Disable the use of Device Tree. Read more about Device Trees config on the [Device Trees documentation page](device-tree.md).
177+
<a name="pixel-doubling"></a>
178+
#### Pixel Doubling
136179

137-
<a name="spi"></a>
138-
#### SPI
180+
Enable/disable 2x2 pixel mapping.
139181

140-
Enable/Disable SPI interfaces and automatic loading of the SPI kernel module, needed for products such as PiFace.
182+
<a name="GL-driver"></a>
183+
#### GL Driver
141184

142-
<a name="i2c"></a>
143-
#### I2C
185+
Enable/disable the experimental GL desktop graphics drivers.
144186

145-
Enable/Disable I2C interfaces and automatic loading of the I2C kernel module.
187+
<a name="GL-full-KMS"></a>
188+
##### GL (Full KMS)
146189

147-
<a name="serial"></a>
148-
#### Serial
190+
Enable/disable the experimental OpenGL Full KMS (kernel mode setting) desktop graphics driver.
149191

150-
Enable/Disable shell and kernel messages on the serial connection.
192+
<a name="GL-fake-KMS"></a>
193+
##### GL (Fake KMS)
151194

152-
<a name="audio"></a>
153-
#### Audio
195+
Enable/disable the experimental OpenGL Fake KMS desktop graphics driver.
154196

155-
Force audio out through HDMI or a 3.5mm jack. Read more on the [audio configuration documentation page](audio-config.md).
197+
<a name="legacy"></a>
198+
##### Legacy
199+
200+
Enable/disable the original legacy non-GL videocore desktop graphics driver.
156201

157202
<a name="update"></a>
158203
#### Update

0 commit comments

Comments
 (0)