From 4d2f0af941566d364099be50ba83352a3cd903d0 Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Wed, 11 Dec 2019 11:26:37 +0100 Subject: [PATCH] doc: markup curl as program role MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See ¹. ¹: https://www.sphinx-doc.org/en/1.5/markup/inline.html#role-program Co-authored-by: Roberto Abdelkader Martínez Pérez --- docs/source/examples/index.rst | 14 +++++++------- docs/source/the_project/quickstart.rst | 2 +- docs/source/tutorial/tutorial01.rst | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/source/examples/index.rst b/docs/source/examples/index.rst index d7a5407..43a170d 100644 --- a/docs/source/examples/index.rst +++ b/docs/source/examples/index.rst @@ -203,7 +203,7 @@ In this example we'll be adding the header ``X-Content-Type-Options`` to the res $ kapow server nosniff.pow -Testing with curl: +Testing with :program:`curl`: .. code-block:: console :emphasize-lines: 11 @@ -263,7 +263,7 @@ date, then our ``pow`` file will fix it and return the correct value to the user kapow get /request/body | jq --arg newdate "$(date +'%Y-%m-%d_%H-%M-%S')" '.incorrectDate=$newdate' | kapow set /response/body EOF -Call the service with ``curl``: +Call the service with :program:`curl`: .. code-block:: console :linenos: @@ -291,7 +291,7 @@ order to generate a two-attribute JSON response. jq --arg greet Hello --arg value "${JSON_WHO:-World}" --null-input '{ greet: $greet, to: $value }' | kapow set /response/body EOF -Call the service with ``curl``: +Call the service with :program:`curl`: .. code-block:: console :linenos: @@ -378,7 +378,7 @@ In this example, an attacker can inject arbitrary parameters to ``ls``. ls $(kapow get /request/matches/value) | kapow set /response/body EOF -Exploiting using curl: +Exploiting using :program:`curl`: .. code-block:: console :linenos: @@ -421,7 +421,7 @@ You can specify custom status code for HTTP response: echo -n '401 error' | kapow set /response/body EOF -Testing with ``curl``: +Testing with :program:`curl`: .. code-block:: console :emphasize-lines: 10 @@ -495,7 +495,7 @@ params: wait EOF -Calling with ``curl``: +Calling with :program:`curl`: .. code-block:: console :linenos: @@ -525,7 +525,7 @@ In the next example we'll set a cookie: echo -n OK | kapow set /response/body EOF -Calling with ``curl``: +Calling with :program:`curl`: .. code-block:: console :linenos: diff --git a/docs/source/the_project/quickstart.rst b/docs/source/the_project/quickstart.rst index 76af4fb..10ade49 100644 --- a/docs/source/the_project/quickstart.rst +++ b/docs/source/the_project/quickstart.rst @@ -150,7 +150,7 @@ Consume the Service +++++++++++++++++++ Now we can call our newly created endpoint by using our favorite HTTP client. -In this example we're using ``curl``: +In this example we're using :program:`curl`: .. code-block:: console diff --git a/docs/source/tutorial/tutorial01.rst b/docs/source/tutorial/tutorial01.rst index 337393a..2a1beb8 100644 --- a/docs/source/tutorial/tutorial01.rst +++ b/docs/source/tutorial/tutorial01.rst @@ -172,7 +172,7 @@ Backup that Database! That appears to be the case, but we better check it. - Call it with ``curl``: + Call it with :program:`curl`: .. code-block:: console