From: Nick Dokos <ndokos@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Re: How to escape # character in #+begin_src bash block for html export?
Date: Sun, 25 Mar 2018 18:10:18 -0400 [thread overview]
Message-ID: <87o9jbbyd1.fsf@alphaville.usersys.redhat.com> (raw)
In-Reply-To: 87tvt4o8gh.fsf@luisa.c0t0d0s0.de
Michael Welle <mwe012008@gmx.net> writes:
> Hello,
>
> Abigaile Johannesburg <abij@tuta.io> writes:
>
>> Dear community,
>>
>> I have a minor question about how to escape '#' character in
>> #+begin_src bash block. For example, when I export the source code
>> block for bash, I can use
>>
>> #+begin_src bash
>> $<some bash command for normal user>
>> #+end_src
>>
>>
>> But if I want to use # for indicating commands for root or privileged
>> user, if I use
>>
>> #+begin_src bash
>> #<some bash command for root user>
>> #+end_src
>>
>> then the commands after '#' will be in italics, i.e., they are treated
>> as comments in html export.
>>
>> How do I solve this problem?
> I'm not sure if I understand your problem correctly. # starts a comment
> in shell, and $ denotes (among others maybe) a variable name. In that
> sense
>
> #+begin_src bash
> $ls
> #+end_src
>
>
> delivers the value of the variable ls. The semantic of $ is not to
> execute the command ls as a non-root user. Same goes for #. If you want
> to put your own semantics into $ and # it might be better to not use a
> bash code block.
>
> If you want to note that some commands in a script needs root privilege,
> maybe something like this would do the trick:
>
> #+begin_src bash
> ls
> su - -c 'fdisk /dev/rdsk/c0d1/p0'
> emacs&
> #+end_src
>
> Regards
> hmw
>
>
As Michael Welle points out
#+begin_src shell
# date
#+end_src
is a do-nothing source block since the command is commented out.
If you are trying to produce documentation and want to show commands
that the user should type then you probably need an example block:
#+begin_example
# date
#+end_example
--
Nick
next prev parent reply other threads:[~2018-03-25 22:10 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-03-22 16:18 How to escape # character in #+begin_src bash block for html export? Abigaile Johannesburg
2018-03-25 8:39 ` Michael Welle
2018-03-25 22:10 ` Nick Dokos [this message]
2018-03-26 9:32 ` Michael Welle
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87o9jbbyd1.fsf@alphaville.usersys.redhat.com \
--to=ndokos@gmail.com \
--cc=emacs-orgmode@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).