[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/org f5c89ba5f9 4/4: org-manual: Clarify :results file g
From: |
ELPA Syncer |
Subject: |
[elpa] externals/org f5c89ba5f9 4/4: org-manual: Clarify :results file graphics header argument meaning |
Date: |
Fri, 4 Nov 2022 23:57:59 -0400 (EDT) |
branch: externals/org
commit f5c89ba5f91a876e1111cbcc940e849adbb16fe2
Author: Ihor Radchenko <yantar92@posteo.net>
Commit: Ihor Radchenko <yantar92@posteo.net>
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 dc2fc57cdf..b3071ec6dc 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -18408,13 +18408,17 @@ follows from the type specified above.
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= ::