diff options
| author | casey <casey@users.noreply.github.com> | 2024-02-11 19:45:14 +0000 |
|---|---|---|
| committer | casey <casey@users.noreply.github.com> | 2024-02-11 19:45:14 +0000 |
| commit | c92a50c5da226c6daf7545bf25fb1a63d70b9e20 (patch) | |
| tree | d12dcb56b1a22060c2cb14f5999bb8b3dd0ee521 | |
| parent | eddba679ed3bdca7a71ceb6daf63dbadaf1f98ba (diff) | |
54 files changed, 510 insertions, 510 deletions
diff --git a/man/en/chapter_11.html b/man/en/chapter_11.html index 401b073d..2dd9400f 100644 --- a/man/en/chapter_11.html +++ b/man/en/chapter_11.html @@ -200,7 +200,7 @@ for Neovim.</p> <h4 id="makefile-syntax-highlighting"><a class="header" href="#makefile-syntax-highlighting">Makefile Syntax Highlighting</a></h4> <p>Vim’s built-in makefile syntax highlighting isn’t perfect for <code>justfile</code>s, but it’s better than nothing. You can put the following in <code>~/.vim/filetype.vim</code>:</p> -<pre><code class="language-vimscript">if exists("did_load_filetypes") +<pre><code class="language-vimscript">if exists("did_load_filetypes") finish endif diff --git a/man/en/chapter_20.html b/man/en/chapter_20.html index d2b35478..4514aa1c 100644 --- a/man/en/chapter_20.html +++ b/man/en/chapter_20.html @@ -224,7 +224,7 @@ test: build ./test sloc: - @echo "`wc -l *.c` lines of code" + @echo "`wc -l *.c` lines of code" </code></pre> <pre><code class="language-sh">$ just test cc main.c foo.c bar.c -o main diff --git a/man/en/chapter_26.html b/man/en/chapter_26.html index 001526af..0fb0bac8 100644 --- a/man/en/chapter_26.html +++ b/man/en/chapter_26.html @@ -180,7 +180,7 @@ <p>Settings control interpretation and execution. Each setting may be specified at most once, anywhere in the <code>justfile</code>.</p> <p>For example:</p> -<pre><code class="language-just">set shell := ["zsh", "-cu"] +<pre><code class="language-just">set shell := ["zsh", "-cu"] foo: # this line will be run as `zsh -cu 'ls **/*.txt'` @@ -242,7 +242,7 @@ SERVER_PORT=1337 <pre><code class="language-just">set dotenv-load serve: - @echo "Starting server with database $DATABASE_ADDRESS on port $SERVER_PORT…" + @echo "Starting server with database $DATABASE_ADDRESS on port $SERVER_PORT…" ./server --database $DATABASE_ADDRESS --port $SERVER_PORT </code></pre> <p><code>just serve</code> will output:</p> @@ -255,7 +255,7 @@ Starting server with database localhost:6379 on port 1337… variables. Defaults to <code>false</code>.</p> <pre><code class="language-just">set export -a := "hello" +a := "hello" @foo b: echo $a @@ -283,18 +283,18 @@ hello </code></pre> <p>When using an <code>sh</code>-compatible shell, such as <code>bash</code> or <code>zsh</code>, <code>$@</code> expands to the positional arguments given to the recipe, starting from one. When used -within double quotes as <code>"$@"</code>, arguments including whitespace will be passed -on as if they were double-quoted. That is, <code>"$@"</code> is equivalent to <code>"$1" "$2"</code>… -When there are no positional parameters, <code>"$@"</code> and <code>$@</code> expand to nothing +within double quotes as <code>"$@"</code>, arguments including whitespace will be passed +on as if they were double-quoted. That is, <code>"$@"</code> is equivalent to <code>"$1" "$2"</code>… +When there are no positional parameters, <code>"$@"</code> and <code>$@</code> expand to nothing (i.e., they are removed).</p> <p>This example recipe will print arguments one by one on separate lines:</p> <pre><code class="language-just">set positional-arguments @test *args='': - bash -c 'while (( "$#" )); do echo - $1; shift; done' -- "$@" + bash -c 'while (( "$#" )); do echo - $1; shift; done' -- "$@" </code></pre> <p>Running it with <em>two</em> arguments:</p> -<pre><code class="language-sh">$ just test foo "bar baz" +<pre><code class="language-sh">$ just test foo "bar baz" - foo - bar baz </code></pre> @@ -302,24 +302,24 @@ When there are no positional parameters, <code>"$@"</code> and <code>$ <p>The <code>shell</code> setting controls the command used to invoke recipe lines and backticks. Shebang recipes are unaffected.</p> <pre><code class="language-just"># use python3 to execute recipe lines and backticks -set shell := ["python3", "-c"] +set shell := ["python3", "-c"] # use print to capture result of evaluation -foos := `print("foo" * 4)` +foos := `print("foo" * 4)` foo: - print("Snake snake snake snake.") - print("{{foos}}") + print("Snake snake snake snake.") + print("{{foos}}") </code></pre> <p><code>just</code> passes the command to be executed as an argument. Many shells will need an additional flag, often <code>-c</code>, to make them evaluate the first argument.</p> <h5 id="windows-shell"><a class="header" href="#windows-shell">Windows Shell</a></h5> <p><code>just</code> uses <code>sh</code> on Windows by default. To use a different shell on Windows, use <code>windows-shell</code>:</p> -<pre><code class="language-just">set windows-shell := ["powershell.exe", "-NoLogo", "-Command"] +<pre><code class="language-just">set windows-shell := ["powershell.exe", "-NoLogo", "-Command"] hello: - Write-Host "Hello, world!" + Write-Host "Hello, world!" </code></pre> <p>See <a href="https://github.com/casey/just/blob/master/examples/powershell.just">powershell.just</a> @@ -333,22 +333,22 @@ way to control which shell is used on Windows.</em></p> <pre><code class="language-just">set windows-powershell := true hello: - Write-Host "Hello, world!" + Write-Host "Hello, world!" </code></pre> <h5 id="python-3"><a class="header" href="#python-3">Python 3</a></h5> -<pre><code class="language-just">set shell := ["python3", "-c"] +<pre><code class="language-just">set shell := ["python3", "-c"] </code></pre> <h5 id="bash"><a class="header" href="#bash">Bash</a></h5> -<pre><code class="language-just">set shell := ["bash", "-uc"] +<pre><code class="language-just">set shell := ["bash", "-uc"] </code></pre> <h5 id="z-shell"><a class="header" href="#z-shell">Z Shell</a></h5> -<pre><code class="language-just">set shell := ["zsh", "-uc"] +<pre><code class="language-just">set shell := ["zsh", "-uc"] </code></pre> <h5 id="fish"><a class="header" href="#fish">Fish</a></h5> -<pre><code class="language-just">set shell := ["fish", "-c"] +<pre><code class="language-just">set shell := ["fish", "-c"] </code></pre> <h5 id="nushell"><a class="header" href="#nushell">Nushell</a></h5> -<pre><code class="language-just">set shell := ["nu", "-c"] +<pre><code class="language-just">set shell := ["nu", "-c"] </code></pre> <p>If you want to change the default table mode to <code>light</code>:</p> <pre><code class="language-just">set shell := ['nu', '-m', 'light', '-c'] diff --git a/man/en/chapter_28.html b/man/en/chapter_28.html index ea3c01c3..63c61545 100644 --- a/man/en/chapter_28.html +++ b/man/en/chapter_28.html @@ -180,9 +180,9 @@ <p>Variables, strings, concatenation, path joining, and substitution using <code>{{…}}</code> are supported:</p> <pre><code class="language-just">tmpdir := `mktemp -d` -version := "0.2.7" -tardir := tmpdir / "awesomesauce-" + version -tarball := tardir + ".tar.gz" +version := "0.2.7" +tardir := tmpdir / "awesomesauce-" + version +tarball := tardir + ".tar.gz" publish: rm -f {{tarball}} @@ -194,20 +194,20 @@ publish: </code></pre> <h4 id="joining-paths"><a class="header" href="#joining-paths">Joining Paths</a></h4> <p>The <code>/</code> operator can be used to join two strings with a slash:</p> -<pre><code class="language-just">foo := "a" / "b" +<pre><code class="language-just">foo := "a" / "b" </code></pre> <pre><code>$ just --evaluate foo a/b </code></pre> <p>Note that a <code>/</code> is added even if one is already present:</p> -<pre><code class="language-just">foo := "a/" -bar := foo / "b" +<pre><code class="language-just">foo := "a/" +bar := foo / "b" </code></pre> <pre><code>$ just --evaluate bar a//b </code></pre> <p>Absolute paths can also be constructed<sup>1.5.0</sup>:</p> -<pre><code class="language-just">foo := / "b" +<pre><code class="language-just">foo := / "b" </code></pre> <pre><code>$ just --evaluate foo /b @@ -227,9 +227,9 @@ interpolation:</p> <pre><code class="language-just">braces: echo '{{'I {{LOVE}} curly braces!'}}' </code></pre> -<p>Yet another option is to use <code>{{ "{{" }}</code>:</p> +<p>Yet another option is to use <code>{{ "{{" }}</code>:</p> <pre><code class="language-just">braces: - echo 'I {{ "{{" }}LOVE}} curly braces!' + echo 'I {{ "{{" }}LOVE}} curly braces!' </code></pre> </main> diff --git a/man/en/chapter_29.html b/man/en/chapter_29.html index b958b5bc..1b4cdff0 100644 --- a/man/en/chapter_29.html +++ b/man/en/chapter_29.html @@ -178,37 +178,37 @@ <main> <h3 id="strings"><a class="header" href="#strings">Strings</a></h3> <p>Double-quoted strings support escape sequences:</p> -<pre><code class="language-just">string-with-tab := "\t" -string-with-newline := "\n" -string-with-carriage-return := "\r" -string-with-double-quote := "\"" -string-with-slash := "\\" -string-with-no-newline := "\ -" +<pre><code class="language-just">string-with-tab := "\t" +string-with-newline := "\n" +string-with-carriage-return := "\r" +string-with-double-quote := "\"" +string-with-slash := "\\" +string-with-no-newline := "\ +" </code></pre> <pre><code class="language-sh">$ just --evaluate -"tring-with-carriage-return := " -string-with-double-quote := """ -string-with-newline := " -" -string-with-no-newline := "" -string-with-slash := "\" -string-with-tab := " " +"tring-with-carriage-return := " +string-with-double-quote := """ +string-with-newline := " +" +string-with-no-newline := "" +string-with-slash := "\" +string-with-tab := " " </code></pre> <p>Strings may contain line breaks:</p> <pre><code class="language-just">single := ' hello ' -double := " +double := " goodbye -" +" </code></pre> <p>Single-quoted strings do not recognize escape sequences:</p> -<pre><code class="language-just">escapes := '\t\n\r\"\\' +<pre><code class="language-just">escapes := '\t\n\r\"\\' </code></pre> <pre><code class="language-sh">$ just --evaluate -escapes := "\t\n\r\"\\" +escapes := "\t\n\r\"\\" </code></pre> <p>Indented versions of both single- and double-quoted strings, delimited by triple single- or triple double-quotes, are supported. Indented string lines @@ -221,11 +221,11 @@ x := ''' ''' # this string will evaluate to `abc\n wuv\nxyz\n` -y := """ +y := """ abc wuv xyz -""" +""" </code></pre> <p>Similar to unindented strings, indented double-quoted strings process escape sequences, and indented single-quoted strings ignore escape sequences. Escape diff --git a/man/en/chapter_3.html b/man/en/chapter_3.html index d0a818ff..826ab90a 100644 --- a/man/en/chapter_3.html +++ b/man/en/chapter_3.html @@ -187,14 +187,14 @@ and the BSDs.</p> shell of your choice.</p> <p>Like PowerShell:</p> <pre><code class="language-just"># use PowerShell instead of sh: -set shell := ["powershell.exe", "-c"] +set shell := ["powershell.exe", "-c"] hello: - Write-Host "Hello, world!" + Write-Host "Hello, world!" </code></pre> <p>…or <code>cmd.exe</code>:</p> <pre><code class="language-just"># use cmd.exe instead of sh: -set shell := ["cmd.exe", "/c"] +set shell := ["cmd.exe", "/c"] list: dir diff --git a/man/en/chapter_31.html b/man/en/chapter_31.html index 08211c08..1d46a1f4 100644 --- a/man/en/chapter_31.html +++ b/man/en/chapter_31.html @@ -181,20 +181,20 @@ recipes.</p> <h4 id="system-information"><a class="header" href="#system-information">System Information</a></h4> <ul> -<li><code>arch()</code> — Instruction set architecture. Possible values are: <code>"aarch64"</code>, -<code>"arm"</code>, <code>"asmjs"</code>, <code>"hexagon"</code>, <code>"mips"</code>, <code>"msp430"</code>, <code>"powerpc"</code>, -<code>"powerpc64"</code>, <code>"s390x"</code>, <code>"sparc"</code>, <code>"wasm32"</code>, <code>"x86"</code>, <code>"x86_64"</code>, and -<code>"xcore"</code>.</li> +<li><code>arch()</code> — Instruction set architecture. Possible values are: <code>"aarch64"</code>, +<code>"arm"</code>, <code>"asmjs"</code>, <code>"hexagon"</code>, <code>"mips"</code>, <code>"msp430"</code>, <code>"powerpc"</code>, +<code>"powerpc64"</code>, <code>"s390x"</code>, <code>"sparc"</code>, <code>"wasm32"</code>, <code>"x86"</code>, <code>"x86_64"</code>, and +<code>"xcore"</code>.</li> <li><code>num_cpus()</code><sup>1.15.0</sup> - Number of logical CPUs.</li> -<li><code>os()</code> — Operating system. Possible values are: <code>"android"</code>, <code>"bitrig"</code>, -<code>"dragonfly"</code>, <code>"emscripten"</code>, <code>"freebsd"</code>, <code>"haiku"</code>, <code>"ios"</code>, <code>"linux"</code>, -<code>"macos"</code>, <code>"netbsd"</code>, <code>"openbsd"</code>, <code>"solaris"</code>, and <code>"windows"</code>.</li> -<li><code>os_family()</code> — Operating system family; possible values are: <code>"unix"</code> and -<code>"windows"</code>.</li> +<li><code>os()</code> — Operating system. Possible values are: <code>"android"</code>, <code>"bitrig"</code>, +<code>"dragonfly"</code>, <code>"emscripten"</code>, <code>"freebsd"</code>, <code>"haiku"</code>, <code>"ios"</code>, <code>"linux"</code>, +<code>"macos"</code>, <code>"netbsd"</code>, <code>"openbsd"</code>, <code>"solaris"</code>, and <code>"windows"</code>.</li> +<li><code>os_family()</code> — Operating system family; possible values are: <code>"unix"</code> and +<code>"windows"</code>.</li> </ul> <p>For example:</p> <pre><code class="language-just">system-info: - @echo "This is an {{arch()}} machine". + @echo "This is an {{arch()}} machine". </code></pre> <pre><code class="language-sh">$ just system-info This is an x86_64 machine @@ -211,7 +211,7 @@ if it is not present.</li> <pre><code class="language-just">home_dir := env_var('HOME') test: - echo "{{home_dir}}" + echo "{{home_dir}}" </code></pre> <pre><code class="language-sh">$ just /home/user1 @@ -323,32 +323,32 @@ and the rest to lowercase.</li> <h5 id="fallible"><a class="header" href="#fallible">Fallible</a></h5> <ul> <li><code>absolute_path(path)</code> - Absolute path to relative <code>path</code> in the working -directory. <code>absolute_path("./bar.txt")</code> in directory <code>/foo</code> is +directory. <code>absolute_path("./bar.txt")</code> in directory <code>/foo</code> is <code>/foo/bar.txt</code>.</li> -<li><code>canonicalize(path)</code> - Canonicalize <code>path</code> by resolving symlinks and removing +<li><code>canonicalize(path)</code><sup>1.24.0</sup> - Canonicalize <code>path</code> by resolving symlinks and removing <code>.</code>, <code>..</code>, and extra <code>/</code>s where possible.</li> -<li><code>extension(path)</code> - Extension of <code>path</code>. <code>extension("/foo/bar.txt")</code> is +<li><code>extension(path)</code> - Extension of <code>path</code>. <code>extension("/foo/bar.txt")</code> is <code>txt</code>.</li> <li><code>file_name(path)</code> - File name of <code>path</code> with any leading directory components -removed. <code>file_name("/foo/bar.txt")</code> is <code>bar.txt</code>.</li> +removed. <code>file_name("/foo/bar.txt")</code> is <code>bar.txt</code>.</li> <li><code>file_stem(path)</code> - File name of <code>path</code> without extension. -<code>file_stem("/foo/bar.txt")</code> is <code>bar</code>.</li> +<code>file_stem("/foo/bar.txt")</code> is <code>bar</code>.</li> <li><code>parent_directory(path)</code> - Parent directory of <code>path</code>. -<code>parent_directory("/foo/bar.txt")</code> is <code>/foo</code>.</li> +<code>parent_directory("/foo/bar.txt")</code> is <code>/foo</code>.</li> <li><code>without_extension(path)</code> - <code>path</code> without extension. -<code>without_extension("/foo/bar.txt")</code> is <code>/foo/bar</code>.</li> +<code>without_extension("/foo/bar.txt")</code> is <code>/foo/bar</code>.</li> </ul> <p>These functions can fail, for example if a path does not have an extension, which will halt execution.</p> <h5 id="infallible"><a class="header" href="#infallible">Infallible</a></h5> <ul> <li><code>clean(path)</code> - Simplify <code>path</code> by removing extra path separators, -intermediate <code>.</code> components, and <code>..</code> where possible. <code>clean("foo//bar")</code> is -<code>foo/bar</code>, <code>clean("foo/..")</code> is <code>.</code>, <code>clean("foo/./bar")</code> is <code>foo/bar</code>.</li> +intermediate <code>.</code> components, and <code>..</code> where possible. <code>clean("foo//bar")</code> is +<code>foo/bar</code>, <code>clean("foo/..")</code> is <code>.</code>, <code>clean("foo/./bar")</code> is <code>foo/bar</code>.</li> <li><code>join(a, b…)</code> - <em>This function uses <code>/</code> on Unix and <code>\</code> on Windows, which can be lead to unwanted behavior. The <code>/</code> operator, e.g., <code>a / b</code>, which always uses <code>/</code>, should be considered as a replacement unless <code>\</code>s are specifically -desired on Windows.</em> Join path <code>a</code> with path <code>b</code>. <code>join("foo/bar", "baz")</code> is +desired on Windows.</em> Join path <code>a</code> with path <code>b</code>. <code>join("foo/bar", "baz")</code> is <code>foo/bar/baz</code>. Accepts two or more arguments.</li> </ul> <h4 id="filesystem-access"><a class="header" href="#filesystem-access">Filesystem Access</a></h4> @@ -372,8 +372,8 @@ hexadecimal string.</li> <h4 id="semantic-versions"><a class="header" href="#semantic-versions">Semantic Versions</a></h4> <ul> <li><code>semver_matches(version, requirement)</code><sup>1.16.0</sup> - Check whether a -<a href="https://semver.org">semantic <code>version</code></a>, e.g., <code>"0.1.0"</code> matches a -<code>requirement</code>, e.g., <code>">=0.1.0"</code>, returning <code>"true"</code> if so and <code>"false"</code> +<a href="https://semver.org">semantic <code>version</code></a>, e.g., <code>"0.1.0"</code> matches a +<code>requirement</code>, e.g., <code>">=0.1.0"</code>, returning <code>"true"</code> if so and <code>"false"</code> otherwise.</li> </ul> <h5 id="xdg-directories1230"><a class="header" href="#xdg-directories1230">XDG Directories<sup>1.23.0</sup></a></h5> diff --git a/man/en/chapter_32.html b/man/en/chapter_32.html index 6009fcba..2a513d71 100644 --- a/man/en/chapter_32.html +++ b/man/en/chapter_32.html @@ -180,7 +180,7 @@ <p>Recipes may be annotated with attributes that change their behavior.</p> <div class="table-wrapper"><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody> <tr><td><code>[confirm]</code><sup>1.17.0</sup></td><td>Require confirmation prior to executing recipe.</td></tr> -<tr><td><code>[confirm("prompt")]</code><sup>1.23.0</sup></td><td>Require confirmation prior to executing recipe with a custom prompt.</td></tr> +<tr><td><code>[confirm("prompt")]</code><sup>1.23.0</sup></td><td>Require confirmation prior to executing recipe with a custom prompt.</td></tr> <tr><td><code>[linux]</code><sup>1.8.0</sup></td><td>Enable recipe on Linux.</td></tr> <tr><td><code>[macos]</code><sup>1.8.0</sup></td><td>Enable recipe on MacOS.</td></tr> <tr><td><code>[no-cd]</code><sup>1.9.0</sup></td><td>Don’t change directory before executing recipe.</td></tr> @@ -195,12 +195,12 @@ <pre><code class="language-just">[no-cd] [private] foo: - echo "foo" + echo "foo" </code></pre> <p>Or separated by commas on a single line<sup>1.14.0</sup>:</p> <pre><code class="language-just">[no-cd, private] foo: - echo "foo" + echo "foo" </code></pre> <h4 id="enabling-and-disabling-recipes180"><a class="header" href="#enabling-and-disabling-recipes180">En |