Use underscores instead of a space in a test file's name (#3180)

[etc/vim.git] / docs / usage_and_configuration / black_as_a_server.md

diff --git a/docs/usage_and_configuration/black_as_a_server.md b/docs/usage_and_configuration/black_as_a_server.md
index 0c0382b3e50487650e625c3808b37da233dd954f..fc9d1cab7168e155a7369d6d1a2a813718533467 100644 (file)
--- a/docs/usage_and_configuration/black_as_a_server.md
+++ b/docs/usage_and_configuration/black_as_a_server.md
@@ -4,10 +4,15 @@
 protocol. The main benefit of using it is to avoid the cost of starting up a new _Black_
 process every time you want to blacken a file.
 
 protocol. The main benefit of using it is to avoid the cost of starting up a new _Black_
 process every time you want to blacken a file.
 

+```{warning}
+`blackd` should not be run as a publicly accessible server as there are no security
+precautions in place to prevent abuse. **It is intended for local use only**.
+```
+

 ## Usage
 
 `blackd` is not packaged alongside _Black_ by default because it has additional
 ## Usage
 
 `blackd` is not packaged alongside _Black_ by default because it has additional

-dependencies. You will need to execute `pip install black[d]` to install it.
+dependencies. You will need to execute `pip install 'black[d]'` to install it.

 
 You can start the server on the default port, binding only to the local interface by
 running `blackd`. You will see a single line mentioning the server's version, and the
 
 You can start the server on the default port, binding only to the local interface by
 running `blackd`. You will see a single line mentioning the server's version, and the


@@ -18,14 +23,8 @@ formatting requests.
 `blackd` provides even less options than _Black_. You can see them by running
 `blackd --help`:
 
 `blackd` provides even less options than _Black_. You can see them by running
 `blackd --help`:
 

-```text
-Usage: blackd [OPTIONS]
+```{program-output} blackd --help

 
 

-Options:
-  --bind-host TEXT                Address to bind the server to.
-  --bind-port INTEGER             Port to listen on
-  --version                       Show the version and exit.
-  -h, --help                      Show this message and exit.

 ```
 
 There is no official `blackd` client tool (yet!). You can test that blackd is working
 ```
 
 There is no official `blackd` client tool (yet!). You can test that blackd is working