1. docker
  2. Commit a596d3d1cf0a40ce577b8d1ea5ceb807d93468f2
Browse code

man: mv config-json.5 to docker-config-json.5

Signed-off-by: Antonio Murdaca <runcom@redhat.com>

Antonio Murdaca authored on 2016/06/03 22:28:19
Showing 2 changed files
man/config-json.5.md
History View file @ a596d3d
1 1 
deleted file mode 100644
... ... 
@@ -1,72 +0,0 @@
1 
-% CONFIG.JSON(5) Docker User Manuals
2 
-% Docker Community
3 
-% JANUARY 2016
4 
-# NAME
5 
-HOME/.docker/config.json - Default Docker configuration file
6 
-
7 
-# INTRODUCTION
8 
-
9 
-By default, the Docker command line stores its configuration files in a
10 
-directory called `.docker` within your `$HOME` directory.  Docker manages most of
11 
-the files in the configuration directory and you should not modify them.
12 
-However, you *can modify* the `config.json` file to control certain aspects of
13 
-how the `docker` command behaves.
14 
-
15 
-Currently, you can modify the `docker` command behavior using environment
16 
-variables or command-line options. You can also use options within
17 
-`config.json` to modify some of the same behavior. When using these
18 
-mechanisms, you must keep in mind the order of precedence among them. Command
19 
-line options override environment variables and environment variables override
20 
-properties you specify in a `config.json` file.
21 
-
22 
-The `config.json` file stores a JSON encoding of several properties:
23 
-
24 
-* The `HttpHeaders` property specifies a set of headers to include in all messages
25 
-sent from the Docker client to the daemon. Docker does not try to interpret or
26 
-understand these header; it simply puts them into the messages. Docker does not
27 
-allow these headers to change any headers it sets for itself.
28 
-
29 
-* The `psFormat` property specifies the default format for `docker ps` output.
30 
-When the `--format` flag is not provided with the `docker ps` command,
31 
-Docker's client uses this property. If this property is not set, the client
32 
-falls back to the default table format. For a list of supported formatting
33 
-directives, see **docker-ps(1)**.
34 
-
35 
-* The `detachKeys` property specifies the default key sequence which
36 
-detaches the container. When the `--detach-keys` flag is not provide
37 
-with the `docker attach`, `docker exec`, `docker run` or `docker
38 
-start`, Docker's client uses this property. If this property is not
39 
-set, the client falls back to the default sequence `ctrl-p,ctrl-q`.
40 
-
41 
-
42 
-* The `imagesFormat` property  specifies the default format for `docker images`
43 
-output. When the `--format` flag is not provided with the `docker images`
44 
-command, Docker's client uses this property. If this property is not set, the
45 
-client falls back to the default table format. For a list of supported
46 
-formatting directives, see **docker-images(1)**.
47 
-
48 
-You can specify a different location for the configuration files via the
49 
-`DOCKER_CONFIG` environment variable or the `--config` command line option. If
50 
-both are specified, then the `--config` option overrides the `DOCKER_CONFIG`
51 
-environment variable:
52 
-
53 
-    docker --config ~/testconfigs/ ps
54 
-
55 
-This command instructs Docker to use the configuration files in the
56 
-`~/testconfigs/` directory when running the `ps` command.
57 
-
58 
-## Examples
59 
-
60 
-Following is a sample `config.json` file:
61 
-
62 
-    {
63 
-      "HttpHeaders": {
64 
-        "MyHeader": "MyValue"
65 
-      },
66 
-      "psFormat": "table {{.ID}}\\t{{.Image}}\\t{{.Command}}\\t{{.Labels}}",
67 
-      "imagesFormat": "table {{.ID}}\\t{{.Repository}}\\t{{.Tag}}\\t{{.CreatedAt}}",
68 
-      "detachKeys": "ctrl-e,e"
69 
-    }
70 
-
71 
-# HISTORY
72 
-January 2016, created by Moxiegirl <mary@docker.com>
man/docker-config-json.5.md
History View file @ a596d3d
73 1 
new file mode 100644
... ... 
@@ -0,0 +1,72 @@
0 
+% CONFIG.JSON(5) Docker User Manuals
1 
+% Docker Community
2 
+% JANUARY 2016
3 
+# NAME
4 
+HOME/.docker/config.json - Default Docker configuration file
5 
+
6 
+# INTRODUCTION
7 
+
8 
+By default, the Docker command line stores its configuration files in a
9 
+directory called `.docker` within your `$HOME` directory.  Docker manages most of
10 
+the files in the configuration directory and you should not modify them.
11 
+However, you *can modify* the `config.json` file to control certain aspects of
12 
+how the `docker` command behaves.
13 
+
14 
+Currently, you can modify the `docker` command behavior using environment
15 
+variables or command-line options. You can also use options within
16 
+`config.json` to modify some of the same behavior. When using these
17 
+mechanisms, you must keep in mind the order of precedence among them. Command
18 
+line options override environment variables and environment variables override
19 
+properties you specify in a `config.json` file.
20 
+
21 
+The `config.json` file stores a JSON encoding of several properties:
22 
+
23 
+* The `HttpHeaders` property specifies a set of headers to include in all messages
24 
+sent from the Docker client to the daemon. Docker does not try to interpret or
25 
+understand these header; it simply puts them into the messages. Docker does not
26 
+allow these headers to change any headers it sets for itself.
27 
+
28 
+* The `psFormat` property specifies the default format for `docker ps` output.
29 
+When the `--format` flag is not provided with the `docker ps` command,
30 
+Docker's client uses this property. If this property is not set, the client
31 
+falls back to the default table format. For a list of supported formatting
32 
+directives, see **docker-ps(1)**.
33 
+
34 
+* The `detachKeys` property specifies the default key sequence which
35 
+detaches the container. When the `--detach-keys` flag is not provide
36 
+with the `docker attach`, `docker exec`, `docker run` or `docker
37 
+start`, Docker's client uses this property. If this property is not
38 
+set, the client falls back to the default sequence `ctrl-p,ctrl-q`.
39 
+
40 
+
41 
+* The `imagesFormat` property  specifies the default format for `docker images`
42 
+output. When the `--format` flag is not provided with the `docker images`
43 
+command, Docker's client uses this property. If this property is not set, the
44 
+client falls back to the default table format. For a list of supported
45 
+formatting directives, see **docker-images(1)**.
46 
+
47 
+You can specify a different location for the configuration files via the
48 
+`DOCKER_CONFIG` environment variable or the `--config` command line option. If
49 
+both are specified, then the `--config` option overrides the `DOCKER_CONFIG`
50 
+environment variable:
51 
+
52 
+    docker --config ~/testconfigs/ ps
53 
+
54 
+This command instructs Docker to use the configuration files in the
55 
+`~/testconfigs/` directory when running the `ps` command.
56 
+
57 
+## Examples
58 
+
59 
+Following is a sample `config.json` file:
60 
+
61 
+    {
62 
+      "HttpHeaders": {
63 
+        "MyHeader": "MyValue"
64 
+      },
65 
+      "psFormat": "table {{.ID}}\\t{{.Image}}\\t{{.Command}}\\t{{.Labels}}",
66 
+      "imagesFormat": "table {{.ID}}\\t{{.Repository}}\\t{{.Tag}}\\t{{.CreatedAt}}",
67 
+      "detachKeys": "ctrl-e,e"
68 
+    }
69 
+
70 
+# HISTORY
71 
+January 2016, created by Moxiegirl <mary@docker.com>