Skip to content

Commit 2d4f726

Browse files
committed
docs
1 parent 9b49ee4 commit 2d4f726

File tree

11 files changed

+36
-34
lines changed

11 files changed

+36
-34
lines changed
104 KB
Loading
-11.1 KB
Loading

docs/src/components/buildinfo.astro

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Qt: ${data.qt6 || "6.6.2"}
1111
Libtorrent: ${data.libtorrent_2_0 || "2.0.10"}
1212
Boost: ${data.boost || "1.84.0"}
1313
OpenSSL: ${data.openssl || "3.2.1"}
14-
zlib: ${data.zlib || "1.3.2"}.zlib-ng`;
14+
zlib: ${data.zlib || "1.3.2"}-motley`;
1515
1616
// {
1717
// "glibc_2_31": "2.31",

docs/src/content/docs/build-help.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import {
2121
Once the script has successfully configured the platform you can execute the help switch to see how it works and what options you have available to you.
2222

2323
```bash
24-
./qbittorrent-nox-static.sh -h
24+
./qbt-nox-static.bash -h
2525
```
2626

2727
## Order of preference
@@ -157,7 +157,7 @@ The `--bootstrap-release` and `--bootstrap-multi-arch` options are specific to G
157157

158158
Module specific help - flags are used with the modules listed here.
159159

160-
Use: all or module-name Usage: ~/qbittorrent-nox-static.sh all -i
160+
Use: all or module-name Usage: ~/qbt-nox-static.bash all -i
161161

162162
all ---------------- optional Recommended method to install all modules
163163
install ------------ optional Install the ~/qbt-build/completed/qbittorrent-nox binary
@@ -272,7 +272,7 @@ Add your patches there, for example.
272272
Install all default modules (ICU is skipped) and build `qbittorrent-nox` to the default build directory `qbt-build/compelted`.
273273

274274
```bash
275-
./qbittorrent-nox-static.sh all
275+
./qbt-nox-static.bash all
276276
```
277277

278278
## Build - modules (optional and mostly for debugging and testing)
@@ -284,7 +284,7 @@ It's best to consider all individual modules listed below as being dependent on
284284
:::
285285
286286
```bash
287-
./qbittorrent-nox-static.sh module
287+
./qbt-nox-static.bash module
288288
```
289289
290290
Here are the list of supported modules:
@@ -326,5 +326,5 @@ The `-b` flag accepts both full `/opt` and relative `opt` paths.
326326
:::
327327
328328
```bash
329-
./qbittorrent-nox-static.sh all -b "/opt"
329+
./qbt-nox-static.bash all -b "/opt"
330330
```

docs/src/content/docs/glossary/qemu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ hide_title: true
77

88
---
99

10-
We use [qemu-user-static](https://packages.ubuntu.com/lunar/qemu-user-static) and [binfmt-support](https://packages.ubuntu.com/lunar/binfmt-support) on the Github `ubuntu-latest` runners, from the [Lunar](https://releases.ubuntu.com/lunar) repo to overcome a bug in older versions.
10+
We use [qemu-user-static](https://packages.ubuntu.com/noble/qemu-user-static) and [binfmt-support](https://packages.ubuntu.com/noble/binfmt-support) on the Github `ubuntu-latest` runners
1111

1212
For example, when cross compiling Qt6 you they want you to have a have a host version built first and then use loads of special cmake settings.
1313

docs/src/content/docs/install-qbittorrent.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ import { Advanced, Charts, Details, Modal, Steps, Tabs, TabItem, Card, CardGrid,
88
Once the script has successfully built `qbittorrent-nox` you can install the binary using this command:
99

1010
```bash
11-
bash ~/qbittorrent-nox-static.sh install
11+
bash ~/qbt-nox-static.bash install
1212
```
1313

1414
:::tip
1515
If you built to a custom directory you will need to specify this to the install command using the `-b` argument.
1616
:::
1717

1818
```bash
19-
bash ~/qbittorrent-nox-static.sh -b "/path/to/built/binary" install
19+
bash ~/qbt-nox-static.bash -b "/path/to/built/binary" install
2020
```
2121

2222
The default installation path is determined by type of user executing the script.

docs/src/content/docs/introduction.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ import { Advanced, BuildInfo, Charts, Details, Modal, Steps, Tabs, TabItem, Card
77

88
## What is it?
99

10-
`qbittorrent-nox-static.sh` was originally a simple, amateurish bash script, to build a static `qbittorrent-nox` binary for `x86_64`. The script has grown and evolved since then and now it's a complicated bash script.
10+
`qbt-nox-static.bash` was originally a simple, amateurish bash script, to build a static `qbittorrent-nox` binary for `x86_64`. The script has grown and evolved since then and now it's a complicated bash script.
1111

1212
:::note
13-
`qbt-nox-static.bash™` is `v2.1.1` and `qbittorrent-nox-static.sh™` is `v2.0.16`. The former is a fork of the latter, from this version, with changes specific to the dependency handling, which in turn makes breaking changes to the default behavior of the script. Combined with renaming the script to `.bash` from `.sh` as it is not a POSIX compliant script this would effectively have made `qbittorrent-nox-static.sh` unavailable for use.
13+
`qbt-nox-static.bash™` is `v2.2.0` and `qbittorrent-nox-static.sh™` is `v2.0.20`. The former is a fork of the latter, from this version, with changes specific to the dependency handling, which in turn makes breaking changes to the default behavior of the script. Combined with renaming the script to `.bash` from `.sh` as it is not a POSIX compliant script this would effectively have made `qbt-nox-static.bash` unavailable for use.
1414

15-
So the existence of the two is a transitional change and the `qbittorrent-nox-static.sh` will be deprecated in the future, though any non breaking changes will be backported to the original script.
15+
So the existence of the two is a transitional change and the `qbt-nox-static.bash` will be deprecated in the future, though any non breaking changes will be backported to the original script.
1616
:::
1717

1818
### What does it do?
@@ -35,7 +35,7 @@ It handles a lot of the nuanced complexity around building various different dep
3535
`riscv64`
3636
</Details>
3737

38-
⭐ On supported host build platforms the `qbittorrent-nox-static.sh` will perform these three main tasks via simple prompt:
38+
⭐ On supported host build platforms the `qbt-nox-static.bash` will perform these three main tasks via simple prompt:
3939

4040
<Steps>
4141

docs/src/content/docs/patching.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The script supports the automatic patching of all modules when building, providi
2222
Here is an example local directory structure that the script will use to apply patches to libtorrent `v1.2.19` and qBittorrent `release-5.0.3`
2323

2424
<FileTree>
25-
- qbittorrent-nox-static.sh
25+
- qbt-nox-static.bash
2626
- qbt-build
2727
- patches
2828
- libtorrent/
@@ -40,7 +40,7 @@ Here is an example local directory structure that the script will use to apply p
4040
Use the help command to get more information
4141

4242
```bash
43-
./qbittorrent-nox-static.sh -h-pr
43+
./qbt-nox-static.bash -h-pr
4444
```
4545
:::
4646

@@ -83,13 +83,13 @@ When bootstrapping the script will create the required directory structure using
8383
In this example we will apply a real patch that can be used with this script from this pinned issue: https://github.com/userdocs/qbittorrent-nox-static/issues/149
8484

8585
:::note
86-
We will assume you are in folder with the `qbittorrent-nox-static.sh` script.
86+
We will assume you are in folder with the `qbt-nox-static.bash` script.
8787
:::
8888

8989
Step 1: Boot strap the patches directory
9090

9191
```bash
92-
qbittorrent-nox-static.sh -bs-p
92+
qbt-nox-static.bash -bs-p
9393
```
9494

9595
Step 2: Clone the qBittorrent repo targeting the specific tag we want to patch - `--branch release-5.0.3`
@@ -134,7 +134,7 @@ Some modules like libtorrent and qbittorrent have multiple tags that can be used
134134
Using the `-qt` and -`lt` switches here:
135135

136136
```bash
137-
~/qbittorrent-nox-static.sh -qt master -lt RC_2_0 -bs
137+
~/qbt-nox-static.bash -qt master -lt RC_2_0 -bs
138138
```
139139

140140
or
@@ -158,7 +158,7 @@ Only the env variables will persist between uses of the script.
158158
:::
159159

160160
```bash
161-
qbittorrent-nox-static.sh -qt master -lt RC_2_0 all
161+
qbt-nox-static.bash -qt master -lt RC_2_0 all
162162
```
163163

164164
### Git based patching
@@ -187,7 +187,7 @@ patches/libtorrent/v1.2.12/patch
187187

188188
The all you do is use the `pr` switch when using the script. The repo URL is abbreviated to your username and repo:
189189

190-
`bash ~/qbittorrent-nox-static.sh all -pr username/repo`
190+
`bash ~/qbt-nox-static.bash all -pr username/repo`
191191

192192
Then the patch file will be automatically matched to the tag used by the script and loaded.
193193

docs/src/content/docs/rules-of-engagement.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,17 @@ import { Advanced, Charts, Details, Modal, Steps, Tabs, TabItem, Card, CardGrid,
3838
:::
3939

4040
- `qbt-nox-static.bash` - will make no changes and instead provide information on what you need to do.
41-
- `qbittorrent-nox-static.sh` - will automatically install the required dependencies and configure the build environment.
41+
- `qbt-nox-static.bash` - will automatically install the required dependencies and configure the build environment.
4242

4343
6. ### Nothing is built until...
4444

4545
- you provide the `all` or a specific module name as a positional parameter to the script.
46-
- applies to both `qbt-nox-static.bash` and `qbittorrent-nox-static.sh`
46+
- applies to both `qbt-nox-static.bash` and `qbt-nox-static.bash`
4747

4848
7. ### Use the help.
4949

50-
- Use `bash ~/qbittorrent-nox-static.sh -h` to see the help.
51-
- applies to both `qbt-nox-static.bash` and `qbittorrent-nox-static.sh`
50+
- Use `bash ~/qbt-nox-static.bash -h` to see the help.
51+
- applies to both `qbt-nox-static.bash` and `qbt-nox-static.bash`
5252

5353
8. ### fork the repo
5454

docs/src/content/docs/script-installation.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ docker run -it -w /root -p 8080:8080 -v ~/qbt:/root alpine:edge /bin/ash -c 'apk
5353
If you need to download the script use this command
5454

5555
```bash
56-
curl -sLo qbittorrent-nox-static.sh git.io/qbstatic && chmod +x qbittorrent-nox-static.sh
56+
curl -sLo qbt-nox-static.bash git.io/qbstatic && chmod +x qbt-nox-static.bash
5757
```
5858

5959
</TabItem>
@@ -73,7 +73,7 @@ docker run -it -w /root -p 8080:8080 -e "LANG=C.UTF-8" -v ~/qbt:/root debian:lat
7373
If you need to download the script use this command
7474

7575
```bash
76-
curl -sLo qbittorrent-nox-static.sh git.io/qbstatic && chmod +x qbittorrent-nox-static.sh
76+
curl -sLo qbt-nox-static.bash git.io/qbstatic && chmod +x qbt-nox-static.bash
7777
```
7878

7979
</TabItem>
@@ -92,7 +92,7 @@ docker run -it -w /root -p 8080:8080 -e "LANG=C.UTF-8" -v ~/qbt:/root ubuntu:lat
9292
If you need to download the script use this command
9393

9494
```bash
95-
curl -sLo qbittorrent-nox-static.sh git.io/qbstatic && chmod +x qbittorrent-nox-static.sh
95+
curl -sLo qbt-nox-static.bash git.io/qbstatic && chmod +x qbt-nox-static.bash
9696
```
9797

9898
</TabItem>

0 commit comments

Comments
 (0)