From 73821c511e723e324e3f7aa9424003b8993ed412 Mon Sep 17 00:00:00 2001 Message-Id: <73821c511e723e324e3f7aa9424003b8993ed412.1667534563.git.yantar92@posteo.net> From: Ihor Radchenko Date: Fri, 4 Nov 2022 12:01:19 +0800 Subject: [PATCH] org-manual: Clarify :results file graphics header argument meaning * doc/org-manual.org (Format): Clarify the difference between :results file and :results file graphics. Update the example to something that can be tried locally. --- doc/org-manual.org | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/doc/org-manual.org b/doc/org-manual.org index dc2fc57cd..b3071ec6d 100644 --- a/doc/org-manual.org +++ b/doc/org-manual.org @@ -18408,13 +18408,17 @@ *** Format When used along with =file= type, the result is a link to the file specified in =:file= header argument. However, unlike plain =file= - type, nothing is written to the disk. The block is used for its - side-effects only, as in the following example: + type, code block output is not written to the disk. The block is + expected to generate the file by its side-effects only, as in the + following example: #+begin_example - ,#+begin_src shell :results file link :file "download.tar.gz" - wget -c "https://example.com/download.tar.gz" + ,#+begin_src shell :results file link :file "org-mode-unicorn.svg" + wget -c "https://orgmode.org/resources/img/org-mode-unicorn.svg" ,#+end_src + + ,#+RESULTS: + [[file:org-mode-unicorn.svg]] #+end_example - =org= :: -- 2.35.1