18
Documenting commands # or $ before sudo? (feditown.com)
submitted 11 months ago by exu@feditown.com to c/linux@lemmy.ml
28 comments fedilink hide all child comments

This might be a stupid question, but hear me out.
I regularly document steps to install various software for myself on my wiki
More recently, I managed to use different custom text in the source markdown to prepend # and $ automatically, so commands can be copied more easily while still clarifying if it should be run as a normal user or as root.

Run command as user

$ some cool command

Run command as root/superuser with sudo

# some dangerous command

I usually remove and sudo and use the # prefix. However, in some cases, the sudo actually does something different that needs to be highlighted. For example, I might use it to execute a command as the user www-data

sudo -u www-data cp /var/www/html/html1 /var/www/html/html2

I often use $ as a prefix, but # would also make sense.
How would you prefix that line?

you are viewing a single comment's thread
view the rest of the comments
[-] canpolat@programming.dev 14 points 11 months ago* (last edited 11 months ago)

I don't work much with Linux systems these days, but I would vote for $ sudo over #. Two reasons:

  1. It's easy to overlook the prompt. That part is basically "some characters before the actual command", so I don't normally pay attention to it.
  2. # is also used for comments. I think it would be confusing to use the same character for two wildly different things.
[-] exu@feditown.com 3 points 11 months ago

So $ sudo in general any time I need to run something as root?
I'll have to think about that some more. I think I rather dislike "forcing" sudo on all commands as root.

[-] canpolat@programming.dev 3 points 11 months ago

Ok, maybe I misunderstood your question. I though you were proposing # instead of $ sudo and I meant to say that being explicit is better.

[-] exu@feditown.com 1 points 11 months ago

I typed the post in a minute and published, so it definitely isn't the most coherent or well thought out post.
I'm currently using # for commands executed by the root user or sudo.
Currently, I only use sudo if the command depends on one of its features. Like the example above where I execute a command as the www-data user.
My dilemma was whether to use $ sudo or # sudo for those few cases. But based on yours and other comments, it might make sense to use $ sudo for commands executed as root as well.

this post was submitted on 11 Jul 2023
18 points (100.0% liked)

Linux

45443 readers
1385 users here now

From Wikipedia, the free encyclopedia

Linux is a family of open source Unix-like operating systems based on the Linux kernel, an operating system kernel first released on September 17, 1991 by Linus Torvalds. Linux is typically packaged in a Linux distribution (or distro for short).

Distributions include the Linux kernel and supporting system software and libraries, many of which are provided by the GNU Project. Many Linux distributions use the word "Linux" in their name, but the Free Software Foundation uses the name GNU/Linux to emphasize the importance of GNU software, causing some controversy.

Rules

Related Communities

Community icon by Alpár-Etele Méder, licensed under CC BY 3.0

founded 5 years ago
MODERATORS
AgreeableLandscape@lemmy.ml
nooter692@lemmy.ml
MarcellusDrum@lemmy.ml
cypherpunks@lemmy.ml
cyclohexane@lemmy.ml
d3Xt3r@lemmy.nz