Skip to content

Commit ec9fb44

Browse files
committed
Migrate binprecice to precice-tools
1 parent 0fcb9af commit ec9fb44

File tree

3 files changed

+14
-14
lines changed

3 files changed

+14
-14
lines changed

pages/docs/configuration/configuration-overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ And some optional advanced parts:
2929
Then you should look at the [configuration reference](configuration-xml-reference.html). Also try the search here on top. The configuration reference is up to date with the last release of preCICE. If you need an older version, you can always generate this documentation yourself:
3030

3131
```bash
32-
./binprecice md > reference.md
32+
./precice-tools md > reference.md
3333
```
3434

35-
There is also an `xml` variant of the reference. Just call `binprecice` without arguments to see all options.
35+
There is also an `xml` variant of the reference. Just call `precice-tools` without arguments to see all options.
3636

3737
## You want to visualize your configuration file?
3838

pages/docs/configuration/configuration-xml-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Also try the search bar at the top of the website.
1515
{{site.data.alerts.note}}
1616
You can generate the reference yourself:
1717
<pre>
18-
./binprecice md > reference.md
18+
./precice-tools md > reference.md
1919
</pre>
2020
{{site.data.alerts.end}}
2121

pages/docs/tooling/tooling-builtin.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ keywords: tooling, xml, configuration, version
55
summary: "Built-in tooling is always installed alongside preCICE and provides some basic functionality."
66
---
77

8-
Part of a preCICE installation is the tool `binprecice`.
8+
Part of a preCICE installation is the tool `precice-tools`.
99
It provides an easy-to-use interface to tooling API of the preCICE library.
1010

11-
With `binprecice`, you can get the installed preCICE version, generate a reference of all available configuration options, as well as check your configuration file for basic configuration issues.
11+
With `precice-tools`, you can get the installed preCICE version, generate a reference of all available configuration options, as well as check your configuration file for basic configuration issues.
1212

1313
## XML reference
1414

1515
```bash
16-
binprecice md
17-
binprecice xml
18-
binprecice dtd
16+
precice-tools md
17+
precice-tools xml
18+
precice-tools dtd
1919
```
2020

2121
This prints the XML reference to the console in various flavors.
@@ -29,7 +29,7 @@ It is possible to generate a local version of the reference by rendering the Mar
2929
Be aware that this version does not contain styling, LaTeX rendering, and functioning links.
3030

3131
```bash
32-
binprecice md | markdown > reference.html
32+
precice-tools md | markdown > reference.html
3333
```
3434

3535
### `xml`
@@ -47,7 +47,7 @@ This feature is available since version 2.4.0.
4747
{% endversion %}
4848

4949
```bash
50-
binprecice version
50+
precice-tools version
5151
```
5252

5353
This prints the version information of preCICE, which consists of multiple semicolon-separated parts.
@@ -66,7 +66,7 @@ This feature is available since version 2.4.0.
6666
{% endversion %}
6767

6868
```bash
69-
binprecice check FILE [ PARTICIPANT [ COMMSIZE ] ]
69+
precice-tools check FILE [ PARTICIPANT [ COMMSIZE ] ]
7070
```
7171

7272
The `check` runs the preCICE configuration parsing and checking logic on the given configuration file.
@@ -77,7 +77,7 @@ More advanced logic, such as checks if all necessary data are exchanged in a cou
7777
The basic usage is to check a configuration file:
7878

7979
```bash
80-
binprecice check precice-config.xml
80+
precice-tools check precice-config.xml
8181
```
8282

8383
Some example errors handled by the checker:
@@ -112,6 +112,6 @@ You may additionally pass the communicator size of the participant.
112112
This enables some checks regarding user-defined intra-participant communication, which should not be necessary in the vast majority of cases.
113113

114114
```bash
115-
binprecice check precice-config.xml Fluid
116-
binprecice check precice-config.xml Fluid 2
115+
precice-tools check precice-config.xml Fluid
116+
precice-tools check precice-config.xml Fluid 2
117117
```

0 commit comments

Comments
 (0)