Notation

Type it in a console window

On this site, you may see code blocks such as the following.

pluck delay 0

or this

$ pluck delay 0

The dollar-sign, if present, is a unix-based convention to indicate a console window prompt. Everything following the $ , but not the $ itself, is to be typed in a console window (a.k.a., a terminal). In this case, a console window should be opened, and the user should type

pluck delay 0

On Windows, a console window prompt looks like this:

C:\>

Again, the leading characters up to > should not be typed. They are the console prompt and they are shown as a convention. As a final example, consider the following code block that shows how to export Plucky settings into a pluckeye-settings.txt file on the user’s desktop.

C:\> pluck export >%HOMEPATH%\Desktop\pluckeye-settings.txt

The actual characters typed by the user to execute the above commands are these, with a “return” or “enter” hit at the end of each line:

pluck export >%HOMEPATH%\Desktop\pluckeye-settings.txt

Comments

Editorial annotations are sometimes added to the code blocks on this site. Such annotations start with the ‘#’ character to indicate a comment. For example,

pluck delay 12m        # Do not type the # or anything after it
pluck delay 24m        # because it is is an editorial comment.
pluck delay 24m        # The computer will not understand it.

TODO

Maybe use asciicast / asciinema and/or animated gifs.

What’s a console window?

See how to open a console window.