Skip to content

Commit c58128f

Browse files
committed
Merge #10878: Docs: Fix Markdown formatting issues in init.md
d201e40 Update init.md: Fix section numbering. (Carl Dong) 72a184a Update init.md: Fix line breaks in section 3b. (Carl Dong) Pull request description: Trivial commit that fixes Markdown line breaks in `docs/init.md`. Markdown line breaks take the form of two spaces, which is hard to spot when viewing raw text but visible when previewing on GitHub. Line 72-73 of `docs/init.md` did not conform to the rest the rest of the documentation, and is corrected in this PR. Tree-SHA512: e5f048bd4e9e1e68372c95881f68b157a3c205d4dbcc6ccd24f2c0171b84d8cf7907d1835c6754ce57f35f9463820353ad7ae70c2e3de20136382ea3ee8bc4ff
2 parents f355883 + d201e40 commit c58128f

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

doc/init.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ can be found in the contrib/init folder.
1010
contrib/init/bitcoind.conf: Upstart service configuration file
1111
contrib/init/bitcoind.init: CentOS compatible SysV style init script
1212

13-
1. Service User
13+
Service User
1414
---------------------------------
1515

1616
All three Linux startup configurations assume the existence of a "bitcoin" user
1717
and group. They must be created before attempting to use these scripts.
1818
The OS X configuration assumes bitcoind will be set up for the current user.
1919

20-
2. Configuration
20+
Configuration
2121
---------------------------------
2222

2323
At a bare minimum, bitcoind requires that the rpcpassword setting be set
@@ -46,10 +46,10 @@ relative to the data directory. `wallet` *only* supports relative paths.
4646
For an example configuration file that describes the configuration settings,
4747
see `contrib/debian/examples/bitcoin.conf`.
4848

49-
3. Paths
49+
Paths
5050
---------------------------------
5151

52-
3a) Linux
52+
### Linux
5353

5454
All three configurations assume several paths that might need to be adjusted.
5555

@@ -65,17 +65,17 @@ reasons to make the configuration file and data directory only readable by the
6565
bitcoin user and group. Access to bitcoin-cli and other bitcoind rpc clients
6666
can then be controlled by group membership.
6767

68-
3b) Mac OS X
68+
### Mac OS X
6969

7070
Binary: `/usr/local/bin/bitcoind`
7171
Configuration file: `~/Library/Application Support/Bitcoin/bitcoin.conf`
72-
Data directory: `~/Library/Application Support/Bitcoin`
73-
Lock file: `~/Library/Application Support/Bitcoin/.lock`
72+
Data directory: `~/Library/Application Support/Bitcoin`
73+
Lock file: `~/Library/Application Support/Bitcoin/.lock`
7474

75-
4. Installing Service Configuration
75+
Installing Service Configuration
7676
-----------------------------------
7777

78-
4a) systemd
78+
### systemd
7979

8080
Installing this .service file consists of just copying it to
8181
/usr/lib/systemd/system directory, followed by the command
@@ -84,30 +84,30 @@ Installing this .service file consists of just copying it to
8484
To test, run `systemctl start bitcoind` and to enable for system startup run
8585
`systemctl enable bitcoind`
8686

87-
4b) OpenRC
87+
### OpenRC
8888

8989
Rename bitcoind.openrc to bitcoind and drop it in /etc/init.d. Double
9090
check ownership and permissions and make it executable. Test it with
9191
`/etc/init.d/bitcoind start` and configure it to run on startup with
9292
`rc-update add bitcoind`
9393

94-
4c) Upstart (for Debian/Ubuntu based distributions)
94+
### Upstart (for Debian/Ubuntu based distributions)
9595

9696
Drop bitcoind.conf in /etc/init. Test by running `service bitcoind start`
9797
it will automatically start on reboot.
9898

9999
NOTE: This script is incompatible with CentOS 5 and Amazon Linux 2014 as they
100100
use old versions of Upstart and do not supply the start-stop-daemon utility.
101101

102-
4d) CentOS
102+
### CentOS
103103

104104
Copy bitcoind.init to /etc/init.d/bitcoind. Test by running `service bitcoind start`.
105105

106106
Using this script, you can adjust the path and flags to the bitcoind program by
107107
setting the BITCOIND and FLAGS environment variables in the file
108108
/etc/sysconfig/bitcoind. You can also use the DAEMONOPTS environment variable here.
109109

110-
4e) Mac OS X
110+
### Mac OS X
111111

112112
Copy org.bitcoin.bitcoind.plist into ~/Library/LaunchAgents. Load the launch agent by
113113
running `launchctl load ~/Library/LaunchAgents/org.bitcoin.bitcoind.plist`.
@@ -118,7 +118,7 @@ NOTE: This approach is intended for those wanting to run bitcoind as the current
118118
You will need to modify org.bitcoin.bitcoind.plist if you intend to use it as a
119119
Launch Daemon with a dedicated bitcoin user.
120120

121-
5. Auto-respawn
121+
Auto-respawn
122122
-----------------------------------
123123

124124
Auto respawning is currently only configured for Upstart and systemd.

0 commit comments

Comments
 (0)