Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pages.es/common/nmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

- Escanea una lista específica de puertos (para todos los puertos 1-65535 usar -p-):

`nmap -p {{puerto1,puerto2,…,puertoN}} {{direccion_o_direcciones}}`
`nmap -p {{puerto1,puerto2,puerto3}} {{direccion_o_direcciones}}`

- Realiza un escaneo TCP y UDP (usar -sU para solo UDP, -sZ para SCTP, -sO para IP):

Expand Down
2 changes: 1 addition & 1 deletion pages.fr/common/git-describe.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# git describe

> Créer un nom unique et lisible pour un objet à partir dune référence disponible.
> Créer un nom unique et lisible pour un objet à partir d'une référence disponible.
> Plus d'informations : <https://git-scm.com/docs/git-describe>.

- Créer un nom unique pour le commit courant (le nom contient le tag le plus recent, le nombre de commits additionnel, and le hash abrégé du commit) :
Expand Down
4 changes: 2 additions & 2 deletions pages.it/common/calibredb.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@

- Aggiungi uno o più ebook alla libreria:

`calibredb add {{file1 file2}}`
`calibredb add {{file1}} {{file2}}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be an arbitrary number of items.

Suggested change
`calibredb add {{file1}} {{file2}}`
`calibredb add {{file1}} {{file2}} {{fileN}}`

Copy link
Contributor

@marchersimon marchersimon Apr 20, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be possible to replace path/to/file with file in general? It looks much cleaner and readable and in most cases it's redundent. In cases where it's important we could keep it.

Copy link
Contributor Author

@bl-ue bl-ue Apr 20, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a fan of path/to/file because it clearly indicates that it's a file path, as opposed to a file name (because there are commands that take a file name, not path, e.g. this). It also makes it easy to indicate if the path must be an absolute one, which, in fact, many tools require.

Also, file can look more like a variable in many contexts, whereas path/to/file is very clearly one and only one thing.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

path/to/file is our convention elsewhere, so generally speaking we prefer it over file. But file can be useful if you have many items, sure as here.


- Rimuovi uno o più ebook dalla libreria. Sono necessari gli ID (vedi sopra):

`calibredb remove {{id1 id2}}`
`calibredb remove {{id1}} {{id2}}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

Suggested change
`calibredb remove {{id1}} {{id2}}`
`calibredb remove {{id1}} {{id2}} {{idN}}`

2 changes: 1 addition & 1 deletion pages.it/common/clockwork-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@

- Monitora i log di Clockwork per più progetti:

`clockwork-cli {{percorso/a/directory1 percorso/a/directory2}}`
`clockwork-cli {{percorso/a/directory1}} {{percorso/a/directory2}}`
2 changes: 1 addition & 1 deletion pages.it/common/nmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

- Scansiona una specifica lista di porte (usa -p- per tutte le porte 1-65535):

`nmap -p {{porta1,porta2,…,portaN}} {{indirizzo_o_indirizzi}}`
`nmap -p {{porta1,porta2,porta3}} {{indirizzo_o_indirizzi}}`

- Esegui scansione TCP e UDP (usa -sU per usare solo UDP, -sZ per SCTP, -sO per IP):

Expand Down
4 changes: 2 additions & 2 deletions pages.ko/common/calibredb.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@

- 라이브러리에 전자책 하나 이상 추가하기:

`calibredb add {{파일명1 파일명2}}`
`calibredb add {{파일명1}} {{파일명2}}`

- 라이브러리에서 전자책을 하나 이상 제거하기. 전자책 ID 필요(위를 참조하시오):

`calibredb remove {{id1 id2}}`
`calibredb remove {{id1}} {{id2}}`
2 changes: 1 addition & 1 deletion pages.ko/common/clockwork-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@

- 여러 개의 프로젝트의 Clockwork 로그들을 모니터링 합니다:

`clockwork-cli {{경로/디렉토리1 경로/디렉토리2}}`
`clockwork-cli {{경로/디렉토리1}} {{경로/디렉토리2}}`
8 changes: 4 additions & 4 deletions pages.pl/common/pathchk.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@

- Sprawdź ścieżki pod kątem poprawności w obecnym systemie:

`pathchk {{ścieżka1 ścieżka2}}`
`pathchk {{ścieżka1}} {{ścieżka2}}`

- Sprawdź ścieżki pod kątem poprawności w szerszym zakresie systemów zgodnych z POSIX:

`pathchk -p {{ścieżka1 ścieżka2}}`
`pathchk -p {{ścieżka1}} {{ścieżka2}}`

- Sprawdź ścieżki pod kątem poprawności we wszystkich systemach zgodnych z POSIX:

`pathchk --portability {{ścieżka1 ścieżka2}}`
`pathchk --portability {{ścieżka1}} {{ścieżka2}}`

- Sprawdź tylko pod kątem pustych ścieżek lub wiodących myślników (-):

`pathchk -P {{ścieżka1 ścieżka2}}`
`pathchk -P {{ścieżka1}} {{ścieżka2}}`
2 changes: 1 addition & 1 deletion pages.pt_BR/common/bzip2.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# bzip2

> Um compressor de arquivos que utiliza o algoritmo BurrowsWheeler.
> Um compressor de arquivos que utiliza o algoritmo Burrows-Wheeler.

- Compactar um arquivo:

Expand Down
2 changes: 1 addition & 1 deletion pages/common/bundletool.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

- Generate APKs from an application bundle giving the keystore password:

`bundletool build-apks --bundle={{path/to/bundle.aab}} --ks={{path/to/key.keystore}} --ks-key-alias={{key_alias}} ks-pass={{pass:the_password}} --output={{path/to/file.apks}}`
`bundletool build-apks --bundle={{path/to/bundle.aab}} --ks={{path/to/key.keystore}} --ks-key-alias={{key_alias}} --ks-pass={{pass:the_password}} --output={{path/to/file.apks}}`

- Generate APKs including only one single APK for universal usage:

Expand Down
4 changes: 2 additions & 2 deletions pages/common/calibredb.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@

- Add one or more ebooks to the library:

`calibredb add {{file1 file2}}`
`calibredb add {{file1}} {{file2}}`

- Recursively add all ebooks under a directory to the library:

`calibredb add -r {{path/to/directory}}`

- Remove one or more ebooks from the library. You need ebook-ids (see above):

`calibredb remove {{id1 id2}}`
`calibredb remove {{id1}} {{id2}}`
2 changes: 1 addition & 1 deletion pages/common/clockwork-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@

- Monitor Clockwork logs for multiple projects:

`clockwork-cli {{path/to/directory1 path/to/directory2}}`
`clockwork-cli {{path/to/directory1}} {{path/to/directory2}}`
2 changes: 1 addition & 1 deletion pages/common/django-admin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# django-admin

> Django’s utility for administrative tasks.
> Perform Django administrative tasks.
> More information: <https://docs.djangoproject.com/en/3.0/ref/django-admin/>.

- Create a new django project:
Expand Down
2 changes: 1 addition & 1 deletion pages/common/git-replace.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@

`git replace --delete {{object}}`

- Edit an object’s content interactively:
- Interactively edit the content of an object:

`git replace --edit {{object}}`
2 changes: 1 addition & 1 deletion pages/common/lpr.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

`lpr -P {{printer}} {{path/to/file}}`

- Print either a single page (e.g. 2) or a range of pages (e.g. 216):
- Print either a single page (e.g. 2) or a range of pages (e.g. 2-16):

`lpr -o page-ranges={{2|2-16}} {{path/to/file}}`

Expand Down
2 changes: 1 addition & 1 deletion pages/common/nmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

- Scan a specific list of ports (use -p- for all ports 1-65535):

`nmap -p {{port1,port2,…,portN}} {{address_or_addresses}}`
`nmap -p {{port1,port2,port3}} {{address_or_addresses}}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should keep the portN here at least.

Suggested change
`nmap -p {{port1,port2,port3}} {{address_or_addresses}}`
`nmap -p {{port1,port2,portN}} {{address_or_addresses}}`


- Perform TCP and UDP scanning (use -sU for UDP only, -sZ for SCTP, -sO for IP):

Expand Down
10 changes: 5 additions & 5 deletions pages/common/pathchk.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
- Check pathames for validity in the current system:

`pathchk {{path1 path2}}`
`pathchk {{path1}} {{path2}}`
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It almost looks like the original is standard syntax for multiple options (which I'm a fan of 👍🏻). If it is, I'd like to open a new PR to standardize this across the other pages (and I'll fix it here as well). Is it?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it too. It should render to the exact same result and looks cleaner.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, not exactly the same, depending on your client. Mine, the node client, underlines text in token syntax, so the difference between the old one (which I prefer) and the new modification I made (which I'll revert) is that the old one underlines the space because the space is included between the handlebars, while in the newer version, the space is outside of them.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally in other pages I've done {{thing1}} {{thing2}} {{thingN}} personally

I think it's dependent on context


- Check pathnames for validity on a wider range of POSIX compliant systems:

`pathchk -p {{path1 path2}}`
`pathchk -p {{path1}} {{path2}}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be an arbitrary number of items, which this edit is not expressing.

Suggested change
`pathchk -p {{path1}} {{path2}}`
`pathchk -p {{path1}} {{path2}} {{pathN}}`


- Check pathnames for validity on all POSIX compliant systems:

`pathchk --portability {{path1 path2}}`
`pathchk --portability {{path1}} {{path2}}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

Suggested change
`pathchk --portability {{path1}} {{path2}}`
`pathchk --portability {{path1}} {{path2}} {{pathN}}`


- Only check for empty pathnames or leading dashes (-):
- Only check for empty pathnames or leading dashes:

`pathchk -P {{path1 path2}}`
`pathchk -P {{path1}} {{path2}}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

Suggested change
`pathchk -P {{path1}} {{path2}}`
`pathchk -P {{path1}} {{path2}} {{pathN}}`

5 changes: 3 additions & 2 deletions pages/common/samtools.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

> Tools for handling high-throughput sequencing (genomics) data.
> Used for reading/writing/editing/indexing/viewing of data in SAM/BAM/CRAM format.
> More information: <https://www.htslib.org>.
- Convert a SAM input file to BAM stream and save to file:

Expand All @@ -15,7 +16,7 @@

`samtools sort {{input}} -o {{output.bam}}`

- Index a sorted BAM file (creates {{sorted_input.bam.bai}}):
- Index a sorted BAM file (creates `sorted_input.bam.bai`):

`samtools index {{sorted_input.bam}}`

Expand All @@ -29,7 +30,7 @@

- Merge multiple files:

`samtools merge {{output}} {{input1 input2}}`
`samtools merge {{output}} {{input1}} {{input2}}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again with the changing the meaning.

Suggested change
`samtools merge {{output}} {{input1}} {{input2}}`
`samtools merge {{output}} {{input1}} {{input2}} {{inputN}}`


- Split input file according to read groups:

Expand Down
2 changes: 1 addition & 1 deletion pages/common/tig.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

- Show the history of specific files or directories:

`tig {{path1 path2}}`
`tig {{path1}} {{path2}}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`tig {{path1}} {{path2}}`
`tig {{path1}} {{path2}} {{pathN}}`


- Show the difference between two references (such as branches or tags):

Expand Down
4 changes: 2 additions & 2 deletions pages/common/wrk.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
> HTTP benchmarking tool.
> More information: <https://github.com/wg/wrk>.

- Run a benchmark for `30` seconds, using `12` threads, and keeping `400` HTTP connections open:
- Run a benchmark for `30` seconds, using `12` threads, keeping `400` HTTP connections open:

`wrk -t{{12}} -c{{400}} -d{{30s}} "{{http://127.0.0.1:8080/index.html}}"`

- Run a benchmark with a custom header:

`wrk -t{{2}} -c{{5}} -d{{5s}} -H "{{Host: example.com}}""{{http://example.com/index.html}}"`
`wrk -t{{2}} -c{{5}} -d{{5s}} -H "{{Host}}: {{example.com}}" "{{http://example.com/index.html}}"`

- Run a benchmark with a request timeout of `2` seconds:

Expand Down
2 changes: 1 addition & 1 deletion pages/linux/tshark.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

- Specify the format of captured output:

`tshark -T {{json|text|ps|}}`
`tshark -T {{ek|fields|json|jsonraw|pdml|ps|psml|tabs|text}}`

- Select specific fields to output:

Expand Down
2 changes: 1 addition & 1 deletion pages/linux/zgrep.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

`zgrep -c {{pattern}} {{path/to/compressed/file}}`

- Display the lines which dont have the pattern present (Invert the search function):
- Display the lines which don't have the pattern present (Invert the search function):

`zgrep -v {{pattern}} {{path/to/compressed/file}}`

Expand Down