diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index aefef92689..8f5cf2d952 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -21,7 +21,7 @@ jobs: python-version: '3.12' cache: 'pip' - - uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0 + - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 with: node-version: 'lts/*' cache: 'npm' diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml index 6931b8057a..87925c3fe3 100644 --- a/.github/workflows/codespell.yml +++ b/.github/workflows/codespell.yml @@ -17,7 +17,7 @@ jobs: - name: Get changed files id: changed-files - uses: tj-actions/changed-files@6cb76d07bee4c9772c6882c06c37837bf82a04d3 # v46.0.4 + uses: tj-actions/changed-files@ed68ef82c095e0d48ec87eccea555d944a631a4c # v46.0.5 with: # Ignore all other languages except English files_ignore: | diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 5d2bc8f0d0..f4566082b6 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -90,6 +90,8 @@ If you are an owner of the organization, you can see an automated list [here](ht [24 August 2020](https://github.com/tldr-pages/tldr/issues/4291) — [5 October 2020](https://github.com/tldr-pages/tldr/issues/4504), [14 November 2024](https://github.com/tldr-pages/tldr/issues/14541) — present - **witt ([@witt-bit](https://github.com/witt-bit))**: [14 January 2025](https://github.com/tldr-pages/tldr/issues/15514) — present +- **Amine LOUHICHI ([@aminelch](https://github.com/aminelch))**: +[08 April 2025](https://github.com/tldr-pages/tldr/issues/16126) — present - Owen Voke ([@owenvoke](https://github.com/owenvoke)) [11 January 2018](https://github.com/tldr-pages/tldr/issues/1885) — [26 August 2018](https://github.com/tldr-pages/tldr/issues/2258) - Marco Bonelli ([@mebeim](https://github.com/mebeim)): diff --git a/contributing-guides/style-guide.ar.md b/contributing-guides/style-guide.ar.md new file mode 100644 index 0000000000..2257e1baad --- /dev/null +++ b/contributing-guides/style-guide.ar.md @@ -0,0 +1,368 @@ +# إرشادات التنسيق + +تستعرض هذه الصفحة إرشادات التنسيق لصفحات `tldr` الخاصة باللغة العربية. + +## التنسيق العام + +يجب أن يتبع الشكل الأساسي لكل صفحة القالب التالي وألا يتجاوز 8 أمثلة للأمر الواحد: + +```md +# اسم الأمر + +> وصف مختصر وواضح للأمر. +> يفضل أن يكون في سطر واحد؛ سطرين مقبولين إذا لزم الأمر. +> لمزيد من التفاصيل: . + +- وصف الكود: + +`command_name options` + +- وصف الكود: + +`command_name options` + +... +``` + +مثال: + +```md +# krita + +> برنامج للرسم والتلوين مصمم للفنانين الرقميين. +> انظر أيضًا: `gimp`. +> مزيد من التفاصيل: . + +- بدء Krita: + +`krita` + +- فتح ملفات محددة: + +`krita {{path/to/image1 path/to/image2 ...}}` + +- بدء بدون شاشة بداية: + +`krita --nosplash` + +- بدء مع مساحة عمل معينة: + +`krita --workspace {{Animation}}` + +- بدء في وضع ملء الشاشة: + +`krita --fullscreen` +``` + +> [!NOTE] +> يجب أن يتطابق اسم ملف الصفحة والعنوان مع اسم الأمر تمامًا. يمكن أن يكون عنوان الصفحة بأي حالة حروف، بينما يجب أن تكون أسماء ملفات Markdown الخاصة بالصفحات بحروف صغيرة. + +هناك أداة "linter" تفرض هذا التنسيق. +يتم تشغيلها تلقائيًا مع كل "Pull Request"، +ولكن يمكنك تثبيتها لاختبار مساهماتك محليًا قبل تقديمها: + +```sh +npm install --global tldr-lint +tldr-lint path/to/tldr_page.md +``` + +لطرق أخرى لاستخدام `tldr-lint`، مثل فحص مجلد كامل، يمكنك الاطلاع على +[صفحة `tldr-lint` على `tldr`](https://github.com/tldr-pages/tldr/blob/main/pages/common/tldr-lint.md). بدلاً من ذلك، يمكنك أيضًا استخدام اختصارها `tldrl`. + +اعتمادًا على عميلك، قد تتمكن من معاينة الصفحة محليًا باستخدام خيار `--render`: + +```sh +tldr --render path/to/tldr_page.md +``` + +### القواعد الخاصة بـ PowerShell + +عند توثيق أوامر PowerShell، يرجى ملاحظة قواعد التسمية التالية. + +- يجب أن يكون اسم الملف مكتوبًا بحروف صغيرة، مثل `invoke-webrequest.md` بدلاً من `Invoke-WebRequest.md`. +- يجب أن يكون عنوان/رأس الصفحة مكتوبًا كما هو (بما يتطابق مع التهجئة التي يقصدها مايكروسوفت أو مؤلف الأمر PowerShell)، مثل `Invoke-WebRequest` بدلاً من `invoke-webrequest`. +- يجب أيضًا كتابة اسم الأمر والخيارات في الأمثلة كما هي، مثل `Command-Name {{input}} -CommandParameter {{value}}` بدلاً من `command-name {{input}} -commandparameter {{value}}`. + +نظرًا للاختلافات في التوافق بين الإصدارات [وإزالة الأوامر الخاصة بـ Windows](https://learn.microsoft.com/powershell/scripting/whats-new/differences-from-windows-powershell) في PowerShell 6.x، تأكد من أن +الأمر يعمل بين **PowerShell 5.1** (المعروف أيضًا باسم "PowerShell Windows القديم" كما هو مثبت في Windows 10 و11) و **أحدث إصدار من PowerShell متعدد المنصات** (المعروف سابقًا باسم PowerShell Core). + +لذا، إذا كان الأمر أو خياراته غير متوفرة أو تحتوي على سلوكيات مختلفة بين كل إصدار، يرجى ملاحظة ذلك بلطف في الوصف. على سبيل المثال: + +```md +# Clear-RecycleBin + +> حذف العناصر من سلة المهملات. +> ملاحظة: يمكن استخدام هذا الأمر فقط من خلال إصدارات PowerShell 5.1 وما دون، أو 7.1 وما فوق. +> المزيد من التفاصيل: . +``` + +## الصفحات + +### اختلافات المنصات + +إذا كنت قلقًا من أن الأوامر قد تختلف بين المنصات أو أنظمة التشغيل (مثل Windows مقابل macOS)، +فإن معظم [عملاء صفحات tldr](https://github.com/tldr-pages/tldr/wiki/Clients) سيختارون النسخة الأنسب من الأمر لعرضها للمستخدم النهائي. + +في هذه الحالة، سيتم عرض معلومات النسخة الخاصة بـ Windows من أمر `cd` (المخزنة في `pages.ar/windows/cd.md`) بشكل افتراضي لمستخدمي Windows، +وسيتم عرض النسخة العامة/المشتركة (المخزنة في `pages.ar/common/cd.md`) للمستخدمين على أنظمة Linux وmacOS ومنصات أخرى. + +### الألقاب + +إذا كان يمكن استدعاء أمر ما باستخدام أسماء بديلة (مثلًا، يمكن استدعاء `vim` باستخدام `vi`)، يمكن إنشاء صفحات ألقاب للإشارة إلى اسم الأمر الأصلي للمستخدم. + +```md +# command_name + +> هذا الأمر هو لقب لـ `اسم-الأمر-الأصلي`. + +- عرض التوثيقات للأمر الأصلي: + +`tldr original_command_name` +``` + +مثال: + +```md +# vi + +> هذا الأمر هو لقب لـ `vim`. + +- عرض التوثيقات للأمر الأصلي: + +`tldr vim` +``` + +- يمكن العثور على قوالب صفحات الألقاب المترجمة مسبقًا [هنا](https://github.com/tldr-pages/tldr/blob/main/contributing-guides/translation-templates/alias-pages.md). + +#### الألقاب الخاصة بـ PowerShell + +قد تقدم بعض أوامر PowerShell ألقابًا تقع في واحدة من هذه الفئات الثلاث: + +1. **استبدال أمر موجود في موجه أوامر Windows (`cmd`)**، مثل استبدال `cd` بـ `Set-Location` مع خيارات أوامر مختلفة. في هذه الحالة، أضف ملاحظة اللقب التالية في السطر الثاني من وصف أمر tldr للأمر الأصلي في موجه الأوامر، على سبيل المثال: + +```md +# cd + +> عرض الدليل الحالي أو الانتقال إلى دليل آخر. +> في PowerShell، هذا الأمر هو لقب لـ `Set-Location`. هذه الوثائق تستند إلى النسخة الخاصة بـ Command Prompt (`cmd`) من `cd`. +> مزيد من التفاصيل: . + +- عرض التوثيقات الخاصة بالأمر المقابل في PowerShell: + +`tldr set-location` +``` + +> [!NOTE] +> مثال "عرض التوثيقات للأمر المعادل في PowerShell" اختياري ويجب استبعاده إذا كانت الصفحة تحتوي بالفعل على الحد الأقصى من الأمثلة (8). + +2. **يوفر لقبًا جديدًا يمكن تنفيذه فقط في PowerShell**، مثل `ni` لـ `New-Item`. في هذه الحالة، استخدم [قالب اللقب القياسي](https://github.com/tldr-pages/tldr/blob/main/contributing-guides/translation-templates/alias-pages.md)، ولكن أضف كلمة "في PowerShell" (أو ما يعادلها) للإشارة إلى أن الأمر حصري لـ PowerShell. على سبيل المثال: + +```md +# ni + +> في PowerShell، هذا الأمر هو لقب لـ `New-Item`. +> مزيد من التفاصيل: . + +- عرض التوثيقات للأمر الأصلي: + +`tldr new-item` +``` + +3. **يوفر لقبًا جديدًا يتعارض مع برامج أخرى، وأشهر مثال هو تضمين** curl و wget كألقاب لـ Invoke-WebRequest (مع مجموعة غير متوافقة من خيارات الأوامر). + لاحظ أن الألقاب الخاصة بـ PowerShell التي تقع في هذه الفئة غالبًا ما تكون حصرية لـ Windows. + +في هذه الحالة، قدم ملاحظة وطريقة لتحديد ما إذا كان الأمر يشير حاليًا إلى أمر PowerShell (من خلال اللقب) أو إلى أمر آخر. على سبيل المثال: + +```md +# curl + +> في PowerShell، قد يكون هذا الأمر هو لقب لـ `Invoke-WebRequest` عندما لا يكون البرنامج الأصلي `curl` () مثبتًا بشكل صحيح. +> لمزيد من التفاصيل: . + +- تحقق مما إذا كان `curl` مثبتًا بشكل صحيح عن طريق طباعة رقم الإصدار الخاص به. إذا أظهرت هذه الأوامر خطأ، قد تكون PowerShell قد استبدلت هذا الأمر بـ `Invoke-WebRequest`: + +`curl --version` + +- عرض التوثيقات الخاصة بأمر `curl` الأصلي: + +`tldr curl -p common` + +- عرض التوثيقات الخاصة بأمر `Invoke-WebRequest` في PowerShell: + +`tldr invoke-webrequest` +``` + +## الكتابة العامة + +### التأكيد + +لا تستخدم _الخط المائل_ (Italic) أو **الخط العريض** (Bold) أو أي تنسيق نصي آخر في الصفحات. هذه محجوزة لتأكيد العميل على العناصر القابلة للتغيير. + +### صيغة الأمر + +- **يجب أن تكون جميع الأوصاف مكتوبة بصيغة الأمر.** + +عند كتابة الأوصاف لأمثلة الأوامر، تحقق من أي أخطاء نحوية. يُفضل استخدام "اذهب إلى المجلد المحدد" بدلاً من: + +- `سيذهب هذا الأمر إلى المجلد المحدد` +- `لنذهب إلى المجلد المحدد!` + +### الحالات الخاصة + +- إذا كان الأمر يقوم بإجراء تغييرات لا رجعة فيها على نظام الملفات أو الأجهزة، + فاكتب كل مثال بطريقة لا يمكن نسخها ولصقها بشكل متهور. + على سبيل المثال، بدلاً من `ddrescue --force --no-scrape /dev/sda /dev/sdb` + اكتب `ddrescue --force --no-scrape {{/dev/sdX}} {{/dev/sdY}}` + واستخدم القالب `{{/dev/sdXY}}` لأجهزة الكتل بدلاً من `/dev/sda1`. + +بشكل عام، يجب أن تجعل القوالب من السهل فهم كيفية استخدام الأمر وملء القيم. + +> [!NOTE] +> لا تترجم الplaceholders مثل `{{path/to/file}}` إلى `{{المسار/إلى/الملف}}` لتجنب الإلتباس + +يجب استخدام صياغة تقنية على خطوط الوصف باستخدام تنسيق `backtick`. +استخدم الخطوط المائلة الخلفية `backticks` مع التالي: + +- المسارات، مثل `package.json`، `/etc/package.json`. +- الامتدادات، مثل `.dll`. +- الأوامر، مثل `ls`. +- التدفقات القياسية: `stdout`، `stdin`، `stderr`. + **لا تستخدم** الأسماء الكاملة (مثل: standard output). +- خوارزميات الضغط، مثل `zip`، `7z`، `xz`. + +### الفاصلة التسلسلية + +- عند الإعلان عن قائمة تحتوي على 3 عناصر أو أكثر، + استخدم [الفاصلة التسلسلية](https://en.wikipedia.org/wiki/Serial_comma)، + والمعروفة أيضًا باسم فاصلة أكسفورد، + حيث أن حذفها يمكن أن يؤدي إلى التباس. + +> حذف فروع Git، tags، و remotes. + +المثال أعلاه لا يستخدم فاصلة تسلسلية، لذا قد يعني أحد الأمرين التاليين: + +- حذف فروع Git المسماة `tags` و`remotes`. +- حذف جميع الفروع، tags، وremotes الخاصة بـGit. + +يمكن حل هذا الالتباس بإضافة فاصلة قبل كلمة "و" أو "أو" في العنصر الأخير من القائمة. + +> حذف فروع Git وtags وremotes. + +> [!NOTE] +> يمكن كتابة أسماء العلامات التجارية والمشاريع بحروف كبيرة في الوصف عند الاقتضاء +> (على سبيل المثال، استخدم `أداة للتعامل مع مستودع Git` بدلاً من `أداة للتفاعل مع مستودع git`). + +## أوامر للمثال + +### صيغة الخيارات + +- من أجل سهولة الاستخدام، افضل **خيارات GNU الطويلة** (مثل `--help` بدلاً من `-h`). تأكد من أن الخيارات متوافقة عبر المنصات (مصممة لتعمل بنفس الطريقة عبر منصات متعددة) للصفحات في دليل `common`. +- إذا كان الأمر يدعم فقط الخيارات القصيرة أو كان الخيار القصير يختلف بشكل كبير عن الخيار الطويل، حاول توثيق ما يرمز إليه الحرف باستخدام [مساعد ذاكري](#short-option-mnemonics). +- للسماح للعميل بتحديد ما إذا كان سيظهر الخيارات الطويلة أو القصيرة في الأوامر، استخدم عنصر نائب للخيار مثل `{{[-o|--output]}}`. +- افضل تجميع خيارات العلم معًا عندما يدعم البرنامج ذلك (مثل `{{[-it|--interactive --tty]}}` بدلاً من `{{[-i|--interactive]}} {{[-t|--tty]}}`). +- افضل عدم تجميع الخيارات التي تأخذ وسائط (مثل `{{[-it|--interactive --tty]}} {{[-w|--workdir]}} {{path/to/directory}}` بدلاً من `{{[-itw|--interactive --tty --workdir]}} {{path/to/directory}}`). +- افضل استخدام مسافة بدلاً من علامة التساوي (`=`) لفصل الخيارات عن وسائطها (مثل استخدام `--opt arg` بدلاً من `--opt=arg`)، ما لم يكن البرنامج لا يدعم ذلك. +- كذلك افضل فصل الخيارات القصيرة عن وسائطها بمسافة (مثل استخدام `-o arg` بدلاً من `-oarg`)، ما لم يكن البرنامج لا يدعم ذلك. + +### صيغة العناصر النائبة + +يجب أن تستخدم القيم التي يوفرها المستخدم تركيب `{{عنصر نائب}}` +للسماح لعملاء `tldr` بإبرازها. + +> [!TIP] +> يُقترح وضع العناصر النائبة التي تقبل السلاسل كمدخلات ضمن علامات اقتباس. أي استخدم `"{{عنصر نائب}}"` بدلاً من `{{"عنصر نائب"}}`. + +ضع الإرشادات التالية في الاعتبار عند اختيار العناصر النائبة: + +#### التسمية + +- استخدم عناصر نائبة قصيرة لكن وصفية، + مثل `{{path/to/source_file}}` أو `{{path/to/wallet.txt}}`. +- استخدم [`snake_case`](https://wikipedia.org/wiki/snake_case) للعناصر النائبة متعددة الكلمات. + +#### المسارات + +- استخدم `{{filename}}` عندما يكون متوقعًا اسم الملف فقط. +- لأي إشارة إلى مسارات الملفات أو الدلائل، + استخدم الصيغة `{{path/to/عنصر نائب}}`، + إلا عندما يكون الموقع ضمنيًا. +- عندما لا يمكن أن يكون المسار نسبيًا + ويجب أن يبدأ من جذر نظام الملفات، + ضع شرطة مائلة في البداية، + مثل `get {{/path/to/remote_file}}`. +- في حالة الإشارة المحتملة إلى ملف أو دليل، + استخدم `{{path/to/file_or_directory}}`. + +> [!NOTE]\ +> إذا كان الأمر خاصًا بـ Windows، استخدم الشرطات المائلة للخلف (`\`) بدلاً من ذلك، مثل `{{path\to\file_or_directory}}`. حروف الأقراص مثل `C:` اختيارية ما لم يتطلب إدخال الأمر مسارًا مطلقًا +> أو نطاقًا محددًا لحروف الأقراص، مثل `cd /d {{C}}:{{path\to\directory}}`. + +#### الامتدادات + +- إذا كان متوقعًا امتداد معين للملف، أضفه. + على سبيل المثال، `unrar x {{path/to/compressed.rar}}`. +- في حالة الحاجة إلى امتداد عام، استخدم `{{.ext}}`، ولكن **فقط** إذا كان الامتداد مطلوبًا. + على سبيل المثال، في مثال `find.md` "البحث عن الملفات حسب الامتداد" (`find {{path/to/root}} -name '{{*.ext}}'`) + استخدام `{{*.ext}}` يشرح الأمر دون أن يكون محددًا بشكل غير ضروري؛ + بينما في `wc -l {{path/to/file}}` استخدام `{{path/to/file}}` (بدون امتداد) كافٍ. + +#### تجميع العناصر النائبة + +- إذا كان بإمكان الأمر أن يأخذ اختياريًا واحدًا أو أكثر من الوسائط من نفس النوع، استخدم النقاط الثلاث: `{{عنصر نائب1 عنصر نائب2 ...}}`. + على سبيل المثال، إذا كان متوقعًا مسارات متعددة، استخدم `{{path/to/directory1 path/to/directory2 ...}}`. +- إذا كان خيار واحد فقط من بين خيارات متعددة ممكنًا، اكتبه كـ: `{{عنصر نائب1|عنصر نائب2|عنصر نائب3}}`. إذا كان هناك أكثر من 4 قيم محتملة، يمكنك استخدام `|...` بعد العنصر الأخير. +- استخدم نقطتين لتعليم نطاق من القيم المحتملة، على سبيل المثال `{{1..5}}` أو `{{a..z}}`. + +#### العناصر النائبة الاختيارية + +عند توثيق العناصر النائبة الاختيارية مثل المسارات أو امتدادات الملفات، يُقترح تحديدها في وصف الصفحة أو الأمثلة بدلاً من العنصر النائب نفسه. على سبيل المثال: + +- استخدم `{{path/to/source.ext}}` بدلاً من `{{path/to/source.tar[.gz|.bz2|.xz]}}`. + +### ضغطات المفاتيح + +لتعليم ضغطات المفاتيح لبرامج TUI أو GUI، استخدم الأقواس الزاوية `<` و `>`. + +- مثال على حرف واحد: ``. +- المفاتيح الخاصة يجب كتابتها باستخدام [`PascalCase`](https://www.theserverside.com/definition/Pascal-case): ``, ``, ``, ``, ``, `` بدلاً من تعليمها باستخدام Shift. بخلاف ذلك، قم دائمًا بتعليم الحروف بحروف صغيرة. +- قم بتعليم ضغطات المفاتيح المتزامنة داخل نفس الأقواس الزاوية مفصولة بمسافة واحدة: ``, ``, ``, ``. +- عند كتابة ضغطات المفاتيح المتزامنة، حافظ على الترتيب التالي: ``. +- ضغطات المفاتيح المتتالية يجب أن تُحصر في أقواس زاوية خاصة بها دون مسافة بينهما: ``, ``, `<~><.>`, ``. +- المفاتيح التي يتم كتابتها في موجه لا تحتاج إلى تعليمها كضغطات مفاتيح: `<:>help`. لاحظ أن مفتاح تبديل السياق معلم في أقواس زاوية على الرغم من طباعته في الموجه. + +### أوامر المساعدة والإصدار + +- عادةً ما نضع، **بهذا الترتيب**، أوامر المساعدة والإصدار كـ **آخر مثالين** في الصفحة لإبراز الأوامر العملية أكثر في بداية الصفحة. يمكن استبدالها لاستيعاب أمثلة مفيدة أخرى إذا لزم الأمر. +- للحفاظ على التناسق، نفضل الصياغة العامة `عرض المساعدة` و `عرض الإصدار` لهذه الأوامر. +- يُقترح توثيق أمثلة المساعدة والإصدار إذا كان الأمر يتبع علامات غير تقليدية في منصات مثل Windows. + +## قواعد اللغة والترجمة + +القسم أدناه يحتوي على قواعد إضافية خاصة باللغة والترجمة: + +### عام + +لا تترجم `example.com`. النطاق محجوز من قبل IANA لأغراض التوثيق ولن يتم تأجيره لأي شخص. ترجمة اسم الموقع قد تعرض المستخدمين غير المتأنين للخطر. + +### قواعد خاصة باللغة الإنجليزية + +يجب استخدام الواصلة العادية (`-`) في الأماكن التي قد توصي فيها أدلة الأسلوب المختلفة باستخدام الشرطة المتوسطة (`–`) أو الشرطة الطويلة (`—`). + +- على سبيل المثال، استخدم `for lengths 3-12` بدلاً من `for lengths 3–12` + +السبب في ذلك رباعي: + +1. لا يوجد معيار مقبول على نطاق واسع بين أدلة الأسلوب المختلفة حول متى يجب استخدام كل من هذه الشرطات. +2. الواصلة (`-`) هي الشخصية الشبيهة بالشرطة الوحيدة في ASCII، مما يقلل من احتمالية مشكلات التوافق. +3. الواصلة (`-`) هي الأسهل في الكتابة بفارق كبير. +4. العديد من المتحدثين بالإنجليزية، وخاصة غير الناطقين بها كلغة أم، لا يدركون الفرق. + +## قواعد اللغة والترجمة + +القسم أدناه يحتوي على قواعد إضافية خاصة باللغة والترجمة: + +### عام + +لا تترجم `example.com`. النطاق محجوز من قبل IANA لأغراض التوثيق ولن يتم تأجيره لأي شخص. ترجمة اسم الموقع قد تعرض المستخدمين غير المتأنين للخطر. diff --git a/pages.ar/linux/rm.md b/pages.ar/common/rm.md similarity index 100% rename from pages.ar/linux/rm.md rename to pages.ar/common/rm.md diff --git a/pages.ar/linux/uname.md b/pages.ar/linux/uname.md deleted file mode 100644 index d01f5f2593..0000000000 --- a/pages.ar/linux/uname.md +++ /dev/null @@ -1,36 +0,0 @@ -# uname - -> يعرض الأمر معلومات عن الجهاز ونظام التشغيل الذي يعمل عليه. -> لمزيد من التفاصيل: . - -- عرض جميع المعلومات: - -`uname --all` - -- عرض اسم الكيرنل الحالي: - -`uname --kernel-name` - -- عرض اسم المضيف: - -`uname --nodename` - -- عرض إصدار الكيرنل الحالي: - -`uname --kernel-release` - -- عرض نسخة الكيرنل الحالية: - -`uname --kernel-version` - -- عرض معمارية النظام الحالي: - -`uname --machine` - -- عرض نوع المعالج الحالي: - -`uname --processor` - -- عرض اسم نظام التشغيل الحالي: - -`uname --operating-system` diff --git a/pages.bs/common/chsh.md b/pages.bs/common/chsh.md deleted file mode 100644 index 4dcc7359df..0000000000 --- a/pages.bs/common/chsh.md +++ /dev/null @@ -1,8 +0,0 @@ -# chsh - -> Promijeni korisnički login shell. -> Više informacija: . - -- Promijeni shell: - -`chsh -s {{putanja/do/shell_binarni}} {{korisničkoime}}` diff --git a/pages.ca/linux/cp.md b/pages.ca/linux/cp.md deleted file mode 100644 index a388d335bd..0000000000 --- a/pages.ca/linux/cp.md +++ /dev/null @@ -1,32 +0,0 @@ -# cp - -> Còpia arxius i directoris. -> Més informació: . - -- Copia un arxiu a un altre directori: - -`cp {{ruta/al/arxiu_origen.ext}} {{ruta/al/archiu_destí.ext}}` - -- Copia un archivo en otro directorio, conservando el nombre del archivo: - -`cp {{ruta/al/arxiu_origen.ext}} {{ruta/al/directori_destinatari}}` - -- Còpia de forma recursiva el contingut d'un directori a una altra ubicació (si el destí existeix, el directori és copiat en aquesta ubicació): - -`cp {{[-r|--recursive]}} {{ruta/al/directori_origen}} {{ruta/al/directori_destinatari}}` - -- Còpia un directori de forma recursiva en mode verbose (mostra els arxius a mesura que es copien): - -`cp {{[-vr|--verbose --recursive]}} {{ruta/al/directori_origen}} {{ruta/al/directori_destinatari}}` - -- Còpia arxius de text en una altra ubicació en mode interactiu (pregunta al usuari abans de sobreescriure): - -`cp {{[-i|--interactive]}} {{*.txt}} {{ruta/al/directori_destinatari}}` - -- Segueix els enllaços simbòlics abans de copiar: - -`cp {{[-L|--dereference]}} {{link}} {{ruta/al/directori_destinatari}}` - -- Utilitza la ruta completa dels arxius d'origen, creant els directoris intermitjos faltants al copiar: - -`cp --parents {{ruta_de_origen/al/archiu}} {{ruta/al/archiu_destí}}` diff --git a/pages.da/common/chsh.md b/pages.da/common/chsh.md deleted file mode 100644 index 1ded643405..0000000000 --- a/pages.da/common/chsh.md +++ /dev/null @@ -1,8 +0,0 @@ -# chsh - -> Skift brugerens login shell. -> Mere information: . - -- Skift shell: - -`chsh -s {{sti/til/shell_program}} {{brugernavn}}` diff --git a/pages.da/common/pushd.md b/pages.da/common/pushd.md index c545258f6d..0c624b3f17 100644 --- a/pages.da/common/pushd.md +++ b/pages.da/common/pushd.md @@ -2,7 +2,7 @@ > Tilføj en mappe til mappe-stakken, så den kan tilgås på et senere tidspunkt. > Se `popd` for at skifte tilbage til den oprindelige mappe og `dirs` for at vise indholdet af mappe-stakken. -> Mere information: . +> Mere information: . - Skift til mappe og tilføj den til mappe-stakken: diff --git a/pages.de/common/brew-bundle.md b/pages.de/common/brew-bundle.md index 51ff3200b4..1baebb0de4 100644 --- a/pages.de/common/brew-bundle.md +++ b/pages.de/common/brew-bundle.md @@ -1,7 +1,7 @@ # brew bundle > Bundler für Homebrew, Homebrew Cask und den Mac App Store. -> Weitere Informationen: . +> Weitere Informationen: . - Installiere Pakete aus einer Brewfile im aktuellen Pfad: diff --git a/pages.de/common/chsh.md b/pages.de/common/chsh.md deleted file mode 100644 index d8787c3113..0000000000 --- a/pages.de/common/chsh.md +++ /dev/null @@ -1,20 +0,0 @@ -# chsh - -> Ändere die Login-Shell eines Benutzers. -> Weitere Informationen: . - -- Ändere die Login-Shell des aktuellen Benutzers interaktiv: - -`chsh` - -- Ändere die Login-Shell des aktuellen Benutzers: - -`chsh -s {{pfad/zu/shell}}` - -- Ändere die Login-Shell eines Benutzers: - -`chsh -s {{pfad/zu/shell}} {{benutzername}}` - -- Liste alle verfügbaren Shells auf: - -`chsh -l` diff --git a/pages.de/linux/cp.md b/pages.de/linux/cp.md deleted file mode 100644 index dc6ecbe0d5..0000000000 --- a/pages.de/linux/cp.md +++ /dev/null @@ -1,32 +0,0 @@ -# cp - -> Kopiere Dateien und Verzeichnisse. -> Weitere Informationen: . - -- Kopiere eine Datei an einen anderen Ort: - -`cp {{pfad/zu/ausgangs_datei.ext}} {{pfad/zu/ziel_datei.ext}}` - -- Kopiere eine Datei in ein anderes Verzeichnis und behalte den Dateinamen bei: - -`cp {{pfad/zu/ausgang_datei.ext}} {{pfad/zu/ziel_verzeichnis}}` - -- Kopiere die Inhalte eines Verzeichnisses rekursiv zu einem neuen Ort (wenn das Ziel existiert, wird das Verzeichnis ins bestehende Ziel Verzeichnis kopiert): - -`cp {{[-r|--recursive]}} {{pfad/zu/ausgangs_verzeichnis}} {{pfad/zu/ziel_verzeichnis}}` - -- Kopiere ein Verzeichnis rekursiv im ausführlichen Modus (zeigt die Dateien die kopiert werden): - -`cp {{[-vr|--verbose --recursive]}} {{pfad/zu/ausgangs_verzeichnis}} {{pfad/zu/ziel_verzeichnis}}` - -- Kopiere text Dateien zu einem anderen Ort im interaktiven Modus (fragt die Nutzer:in bevor eine Datei überschrieben wird): - -`cp {{[-i|--interactive]}} {{*.txt}} {{pfad/zu/ziel_verzeichnis}}` - -- Folge symbolischen Verzeichnislinks vorm Kopieren: - -`cp {{[-L|--dereference]}} {{link}} {{pfad/zu/ziel_verzeichnis}}` - -- Benutze den vollen Pfad der Ausgangsdateien und erstelle alle fehlenden Verzeichnisse beim Kopieren: - -`cp --parents {{quelle/pfad/zu/datei}} {{pfad/zu/ziel_datei}}` diff --git a/pages.es/common/ac.md b/pages.es/common/ac.md index ba4af3b6f8..51482dab91 100644 --- a/pages.es/common/ac.md +++ b/pages.es/common/ac.md @@ -1,7 +1,7 @@ # ac > Imprime estadísticas sobre cuanto tiempo han estado conectados los usuarios. -> Más información: . +> Más información: . - Imprime cuanto tiempo ha estado conectado el usuario actual, en horas: diff --git a/pages.es/common/chsh.md b/pages.es/common/chsh.md deleted file mode 100644 index e1658d6ded..0000000000 --- a/pages.es/common/chsh.md +++ /dev/null @@ -1,17 +0,0 @@ -# chsh - -> Cambia el intérprete de comandos de inicio de sesión del usuario (login shell). -> Vea las páginas específicas de la plataforma para más opciones. -> Más información: . - -- Establece un intérprete de comandos de inicio de sesión específico para el usuario actual de forma interactiva: - -`chsh` - -- Establece un intérprete de comandos de inicio de sesión específico para el usuario actual: - -`chsh -s {{ruta/a/intérprete}}` - -- Establece un intérprete de comandos de inicio de sesión para un usuario específico: - -`chsh -s {{ruta/a/intérprete}} {{usuario}}` diff --git a/pages.es/common/copr.md b/pages.es/common/copr.md new file mode 100644 index 0000000000..aeabb9ee70 --- /dev/null +++ b/pages.es/common/copr.md @@ -0,0 +1,7 @@ +# copr + +> Este comando es un alias de `copr-cli`. + +- Vea la documentación del comando original: + +`tldr copr-cli` diff --git a/pages.es/common/faker.md b/pages.es/common/faker.md new file mode 100644 index 0000000000..8ed7f27fb8 --- /dev/null +++ b/pages.es/common/faker.md @@ -0,0 +1,28 @@ +# faker + +> Una biblioteca Python y una herramienta para generar datos falsos. +> Más información: . + +- Muestra todos los proveedores de datos falsos junto con ejemplos: + +`faker` + +- Genera datos falsos de un tipo específico: + +`faker {{name|address|passport_full|credit_card_full|phone_number|email|company|date_time|user_name|password|job|...}}` + +- Genera un número de direcciones falsas de un país específico (usa `localectl list-locales | cut -d. -f1` para obtener la lista de locales): + +`faker --repeat {{número}} --lang {{de_DE|de_CH|...}} address` + +- Genera un número de ciudades en un país específico y las muestra en un archivo (usa `localectl list-locales | cut -d. -f1` para obtener la lista de locales): + +`faker --repeat {{número}} --lang {{en_AU|en_US|...}} city -o {{ruta/a/archivo.txt}}` + +- Genera una serie de agentes de usuario HTTP aleatorios mostrando una salida detallada: + +`faker --repeat {{número}} --verbose user_agent` + +- Genera un número de nombres de dominio y separa cada uno utilizando un separador específico: + +`faker --repeat {{número}} --sep '{{,}}' domain_name` diff --git a/pages.es/common/gpg2.md b/pages.es/common/gpg2.md new file mode 100644 index 0000000000..740fa268ab --- /dev/null +++ b/pages.es/common/gpg2.md @@ -0,0 +1,7 @@ +# gpg2 + +> Este comando es un alias de `gpg`. + +- Vea la documentación del comando original: + +`tldr gpg` diff --git a/pages.es/common/impacket-getadusers.md b/pages.es/common/impacket-getadusers.md new file mode 100644 index 0000000000..ae67bd175e --- /dev/null +++ b/pages.es/common/impacket-getadusers.md @@ -0,0 +1,7 @@ +# impacket-GetADUsers + +> Este comando es un alias de `GetADUsers.py`. + +- Vea la documentación del comando original: + +`tldr GetADUsers.py` diff --git a/pages.es/common/impacket-getarch.md b/pages.es/common/impacket-getarch.md new file mode 100644 index 0000000000..73a4d1333f --- /dev/null +++ b/pages.es/common/impacket-getarch.md @@ -0,0 +1,7 @@ +# impacket-getArch + +> Este comando es un alias de `getArch.py`. + +- Vea la documentación del comando original: + +`tldr getArch.py` diff --git a/pages.es/common/impacket-getnpusers.md b/pages.es/common/impacket-getnpusers.md new file mode 100644 index 0000000000..a7fe02616b --- /dev/null +++ b/pages.es/common/impacket-getnpusers.md @@ -0,0 +1,7 @@ +# impacket-GetNPUsers + +> Este comando es un alias de `GetNPUsers.py`. + +- Vea la documentación del comando original: + +`tldr GetNPUsers.py` diff --git a/pages.es/common/impacket-getuserspns.md b/pages.es/common/impacket-getuserspns.md new file mode 100644 index 0000000000..90bcd1fa95 --- /dev/null +++ b/pages.es/common/impacket-getuserspns.md @@ -0,0 +1,7 @@ +# impacket-GetUserSPNs + +> Este comando es un alias de `GetNPUsers.py`. + +- Vea la documentación del comando original: + +`tldr GetUserSPNs.py` diff --git a/pages.es/common/impacket-mssqlclient.md b/pages.es/common/impacket-mssqlclient.md new file mode 100644 index 0000000000..8a75d8949f --- /dev/null +++ b/pages.es/common/impacket-mssqlclient.md @@ -0,0 +1,7 @@ +# impacket-mssqlclient + +> Este comando es un alias de `mssqlclient.py`. + +- Vea la documentación del comando original: + +`tldr mssqlclient.py` diff --git a/pages.es/common/impacket-secretsdump.md b/pages.es/common/impacket-secretsdump.md new file mode 100644 index 0000000000..f531fedbee --- /dev/null +++ b/pages.es/common/impacket-secretsdump.md @@ -0,0 +1,7 @@ +# impacket-secretsdump + +> Este comando es un alias de `secretsdump.py`. + +- Vea la documentación del comando original: + +`tldr secretsdump.py` diff --git a/pages.es/common/impacket-sniff.md b/pages.es/common/impacket-sniff.md new file mode 100644 index 0000000000..7f4f4c957d --- /dev/null +++ b/pages.es/common/impacket-sniff.md @@ -0,0 +1,7 @@ +# impacket-sniff + +> Este comando es un alias de `sniff.py`. + +- Vea la documentación del comando original: + +`tldr sniff.py` diff --git a/pages.es/common/impacket-sniffer.md b/pages.es/common/impacket-sniffer.md new file mode 100644 index 0000000000..ce70b15406 --- /dev/null +++ b/pages.es/common/impacket-sniffer.md @@ -0,0 +1,7 @@ +# impacket-sniffer + +> Este comando es un alias de `sniffer.py`. + +- Vea la documentación del comando original: + +`tldr sniffer.py` diff --git a/pages.es/common/jupyterlab.md b/pages.es/common/jupyterlab.md new file mode 100644 index 0000000000..953f7a6e10 --- /dev/null +++ b/pages.es/common/jupyterlab.md @@ -0,0 +1,7 @@ +# jupyterlab + +> Este comando es un alias de `jupyter lab`. + +- Vea la documentación del comando original: + +`tldr jupyter lab` diff --git a/pages.es/common/mapfile.md b/pages.es/common/mapfile.md new file mode 100644 index 0000000000..692474e5f9 --- /dev/null +++ b/pages.es/common/mapfile.md @@ -0,0 +1,7 @@ +# mapfile + +> Este comando es un alias de `readarray`. + +- Vea la documentación del comando original: + +`tldr readarray` diff --git a/pages.es/common/o.md b/pages.es/common/o.md new file mode 100644 index 0000000000..cccee24b3a --- /dev/null +++ b/pages.es/common/o.md @@ -0,0 +1,24 @@ +# o + +> Orbiton, un sencillo editor de texto sin configuración. +> Más información: . + +- Abre un archivo en el editor: + +`o {{ruta/a/archivo}}` + +- Abre un archivo como de solo lectura: + +`o {{[-m|-monitor]}} {{ruta/a/archivo}}` + +- Guarda el archivo: + +`` + +- Sale de Orbiton: + +`` + +- Muestra la ayuda: + +`o {{[-h|--help]}}` diff --git a/pages.es/common/rsactftool.py.md b/pages.es/common/rsactftool.py.md new file mode 100644 index 0000000000..0f862d85ce --- /dev/null +++ b/pages.es/common/rsactftool.py.md @@ -0,0 +1,32 @@ +# RsaCtfTool + +> Herramienta de ataque RSA para desafíos CTF - recupera claves privadas a partir de claves públicas débiles y/o descifra datos. +> Más información: . + +- Recupera una clave privada de un archivo de clave pública: + +`RsaCtfTool.py --publickey {{ruta/a/clave.pub}} --private` + +- Descifra un fichero utilizando una clave pública: + +`RsaCtfTool.py --publickey {{ruta/a/clave.pub}} --decryptfile {{ruta/a/archivo_cifrado}}` + +- Descifra una cadena de texto cifrado específica: + +`RsaCtfTool.py --publickey {{ruta/a/clave.pub}} --decrypt "{{texto_cifrado}}"` + +- Vuelca los componentes de una clave RSA (por ejemplo, módulo, exponente) desde un archivo de claves: + +`RsaCtfTool.py --dumpkey --key {{ruta/a/clave.pub}}` + +- Ejecuta un ataque específico (por ejemplo, factorización de Fermat) para recuperar la clave privada: + +`RsaCtfTool.py --publickey {{ruta/a/clave.pub}} --private --attack fermat` + +- Genera una clave pública a partir del módulo (n) y el exponente (e): + +`RsaCtfTool.py --createpub -n {{módulo}} -e {{exponente}}` + +- Intenta todos los ataques disponibles para recuperar la clave privada: + +`RsaCtfTool.py --publickey {{ruta/a/clave.pub}} --private --attack all` diff --git a/pages.es/common/tofu-plan.md b/pages.es/common/tofu-plan.md new file mode 100644 index 0000000000..f9b278a33c --- /dev/null +++ b/pages.es/common/tofu-plan.md @@ -0,0 +1,32 @@ +# tofu plan + +> Genera y muestra los planes de ejecución de OpenTofu. +> Más información: . + +- Genera y muestra el plan de ejecución en el directorio actual: + +`tofu plan` + +- Muestra un plan para destruir todos los objetos remotos que existen actualmente: + +`tofu plan -destroy` + +- Muestra un plan para actualizar el estado de Tofu y los valores de salida: + +`tofu plan -refresh-only` + +- Especifica valores para las variables de entrada: + +`tofu plan -var '{{nombre1}}={{valor1}}' -var '{{nombre2}}={{valor2}}'` + +- Centra la atención de Tofu solo en un subconjunto de recursos: + +`tofu plan -target {{tipo_recurso.nombre_recurso[índice instancia]}}` + +- Obtiene un plan en formato JSON: + +`tofu plan -json` + +- Escribe un plan en un archivo específico: + +`tofu plan -no-color > {{ruta/al/archivo}}` diff --git a/pages.es/linux/abrt.md b/pages.es/linux/abrt.md new file mode 100644 index 0000000000..70e236685a --- /dev/null +++ b/pages.es/linux/abrt.md @@ -0,0 +1,7 @@ +# abrt + +> Este comando es un alias de `abrt-cli`. + +- Vea la documentación del comando original: + +`tldr abrt-cli` diff --git a/pages.es/linux/apachectl.md b/pages.es/linux/apachectl.md new file mode 100644 index 0000000000..68d20a99ca --- /dev/null +++ b/pages.es/linux/apachectl.md @@ -0,0 +1,36 @@ +# apachectl + +> Controla un servidor HTTP Apache. +> Más información: . + +- Inicia el servidor: + +`sudo apachectl start` + +- Reinicia el servidor: + +`sudo apachectl restart` + +- Detiene el servidor: + +`sudo apachectl stop` + +- Comprueba la validez del archivo de configuración: + +`apachectl configtest` + +- Comprueba el estado del servidor (requiere el navegador lynx): + +`apachectl status` + +- Recarga la configuración sin perder conexiones: + +`sudo apachectl graceful` + +- Imprime la configuración completa de Apache: + +`apachectl -S` + +- Muestra la ayuda: + +`apachectl -h` diff --git a/pages.es/linux/avahi-resolve-address.md b/pages.es/linux/avahi-resolve-address.md new file mode 100644 index 0000000000..9e506a865e --- /dev/null +++ b/pages.es/linux/avahi-resolve-address.md @@ -0,0 +1,7 @@ +# avahi-resolve-address + +> Este comando es un alias de `avahi-resolve --address`. + +- Vea la documentación del comando original: + +`tldr avahi-resolve` diff --git a/pages.es/linux/avahi-resolve-host-name.md b/pages.es/linux/avahi-resolve-host-name.md new file mode 100644 index 0000000000..6bf555ac41 --- /dev/null +++ b/pages.es/linux/avahi-resolve-host-name.md @@ -0,0 +1,7 @@ +# avahi-resolve-host-name + +> Este comando es un alias de `avahi-resolve --name`. + +- Vea la documentación del comando original: + +`tldr avahi-resolve` diff --git a/pages.es/linux/cp.md b/pages.es/linux/cp.md deleted file mode 100644 index 181a35928d..0000000000 --- a/pages.es/linux/cp.md +++ /dev/null @@ -1,36 +0,0 @@ -# cp - -> Copia archivos y directorios. -> Más información: . - -- Copia un archivo a otro directorio: - -`cp {{ruta/al/archivo_origen.ext}} {{ruta/al/archivo_destino.ext}}` - -- Copia un archivo en otro directorio, conservando el nombre del archivo: - -`cp {{path/to/archivo_origen.ext}} {{ruta/al/directorio_principal}}` - -- Copia de forma recursiva el contenido de un directorio a otra ubicación (si el destino existe, el directorio es copiado en esa ubicación): - -`cp {{[-r|--recursive]}} {{ruta/al/directorio_origen}} {{ruta/al/directorio_destino}}` - -- Copia un directorio de forma recursiva en modo verbose (muestra los archivos a medida que se copian): - -`cp {{[-vr|--verbose --recursive]}} {{ruta/al/directorio_origen}} {{ruta/al/directorio_destino}}` - -- Copia varios archivos de inmediato a un directorio: - -`cp {{[-t|--target-directory]}} {{ruta/al/directorio_destino}} {{ruta/al/archivo1 ruta/al/archivo2 ...}}` - -- Copia todos los archivos con una extensión específica a otra ubicación en modo interactivo (pregunta al usuario antes de sobreescribir): - -`cp {{[-i|--interactive]}} {{*.ext}} {{ruta/al/directorio_destino}}` - -- Sigue los enlaces simbólicos antes de copiar: - -`cp {{[-L|--dereference]}} {{link}} {{ruta/al/directorio_destino}}` - -- Usa la ruta completa de los archivos de origen, creando los directorios intermedios faltantes al copiar: - -`cp --parents {{ruta_de_origen/al/archivo}} {{ruta/al/archivo_destino}}` diff --git a/pages.es/linux/i386.md b/pages.es/linux/i386.md new file mode 100644 index 0000000000..2b42370a8e --- /dev/null +++ b/pages.es/linux/i386.md @@ -0,0 +1,7 @@ +# i386 + +> Este comando es un alias de `setarch i386`. + +- Vea la documentación del comando original: + +`tldr setarch` diff --git a/pages.es/linux/killall.md b/pages.es/linux/killall.md deleted file mode 100644 index ce805c4933..0000000000 --- a/pages.es/linux/killall.md +++ /dev/null @@ -1,25 +0,0 @@ -# killall - -> Envía señal de finalización a todas las instancias de un proceso por nombre (debe ser el nombre exacto). -> Todas las señales excepto SIGKILL y SIGSTOP pueden ser interceptadas por el proceso, permitiendo una salida limpia. -> Más información: . - -- Termina un proceso utilizando la señal SIGTERM (terminar), predeterminada: - -`killall {{nombre_del_proceso}}` - -- Lista los nombres de señal disponibles (para ser utilizados sin el prefijo 'SIG'): - -`killall --list` - -- Interactivamente pide confirmación antes de la terminación: - -`killall -i {{nombre_del_proceso}}` - -- Termina un proceso utilizando la señal SIGINT (interrupción), que es la misma señal enviada pulsando ``: - -`killall -INT {{nombre_del_proceso}}` - -- Finaliza -a la fuerza- un proceso: - -`killall -KILL {{nombre_del_proceso}}` diff --git a/pages.es/linux/lex.md b/pages.es/linux/lex.md new file mode 100644 index 0000000000..1d8beb2d40 --- /dev/null +++ b/pages.es/linux/lex.md @@ -0,0 +1,7 @@ +# lex + +> Este comando es un alias de `flex`. + +- Vea la documentación del comando original: + +`tldr flex` diff --git a/pages.es/linux/linux32.md b/pages.es/linux/linux32.md new file mode 100644 index 0000000000..60db4ce22f --- /dev/null +++ b/pages.es/linux/linux32.md @@ -0,0 +1,7 @@ +# linux32 + +> Este comando es un alias de `setarch linux32`. + +- Vea la documentación del comando original: + +`tldr setarch` diff --git a/pages.es/linux/linux64.md b/pages.es/linux/linux64.md new file mode 100644 index 0000000000..69448bca81 --- /dev/null +++ b/pages.es/linux/linux64.md @@ -0,0 +1,7 @@ +# linux64 + +> Este comando es un alias de `setarch linux64`. + +- Vea la documentación del comando original: + +`tldr setarch` diff --git a/pages.es/linux/man.md b/pages.es/linux/man.md deleted file mode 100644 index 77cb188417..0000000000 --- a/pages.es/linux/man.md +++ /dev/null @@ -1,36 +0,0 @@ -# man - -> Da formato y muestra páginas del manual. -> Más información: . - -- Muestra la página del manual de un comando: - -`man {{comando}}` - -- Abre la página del manual de un comando en un navegador (requiere que la variable `BROWSER` esté establecida): - -`man {{[-Hbrowser_name|--html=browser_name]}} {{command}}` - -- Muestra la página del manual de la sección 7 de un comando: - -`man {{7}} {{comando}}` - -- Lista todas las secciones disponibles para un comando: - -`man {{[-f|--whatis]}} {{comando}}` - -- Muestra las rutas usadas en la búsqueda de las páginas: - -`man {{[-w|--path]}}` - -- Muestra la ubicación de la página del manual en lugar de la propia página: - -`man {{[-w|--where]}} {{comando}}` - -- Muestra la página del manual usando un idioma (locale) específico (p.e. es para español): - -`man {{[-L|--locale]}} {{idioma}} {{comando}}` - -- Busca las páginas del manual que contienen la cadena de búsqueda: - -`man {{[-k|--apropos]}} "{{cadena_de_búsqueda}}"` diff --git a/pages.es/linux/mkfs.vfat.md b/pages.es/linux/mkfs.vfat.md new file mode 100644 index 0000000000..4489757919 --- /dev/null +++ b/pages.es/linux/mkfs.vfat.md @@ -0,0 +1,7 @@ +# mkfs.vfat + +> Este comando es un alias de `mkfs.fat`. + +- Vea la documentación del comando original: + +`tldr mkfs.fat` diff --git a/pages.es/linux/pacman-d.md b/pages.es/linux/pacman-d.md new file mode 100644 index 0000000000..183c2b55f9 --- /dev/null +++ b/pages.es/linux/pacman-d.md @@ -0,0 +1,7 @@ +# pacman -D + +> Este comando es un alias de `pacman --database`. + +- Vea la documentación del comando original: + +`tldr pacman database` diff --git a/pages.es/linux/pacman-t.md b/pages.es/linux/pacman-t.md new file mode 100644 index 0000000000..c410163283 --- /dev/null +++ b/pages.es/linux/pacman-t.md @@ -0,0 +1,7 @@ +# pacman -T + +> Este comando es un alias de `pacman --deptest`. + +- Vea la documentación del comando original: + +`tldr pacman deptest` diff --git a/pages.es/linux/pacman-u.md b/pages.es/linux/pacman-u.md new file mode 100644 index 0000000000..459e530fff --- /dev/null +++ b/pages.es/linux/pacman-u.md @@ -0,0 +1,7 @@ +# pacman -U + +> Este comando es un alias de `pacman --upgrade`. + +- Vea la documentación del comando original: + +`tldr pacman upgrade` diff --git a/pages.es/linux/pw-play.md b/pages.es/linux/pw-play.md new file mode 100644 index 0000000000..76accafa8c --- /dev/null +++ b/pages.es/linux/pw-play.md @@ -0,0 +1,7 @@ +# pw-play + +> Este comando es un alias de `pw-cat --playback`. + +- Vea la documentación del comando original: + +`tldr pw-cat` diff --git a/pages.es/linux/pw-record.md b/pages.es/linux/pw-record.md new file mode 100644 index 0000000000..28f9359d36 --- /dev/null +++ b/pages.es/linux/pw-record.md @@ -0,0 +1,7 @@ +# pw-record + +> Este comando es un alias de `pw-cat --record`. + +- Vea la documentación del comando original: + +`tldr pw-cat` diff --git a/pages.es/linux/resize.md b/pages.es/linux/resize.md new file mode 100644 index 0000000000..75af358df6 --- /dev/null +++ b/pages.es/linux/resize.md @@ -0,0 +1,12 @@ +# resize + +> Redimensiona el tamaño del terminal al tamaño de la ventana. +> Más información: . + +- Redimensiona el terminal: + +`resize` + +- Imprime el tamaño del terminal: + +`resize -s` diff --git a/pages.es/linux/rmdir.md b/pages.es/linux/rmdir.md deleted file mode 100644 index 6bc4437f5c..0000000000 --- a/pages.es/linux/rmdir.md +++ /dev/null @@ -1,13 +0,0 @@ -# rmdir - -> Elimina directorios sin archivos. -> Vea también: `rm`. -> Más información: . - -- Elimina directorios específicos: - -`rmdir {{ruta/al/directorio1 ruta/al/directorio2 ...}}` - -- Elimina directorios específicos anidados recursivamente: - -`rmdir {{[-p|--parents]}} {{ruta/al/directorio1 ruta/al/directorio2 ...}}` diff --git a/pages.es/linux/tac.md b/pages.es/linux/tac.md deleted file mode 100644 index 8ea8e4bf2b..0000000000 --- a/pages.es/linux/tac.md +++ /dev/null @@ -1,25 +0,0 @@ -# tac - -> Muestra y concatena archivos con las líneas en orden inverso. -> Vea también: `cat`. -> Más información: . - -- Concatena archivos específicos en orden inverso: - -`tac {{ruta/al/archivo1 ruta/al/archivo2 ...}}` - -- Muestra `stdin` en orden inverso: - -`{{cat ruta/al/archivo}} | tac` - -- Usa un separador específico: - -`tac --separator {{,}} {{ruta/al/archivo1 ruta/al/archivo2 ...}}` - -- Usa una expresión regular específica como separador: - -`tac --regex --separator {{[,;]}} {{ruta/al/archivo1 ruta/al/archivo2 ...}}` - -- Usa un separador antes de cada archivo: - -`tac --before {{ruta/al/archivo1 ruta/al/archivo2 ...}}` diff --git a/pages.es/linux/trash-put.md b/pages.es/linux/trash-put.md new file mode 100644 index 0000000000..2c99fdca2a --- /dev/null +++ b/pages.es/linux/trash-put.md @@ -0,0 +1,7 @@ +# trash-put + +> Este comando es un alias de `trash`. + +- Vea la documentación del comando original: + +`tldr trash` diff --git a/pages.es/linux/uname.md b/pages.es/linux/uname.md deleted file mode 100644 index f3bf0b3a9a..0000000000 --- a/pages.es/linux/uname.md +++ /dev/null @@ -1,36 +0,0 @@ -# uname - -> Uname imprime información sobre la máquina y el sistema operativo que se ejecuta. -> Más información: . - -- Imprime toda la información: - -`uname --all` - -- Imprime el nombre del kernel: - -`uname --kernel-name` - -- Imprime el nombre de host de red: - -`uname --nodename` - -- Imprime la liberación (release) del kernel: - -`uname --kernel-release` - -- Imprime la versión del kernel: - -`uname --kernel-version` - -- Imprime el nombre del hardware de la máquina: - -`uname --machine` - -- Imprime el tipo de procesador: - -`uname --processor` - -- Imprime el nombre del sistema operativo: - -`uname --operating-system` diff --git a/pages.es/linux/uname26.md b/pages.es/linux/uname26.md new file mode 100644 index 0000000000..24f4439101 --- /dev/null +++ b/pages.es/linux/uname26.md @@ -0,0 +1,7 @@ +# uname26 + +> Este comando es un alias de `setarch uname26`. + +- Vea la documentación del comando original: + +`tldr setarch` diff --git a/pages.es/linux/w.md b/pages.es/linux/w.md deleted file mode 100644 index 24a9c929f4..0000000000 --- a/pages.es/linux/w.md +++ /dev/null @@ -1,20 +0,0 @@ -# w - -> Muestra quien ha iniciado sesión y sus procesos. -> Más información: . - -- Muestra información sobre todos los usuarios que han iniciado sesión actualmente: - -`w` - -- Muestra información sobre un usuario específico: - -`w {{usuario}}` - -- Muestra información sin incluir la cabecera: - -`w --no-header` - -- Muestra información sin incluir las columnas de inicio de sesión, JCPU y PCPU: - -`w --short` diff --git a/pages.es/linux/zip.md b/pages.es/linux/zip.md deleted file mode 100644 index 2ae8a6e459..0000000000 --- a/pages.es/linux/zip.md +++ /dev/null @@ -1,33 +0,0 @@ -# zip - -> Empaqueta y comprime archivos en un archivo Zip. -> Vea también: `unzip`. -> Más información: . - -- Agrega archivos/directorios a un archivo específico: - -`zip {{[-r|--recurse-paths}} {{ruta/a/comprimido.zip}} {{ruta/al/archivo_o_directorio1 ruta/al/archivo_o_directorio2 ...}}` - -- Elimina archivos/directorios de un archivo específico: - -`zip {{[-d|--delete]}} {{ruta/a/comprimido.zip}} {{ruta/al/archivo_o_directorio1 ruta/al/archivo_o_directorio2 ...}}` - -- Archiva archivos/directorios e[x]cluyendo especificados: - -`zip {{ruta/a/comprimido.zip}} {{ruta/al/archivo_o_directorio1 ruta/al/archivo_o_directorio2 ...}} {{-x|--exclude}} {{ruta/a/archivos_o_directorios_excluidos}}` - -- Archiva archivos/directorios con un nivel de compresión específico (`0` - el más bajo, `9` - el más alto): - -`zip {{[-r|--recurse-paths}} -{{0..9}} {{ruta/a/comprimido.zip}} {{ruta/al/archivo_o_directorio1 ruta/al/archivo_o_directorio2 ...}}` - -- Crea un archivo cifrado con una contraseña específica: - -`zip {{[-r|--recurse-paths}} {{[-e|--encrypt]}} {{ruta/a/comprimido.zip}} {{ruta/al/archivo_o_directorio1 ruta/al/archivo_o_directorio2 ...}}` - -- Archivo de archivos/directorios a un archivo multiparte[s] (por ejemplo, en partes de 3 GB): - -`zip {{[-r|--recurse-paths}} {{[-s|--split-size]}} {{3g}} {{ruta/a/comprimido.zip}} {{ruta/al/archivo_o_directorio1 ruta/al/archivo_o_directorio2 ...}}` - -- Imprime un contenido específico de archivo: - -`zip {{[-sf|--split-size --freshen]}} {{ruta/a/comprimido.zip}}` diff --git a/pages.es/osx/ed.md b/pages.es/osx/ed.md deleted file mode 100644 index a814942d8a..0000000000 --- a/pages.es/osx/ed.md +++ /dev/null @@ -1,25 +0,0 @@ -# ed - -> El editor de texto original de Unix. -> Vea también: `awk`, `sed`. -> Más información: . - -- Inicia una sesión de edición interactiva con un documento vacío: - -`ed` - -- Inicia una sesión de editor interactivo con un documento vacío y un [p]rompt específico: - -`ed -p '> '` - -- Inicia una sesión de editor interactivo con un documento vacío y sin diagnósticos, recuento de bytes y prompt '!': - -`ed -s` - -- Edita un archivo específico (muestra el recuento de bytes del archivo cargado): - -`ed {{ruta/al/archivo}}` - -- Reemplaza una cadena con un reemplazo específico para todas las líneas: - -`,s/{{expresión_regular}}/{{reemplazo}}/g` diff --git a/pages.es/osx/readlink.md b/pages.es/osx/readlink.md deleted file mode 100644 index 498932dd1f..0000000000 --- a/pages.es/osx/readlink.md +++ /dev/null @@ -1,8 +0,0 @@ -# readlink - -> Sigue enlaces simbólicos y obtiene información sobre enlaces simbólicos. -> Más información: . - -- Imprime la ruta absoluta a la que apunta el enlace simbólico: - -`readlink {{ruta/al/archivo_symlink}}` diff --git a/pages.fa/common/whereis.md b/pages.fa/common/whereis.md deleted file mode 100644 index 1e25fc6907..0000000000 --- a/pages.fa/common/whereis.md +++ /dev/null @@ -1,28 +0,0 @@ -# whereis - -> پیداکردن فایل اجرایی، سورس، صفحه راهنما برای یک دستور. -> اطلاعات بیشتر: . - -- پیداکردن فایل اجرایی، سورس و صفحه راهنما برای SSH: - -`whereis {{ssh}}` - -- پیداکردن فایل اجرایی و صفحه راهنما برای ls: - -`whereis -bm {{ls}}` - -- پیداکردن سورس برای gcc و صفحه راهنما برای git: - -`whereis -s {{gcc}} -m {{git}}` - -- پیداکردن فایل اجرایی برای gcc در مسیر `/usr/bin/`: - -`whereis -b -B {{/usr/bin/}} -f {{gcc}}` - -- پیدا کردن فایل های اجرایی غیر عادی(برای آنهایی که بیشتر از یک فایل اجرایی در سیستم دارند): - -`whereis -u *` - -- پیدا کردن صفحات راهنمای غیر عادی(برای آنهایی که بیشتر از یک فایل اجرایی در سیستم دارند): - -`whereis -u -m *` diff --git a/pages.fr/common/brew-bundle.md b/pages.fr/common/brew-bundle.md index fd2de28580..3f7fbd5f55 100644 --- a/pages.fr/common/brew-bundle.md +++ b/pages.fr/common/brew-bundle.md @@ -1,7 +1,7 @@ # brew bundle > Gestionnaire de paquets pour Homebrew, Homebrew Cask et le Mac App Store. -> Plus d'informations : . +> Plus d'informations : . - Installe tous les paquets listés dans le Brewfile situé dans le dossier courant : diff --git a/pages.fr/linux/cp.md b/pages.fr/linux/cp.md deleted file mode 100644 index d2d2a4560a..0000000000 --- a/pages.fr/linux/cp.md +++ /dev/null @@ -1,32 +0,0 @@ -# cp - -> Copier fichiers et répertoires. -> Plus d'informations : . - -- Copier un fichier vers un autre emplacement : - -`cp {{chemin/vers/fichier_original.ext}} {{chemin/vers/fichier_cible.ext}}` - -- Copier un ficher d'un répertoire vers un autre en conservant le nom du fichier : - -`cp {{chemin/vers/fichier_original.ext}} {{chemin/vers/repertoire_cible}}` - -- Copier récursivement le contenu d'un répertoire vers un autre emplacement (si la destination existe, le répertoire est copié dans celle-ci) : - -`cp {{[-r|--recursive]}} {{chemin/vers/repertoire_source}} {{chemin/vers/repertoire_cible}}` - -- Copier récursivement le contenu d'un répertoire vers un autre emplacement en mode verbeux (affichage des noms fichiers à mesure de leur copie) : - -`cp {{[-vr|--verbose --recursive]}} {{chemin/vers/repertoire_source}} {{chemin/vers/repertoire_cible}}` - -- Copier les fichiers textes vers un autre emplacement, en mode interactive (demande une confirmation avant d'écrire par dessus un fichier du même nom) : - -`cp {{[-i|--interactive]}} {{*.txt}} {{chemin/vers/repertoire_cible}}` - -- Suivre le lien symbolique avant de copier (copie le fichier lié, et non le lien) : - -`cp {{[-L|--dereference]}} {{link}} {{chemin/vers/repertoire_cible}}` - -- Utiliser le chemin complet du fichier source, créant tout répertoire manquant lors de la copie : - -`cp --parents {{chemin/vers/fichier_source}} {{chemin/vers/fichier_cible}}` diff --git a/pages.fr/linux/man.md b/pages.fr/linux/man.md deleted file mode 100644 index 565891a265..0000000000 --- a/pages.fr/linux/man.md +++ /dev/null @@ -1,32 +0,0 @@ -# man - -> Interface de consultation des pages du manuel de référence. -> Plus d'informations : . - -- Affiche la page de manuel d'une commande : - -`man {{commande}}` - -- Affiche la page de manuel de la section 7 d'une commande : - -`man {{7}} {{commande}}` - -- Liste toutes les sections dans lesquelles se trouve une commande : - -`man {{[-f|--whatis]}} {{commande}}` - -- Affiche tous les chemins où se trouvent les pages de manuel : - -`man {{[-w|--path]}}` - -- Affiche l'emplacement d'une page de manuel plutôt que la page elle-même : - -`man {{[-w|--where]}} {{commande}}` - -- Affiche la page de manuel dans une langue particulière : - -`man {{[-L|--locale]}} {{fr_FR}} {{commande}}` - -- Cherche toutes les pages de manuel contenant la chaîne de caractères spécifée : - -`man {{[-k|--apropos]}} "{{chaîne_de_caractères}}"` diff --git a/pages.hi/common/chsh.md b/pages.hi/common/chsh.md deleted file mode 100644 index b752ab6040..0000000000 --- a/pages.hi/common/chsh.md +++ /dev/null @@ -1,8 +0,0 @@ -# chsh - -> उपयोगकर्ता का लॉगिन शेल बदलें। -> अधिक जानकारी: । - -- शेल बदलें: - -`chsh -s {{मार्ग/का/शेल_बाइनरी}} {{उपयोगकर्ता_नाम}}` diff --git a/pages.hi/netbsd/chpass.md b/pages.hi/netbsd/chpass.md index ce58027d8b..851aa57424 100644 --- a/pages.hi/netbsd/chpass.md +++ b/pages.hi/netbsd/chpass.md @@ -2,7 +2,7 @@ > उपयोगकर्ता डेटाबेस जानकारी जोड़ें या बदलें, जिसमें लॉगिन शेल और पासवर्ड शामिल हैं। > और देखें: `passwd`। -> अधिक जानकारी: । +> अधिक जानकारी: । - वर्तमान उपयोगकर्ता के लिए इंटरैक्टिव रूप से एक विशिष्ट लॉगिन शेल सेट करें: @@ -14,7 +14,7 @@ - एक विशिष्ट उपयोगकर्ता के लिए एक लॉगिन [s]शेल सेट करें: -`chpass chsh -s {{शेल/का/पथ}} {{उपयोगकर्ता_नाम}}` +`chpass -s {{शेल/का/पथ}} {{उपयोगकर्ता_नाम}}` - `passwd` फ़ाइल प्रारूप में एक उपयोगकर्ता डेटाबेस प्रविष्टि निर्दिष्ट करें: diff --git a/pages.hi/openbsd/chpass.md b/pages.hi/openbsd/chpass.md index bd0705d0ab..8f4ac0b905 100644 --- a/pages.hi/openbsd/chpass.md +++ b/pages.hi/openbsd/chpass.md @@ -2,20 +2,20 @@ > उपयोगकर्ता डेटाबेस जानकारी जोड़ें या बदलें, जिसमें लॉगिन शेल और पासवर्ड शामिल हैं। > देखें: `passwd`। -> अधिक जानकारी: । +> अधिक जानकारी: । - वर्तमान उपयोगकर्ता के लिए इंटरैक्टिव रूप से एक विशिष्ट लॉगिन शेल सेट करें: -`doas chsh` +`doas chpass` - वर्तमान उपयोगकर्ता के लिए एक विशिष्ट लॉगिन [s]hell सेट करें: -`doas chsh -s {{शेल/का/पथ}}` +`doas chpass -s {{शेल/का/पथ}}` - एक विशिष्ट उपयोगकर्ता के लिए लॉगिन [s]hell सेट करें: -`doas chsh -s {{शेल/का/पथ}} {{उपयोगकर्ता_नाम}}` +`doas chpass -s {{शेल/का/पथ}} {{उपयोगकर्ता_नाम}}` - `passwd` फ़ाइल प्रारूप में एक उपयोगकर्ता डेटाबेस प्रविष्टि निर्दिष्ट करें: -`doas chsh -a {{उपयोगकर्ता_नाम:एनक्रिप्टेड_पासवर्ड:uid:gid:...}}` +`doas chpass -a {{उपयोगकर्ता_नाम:एनक्रिप्टेड_पासवर्ड:uid:gid:...}}` diff --git a/pages.id/common/brew-bundle.md b/pages.id/common/brew-bundle.md index a194e44294..e88f3dfd39 100644 --- a/pages.id/common/brew-bundle.md +++ b/pages.id/common/brew-bundle.md @@ -1,7 +1,7 @@ # brew bundle > Pembungkus untuk Homebrew, Homebrew Cask, dan App Store untuk macOS. -> Informasi lebih lanjut: . +> Informasi lebih lanjut: . - Pasang seluruh paket menurut data Brewfile pada direktori saat ini: diff --git a/pages.id/common/chsh.md b/pages.id/common/chsh.md deleted file mode 100644 index 8f459fe88b..0000000000 --- a/pages.id/common/chsh.md +++ /dev/null @@ -1,17 +0,0 @@ -# chsh - -> Ubah program syel bawaan (login shell) yang akan digunakan pengguna sejak masuk (login) ke sistem operasi. -> Lihat halaman bantuan per platform (sistem operasi) untuk melihat opsi khusus. -> Informasi lebih lanjut: . - -- Pilih suatu login shell untuk pengguna saat ini secara interaktif: - -`chsh` - -- Pilih suatu login [s]hell untuk pengguna saat ini secara spesifik: - -`chsh -s {{jalan/menuju/syel}}` - -- Pilih suatu login [s]hell untuk pengguna lain: - -`chsh -s {{jalan/menuju/syel}} {{username}}` diff --git a/pages.id/linux/man.md b/pages.id/linux/man.md deleted file mode 100644 index 08e4f49f29..0000000000 --- a/pages.id/linux/man.md +++ /dev/null @@ -1,32 +0,0 @@ -# man - -> Format dan tampilkan halaman manual. -> Informasi lebih lanjut: . - -- Tampilkan halaman manual untuk sebuah perintah: - -`man {{perintah}}` - -- Tampilkan halaman manual untuk perintah dari bagian 7: - -`man {{7}} {{perintah}}` - -- Tampilkan semua bagian yang tersedia untuk suatu perintah: - -`man -{{[-f|--whatis]}} {{perintah}}` - -- Tampilkan jalur yang dicari untuk halaman manual: - -`man {{[-w|--path]}}` - -- Tampilkan lokasi sebuah halaman manual alih-alih halaman manual itu sendiri: - -`man {{[-w|--where]}} {{perintah}}` - -- Tampilkan halaman manual menggunakan locale tertentu: - -`man {{[-L|--locale]}} {{locale}} {{perintah}}` - -- Cari halaman manual yang berisi string pencarian: - -`man {{[-k|--apropos]}} "{{string_pencarian}}"` diff --git a/pages.it/common/brew-bundle.md b/pages.it/common/brew-bundle.md index 9be70a6bf2..79c63940ef 100644 --- a/pages.it/common/brew-bundle.md +++ b/pages.it/common/brew-bundle.md @@ -1,7 +1,7 @@ # brew bundle > Bundler per Homebrew, Homebrew Cask e per il Mac App Store. -> Maggiori informazioni: . +> Maggiori informazioni: . - Installa un pacchetto da un Brewfile nel percorso corrente: diff --git a/pages.it/common/chsh.md b/pages.it/common/chsh.md deleted file mode 100644 index 7214f81f76..0000000000 --- a/pages.it/common/chsh.md +++ /dev/null @@ -1,8 +0,0 @@ -# chsh - -> Cambia shell di login dell'utente. -> Maggiori informazioni: . - -- Cambia shell: - -`chsh -s {{percorso/dell/eseguibile_della_shell}} {{nome_utente}}` diff --git a/pages.it/linux/cp.md b/pages.it/linux/cp.md deleted file mode 100644 index bd2c275441..0000000000 --- a/pages.it/linux/cp.md +++ /dev/null @@ -1,32 +0,0 @@ -# cp - -> Copia file e directory. -> Maggiori informazioni: . - -- Copia un file in un'altra posizione: - -`cp {{percorso/del/file_da_copiare.est}} {{percorso/del/file_di_destinazione.est}}` - -- Copia un file all'interno di una directory, mantenendone uguale il nome: - -`cp {{percorso/del/file_da_copiare.est}} {{percorso/della/directory}}` - -- Copia ricorsivamente i contenuti di una directory in un'altra posizione (se la destinazione esiste, la directory è copiata al suo interno): - -`cp {{[-r|--recursive]}} {{percorso/della/directory_da_copiare}} {{percorso/di/destinazione}}` - -- Copia una directory ricorsivamente in modalità prolissa (mostra i file mentre vengono copiati): - -`cp {{[-vr|--verbose --recursive]}} {{percorso/della/directory_da_copiare}} {{percorso/di/destinazione}}` - -- Copia i file di testo in un'altra posizione, in modalità interattiva (richiede conferma all'utente prima di sovrascrivere): - -`cp {{[-i|--interactive]}} {{*.txt}} {{percorso/di/destinazione}}` - -- Segue i collegamenti simbolici prima di copiare: - -`cp {{[-L|--dereference]}} {{collegamento}} {{percorso/di/destinazione}}` - -- Utilizza il percorso completo dei file originali, creando ogni directory intermedia mancante mentre durante la copia: - -`cp --parents {{percorso/dei/file/da/copiare}} {{percorso/del/file/destinazione}}` diff --git a/pages.it/linux/uname.md b/pages.it/linux/uname.md deleted file mode 100644 index c40b5b152c..0000000000 --- a/pages.it/linux/uname.md +++ /dev/null @@ -1,36 +0,0 @@ -# uname - -> Uname stampa informazioni a proposito della macchina e del sistema operativo in esecuzione su di essa. -> Maggiori informazioni: . - -- Stampa tutte le informazioni: - -`uname --all` - -- Stampa il nome del kernel corrente: - -`uname --kernel-name` - -- Stampa il nome host corrente del nodo di rete: - -`uname --nodename` - -- Stampa la release del kernel corrente: - -`uname --kernel-release` - -- Stampa la versione del kernel corrente: - -`uname --kernel-version` - -- Stampa il nome corrente della macchina hardware: - -`uname --machine` - -- Stampa il tipo di processore corrente: - -`uname --processor` - -- Stampa il nome del sistema operativo corrente: - -`uname --operating-system` diff --git a/pages.ja/common/chsh.md b/pages.ja/common/chsh.md deleted file mode 100644 index 9db59b5903..0000000000 --- a/pages.ja/common/chsh.md +++ /dev/null @@ -1,20 +0,0 @@ -# chsh - -> ユーザーのログインシェルを変更します。 -> もっと詳しく: 。 - -- カレントユーザーのログインシェルを対話的に変更する: - -`chsh` - -- カレントユーザーのログインシェルを変更する: - -`chsh -s {{シェルへのパス}}` - -- 指定したユーザーのログインシェルを変更する: - -`chsh -s {{シェルへのパス}} {{ユーザー名}}` - -- 使用可能なシェルの一覧を表示する: - -`chsh -l` diff --git a/pages.ko/common/brew-bundle.md b/pages.ko/common/brew-bundle.md index bd8b894b9b..225a3be79b 100644 --- a/pages.ko/common/brew-bundle.md +++ b/pages.ko/common/brew-bundle.md @@ -1,7 +1,7 @@ # brew bundle > Homebrew, Homebrew Cask 및 Mac App Store용 번들러. -> 더 많은 정보: . +> 더 많은 정보: . - 현재 경로의 Brewfile에서 패키지를 설치: diff --git a/pages.ko/common/chsh.md b/pages.ko/common/chsh.md deleted file mode 100644 index a138bc9488..0000000000 --- a/pages.ko/common/chsh.md +++ /dev/null @@ -1,8 +0,0 @@ -# chsh - -> 사용자 로그인 쉘을 변경합니다. -> 더 많은 정보: . - -- 쉘 변경하기: - -`chsh -s {{경로/쉘_바이너리명}} {{사용자이름}}` diff --git a/pages.ko/common/fastfetch.md b/pages.ko/common/fastfetch.md index 59457b9a8b..65dae62f07 100644 --- a/pages.ko/common/fastfetch.md +++ b/pages.ko/common/fastfetch.md @@ -1,27 +1,31 @@ # fastfetch > 운영체제, 소프트웨어 및 하드웨어에 대한 정보 표시. -> 더 많은 정보: . +> 더 많은 정보: . - 시스템 정보 표시: `fastfetch` -- 로고와 이스케이프 시퀀스 없이 시스템 정보를 표기: +- 모든 모듈과 함께 전체 시스템 정보 표시: -`fastfetch --pipe` - -- 특정 구조를 가져오기: - -`fastfetch --structure {{구조}}` +`fastfetch {{[-c|--config]}} all` - 사용자 정의 구성 파일 로드: -`fastfetch --load-config {{경로/대상/구성_파일}}` +`fastfetch {{[-c|--config]}} {{경로/대상/구성_파일}}` + +- 특정 구조를 가져오기: + +`fastfetch {{[-s|--structure]}} {{구조}}` - 특정 로고 사용: -`fastfetch --logo {{로고}}` +`fastfetch {{[-l|--logo]}} {{로고}}` + +- 로고 없이 시스템 정보를 표기: + +`fastfetch {{[-l|--logo]}} none` - 키와 제목에 특정 색상을 사용: diff --git a/pages.ko/common/flex.md b/pages.ko/common/flex.md deleted file mode 100644 index 1ff1592e66..0000000000 --- a/pages.ko/common/flex.md +++ /dev/null @@ -1,26 +0,0 @@ -# flex - -> 어휘 분석기 생성기. POSIX 사양을 확장하여 `lex`. -> 어휘 분석기에 대한 사양이 주어지면 이를 구현하는 C 코드를 생성. -> 참고: OpenBSD에서는 긴 옵션이 작동하지 않음. -> 더 많은 정보: . - -- flex 파일에서 분석기를 생성하여, `lex.yy.c` 파일에 저장: - -`lex {{analyzer.l}}` - -- `stdout`에 분석기 쓰기: - -`lex -{{-stdout|t}} {{analyzer.l}}` - -- 출력 파일을 지정: - -`lex {{analyzer.l}} -o {{analyzer.c}}` - -- 대화형 스캐너 대신 [B]atch 스캐너를 생성: - -`lex -B {{analyzer.l}}` - -- Lex에서 생성된 C 파일을 컴파일: - -`cc {{경로/대상/lex.yy.c}} --output {{executable}}` diff --git a/pages.ko/common/last.md b/pages.ko/common/last.md deleted file mode 100644 index 47e547c13b..0000000000 --- a/pages.ko/common/last.md +++ /dev/null @@ -1,28 +0,0 @@ -# last - -> 마지막으로 로그인한 사용자 보기. -> 더 많은 정보: . - -- `/var/log/wtmp`에서 읽어들인 마지막 로그인, 지속 시간 및 기타 정보 보기: - -`last` - -- 표시할 마지막 로그인 수 지정: - -`last -n {{로그인_수}}` - -- 항목의 전체 날짜와 시간을 출력하고 호스트 이름 열이 잘리지 않도록 마지막에 표시: - -`last -F -a` - -- 특정 사용자의 모든 로그인 보기 및 호스트 이름 대신 IP 주소 표시: - -`last {{사용자명}} -i` - -- 모든 기록된 재부팅 보기 (즉, 가상 사용자 "reboot"의 마지막 로그인): - -`last reboot` - -- 모든 기록된 종료 보기 (즉, 가상 사용자 "shutdown"의 마지막 로그인): - -`last shutdown` diff --git a/pages.ko/common/mysqlbinlog.md b/pages.ko/common/mysqlbinlog.md index c0c3bf52aa..8adbe4ebbf 100644 --- a/pages.ko/common/mysqlbinlog.md +++ b/pages.ko/common/mysqlbinlog.md @@ -1,7 +1,7 @@ # mysqlbinlog > MySQL 바이너리 로그 파일을 처리하는 도구. -> 더 많은 정보: . +> 더 많은 정보: . - 특정 바이너리 로그 파일에서 이벤트 표시: diff --git a/pages.ko/common/mysqlcheck.md b/pages.ko/common/mysqlcheck.md index 51d066f185..9b50306d90 100644 --- a/pages.ko/common/mysqlcheck.md +++ b/pages.ko/common/mysqlcheck.md @@ -1,7 +1,7 @@ # mysqlcheck > MySQL 테이블 검사 및 복구. -> 더 많은 정보: . +> 더 많은 정보: . - 테이블 검사: diff --git a/pages.ko/common/mysqlsh.md b/pages.ko/common/mysqlsh.md index 0d49e718b6..41e5a51c95 100644 --- a/pages.ko/common/mysqlsh.md +++ b/pages.ko/common/mysqlsh.md @@ -2,7 +2,7 @@ > SQL, JavaScript, Python을 지원하는 MySQL의 고급 명령줄 클라이언트. > InnoDB 클러스터 및 문서 저장소 컬렉션 관리를 위한 기능 제공. -> 더 많은 정보: . +> 더 많은 정보: . - 대화형 모드로 MySQL Shell 시작: diff --git a/pages.ko/common/pushd.md b/pages.ko/common/pushd.md index 5f3cbc2673..b2e6431dce 100644 --- a/pages.ko/common/pushd.md +++ b/pages.ko/common/pushd.md @@ -2,7 +2,7 @@ > 디렉터리를 스택에 쌓아 나중에 접근할 수 있도록 합니다. > 원래 디렉터리로 돌아가려면 `popd`, 디렉터리 스택 내용을 보려면 `dirs`를 같이 보세요. -> 더 많은 정보: . +> 더 많은 정보: . - 디렉터리로 이동하고 스택에 추가: diff --git a/pages.ko/common/script.md b/pages.ko/common/script.md deleted file mode 100644 index 232747918a..0000000000 --- a/pages.ko/common/script.md +++ /dev/null @@ -1,24 +0,0 @@ -# script - -> 터미널 세션의 typescript 파일을 생성. -> 더 많은 정보: . - -- "typescript"라는 이름의 파일로 녹화 시작: - -`script` - -- 녹화 중지: - -`exit` - -- 지정된 파일로 녹화 시작: - -`script {{로그파일.log}}` - -- 기존 파일에 추가: - -`script -a {{로그파일.log}}` - -- 시작 및 완료 메시지 없이 조용히 실행: - -`script -q {{로그파일.log}}` diff --git a/pages.ko/common/whereis.md b/pages.ko/common/whereis.md deleted file mode 100644 index 10005075dc..0000000000 --- a/pages.ko/common/whereis.md +++ /dev/null @@ -1,28 +0,0 @@ -# whereis - -> 명령의 바이너리, 소스 및 매뉴얼 페이지 파일을 찾습니다. -> 더 많은 정보: . - -- SSH에 대한 바이너리, 소스 및 매뉴얼 페이지 찾기: - -`whereis {{ssh}}` - -- ls에 대한 바이너리 및 매뉴얼 페이지 찾기: - -`whereis -bm {{ls}}` - -- gcc의 소스와 Git의 매뉴얼 페이지 찾기: - -`whereis -s {{gcc}} -m {{git}}` - -- `/usr/bin/`에서만 gcc의 바이너리 찾기: - -`whereis -b -B {{/usr/bin/}} -f {{gcc}}` - -- 비정상적인 바이너리 찾기 (시스템에 하나 이상의 바이너리가 있는 경우): - -`whereis -u *` - -- 비정상적인 매뉴얼 항목을 가진 바이너리 찾기 (하나 이상의 매뉴얼이 설치된 경우): - -`whereis -u -m *` diff --git a/pages.ko/common/xargs.md b/pages.ko/common/xargs.md index c5476f2131..3256ed150b 100644 --- a/pages.ko/common/xargs.md +++ b/pages.ko/common/xargs.md @@ -14,11 +14,11 @@ - 여러 스레드를 활용하여 `.log` 확장자를 가진 모든 파일을 gzip으로 압축 (`-print0`는 파일 이름을 null 문자로 분리하고, `-0`은 이를 구분자로 사용): -`find . -name '*.log' -print0 | xargs {{[-0|--null]}} {{[-P|--max-procs]}} {{4}} {{-n|--max-args}} 1 gzip` +`find . -name '*.log' -print0 | xargs {{[-0|--null]}} {{[-P|--max-procs]}} {{4}} {{[-n|--max-args]}} 1 gzip` - 각 인수에 대해 한 번씩 명령 실행: -`{{인수들_소스}} | xargs {{-n|--max-args}} 1 {{명령어}}` +`{{인수들_소스}} | xargs {{[-n|--max-args]}} 1 {{명령어}}` - 각 입력 줄에 대해 한 번씩 명령 실행, 입력 줄로 플레이스홀더(여기서는 `_`로 표시)를 대체: diff --git a/pages.ko/linux/coproc.md b/pages.ko/linux/coproc.md deleted file mode 100644 index ba3417a702..0000000000 --- a/pages.ko/linux/coproc.md +++ /dev/null @@ -1,32 +0,0 @@ -# coproc - -> 상호작용 비동기 하위 셸을 생성하기 위한 Bash 내장 명령어. -> 더 많은 정보: . - -- 하위 셸을 비동기적으로 실행: - -`coproc { {{명령어1; 명령어2; ...}}; }` - -- 특정 이름으로 보조 프로세스 생성: - -`coproc {{이름}} { {{명령어1; 명령어2; ...}}; }` - -- 특정 보조 프로세스의 `stdin`에 쓰기: - -`echo "{{입력}}" >&"${{{이름}}[1]}"` - -- 특정 보조 프로세스의 `stdout`에서 읽기: - -`read {{변수}} <&"${{{이름}}[0]}"` - -- `stdin`을 계속 읽고 입력에 대해 명령어를 실행하는 보조 프로세스 생성: - -`coproc {{이름}} { while read line; do {{명령어1; 명령어2; ...}}; done }` - -- `stdin`을 계속 읽고 입력에 대해 파이프 라인을 실행하고 출력을 `stdout`에 쓰는 보조 프로세스 생성: - -`coproc {{이름}} { while read line; do echo "$line" | {{명령어1 | 명령어2 | ...}} | cat /dev/fd/0; done }` - -- `bc`를 실행하는 보조 프로세스를 생성하고 사용: - -`coproc BC { bc --mathlib; }; echo "1/3" >&"${BC[1]}"; read output <&"${BC[0]}"; echo "$output"` diff --git a/pages.ko/linux/cp.md b/pages.ko/linux/cp.md deleted file mode 100644 index 7d1524407a..0000000000 --- a/pages.ko/linux/cp.md +++ /dev/null @@ -1,36 +0,0 @@ -# cp - -> 파일과 디렉터리를 복사합니다. -> 더 많은 정보: . - -- 파일을 다른 위치로 복사: - -`cp {{경로/대상/원본_파일.ext}} {{경로/대상/대상_파일.ext}}` - -- 파일의 이름을 유지하면서 다른 디렉토리로 복사: - -`cp {{경로/대상/원본_파일.ext}} {{경로/대상/대상_부모_디렉터리}}` - -- 디렉터리의 내용을 재귀적으로 다른 위치로 복사 (대상이 존재하면, 디렉터리 안에 복사됨): - -`cp {{[-r|--recursive]}} {{경로/대상/원본_디렉터리}} {{경로/대상/대상_디렉터리}}` - -- 디렉터리를 재귀적으로 복사하며, 자세히 모드로 파일이 복사되는 동안 표시: - -`cp {{[-vr|--verbose --recursive]}} {{경로/대상/원본_디렉터리}} {{경로/대상/대상_디렉터리}}` - -- 여러 파일을 한 번에 디렉터리로 복사: - -`cp {{[-t|--target-directory]}} {{경로/대상/목적_디렉터리}} {{경로/대상/파일1 경로/대상/파일2 ...}}` - -- 특정 확장자를 가진 모든 파일을 대화형 모드로 다른 위치에 복사 (덮어쓰기 전에 사용자에게 확인 요청): - -`cp {{[-i|--interactive]}} {{*.ext}} {{경로/대상/대상_디렉터리}}` - -- 심볼릭 링크를 복사하기 전에 따라가기: - -`cp {{[-L|--dereference]}} {{링크}} {{경로/대상/대상_디렉터리}}` - -- 소스 파일의 전체 경로를 사용하여, 복사할 때 누락된 중간 디렉터리를 생성: - -`cp --parents {{소스/경로/대상/파일}} {{경로/대상/대상_파일}}` diff --git a/pages.ko/linux/duc.md b/pages.ko/linux/duc.md deleted file mode 100644 index 57b358018a..0000000000 --- a/pages.ko/linux/duc.md +++ /dev/null @@ -1,29 +0,0 @@ -# duc - -> 디스크 사용량을 색인화, 검사 및 시각화하는 도구 모음. -> Duc는 파일 시스템의 폴더 누적 크기를 데이터베이스로 유지하여 이를 쿼리하거나 데이터의 위치를 나타내는 멋진 그래프를 생성할 수 있게 합니다. -> 더 많은 정보: . - -- `/usr` 폴더를 색인하고 기본 데이터베이스 위치 `~/.duc.db`에 기록: - -`duc index {{/usr}}` - -- `/usr/local` 아래의 모든 파일과 폴더를 나열하고 상대적 파일 크기를 [g]그래프로 표시: - -`duc ls --classify --graph {{/usr/local}}` - -- `/usr/local` 아래의 모든 파일과 폴더를 트리뷰로 재귀적으로 나열: - -`duc ls --classify --graph --recursive {{/usr/local}}` - -- 선버스트 그래프를 사용하여 파일 시스템을 탐색하는 그래픽 인터페이스 시작: - -`duc gui {{/usr}}` - -- 파일 시스템을 탐색하기 위한 ncurses 콘솔 인터페이스 실행: - -`duc ui {{/usr}}` - -- 데이터베이스 정보 덤프: - -`duc info` diff --git a/pages.ko/linux/killall.md b/pages.ko/linux/killall.md deleted file mode 100644 index b4cbbccaa8..0000000000 --- a/pages.ko/linux/killall.md +++ /dev/null @@ -1,25 +0,0 @@ -# killall - -> 프로세스 이름으로 모든 인스턴스에 종료 신호를 보냅니다 (정확한 이름이어야 함). -> SIGKILL 및 SIGSTOP을 제외한 모든 신호는 프로세스에서 가로챌 수 있어 깨끗한 종료가 가능합니다. -> 더 많은 정보: . - -- 기본 SIGTERM(종료) 신호를 사용하여 프로세스 종료: - -`killall {{프로세스_이름}}` - -- 사용 가능한 신호 이름 나열('SIG' 접두사 없이 사용): - -`killall --list` - -- 종료 전에 확인을 요청: - -`killall -i {{프로세스_이름}}` - -- SIGINT(인터럽트) 신호를 사용하여 프로세스 종료, 이는 ``를 눌렀을 때 보내지는 신호와 동일: - -`killall -INT {{프로세스_이름}}` - -- 프로세스를 강제로 종료: - -`killall -KILL {{프로세스_이름}}` diff --git a/pages.ko/linux/man.md b/pages.ko/linux/man.md deleted file mode 100644 index 6ab3686a7b..0000000000 --- a/pages.ko/linux/man.md +++ /dev/null @@ -1,36 +0,0 @@ -# man - -> 매뉴얼 페이지를 포맷하고 표시합니다. -> 더 많은 정보: . - -- 명령어에 대한 매뉴얼 페이지 표시: - -`man {{명령어}}` - -- 브라우저에서 명령어에 대한 매뉴얼 페이지 열기 (`BROWSER` 변수가 설정되어 있어야 함): - -`man {{[-Hbrowser_name|--html=browser_name]}} {{명령어}}` - -- 섹션 7에서 명령어에 대한 매뉴얼 페이지 표시: - -`man {{7}} {{명령어}}` - -- 명령어에 대한 사용 가능한 모든 섹션 나열: - -`man {{[-f|--whatis]}} {{명령어}}` - -- 매뉴얼 페이지 검색 경로 표시: - -`man {{[-w|--path]}}` - -- 매뉴얼 페이지 자체가 아닌 매뉴얼 페이지의 위치 표시: - -`man {{[-w|--where]}} {{명령어}}` - -- 특정 로케일을 사용하여 매뉴얼 페이지 표시: - -`man {{[-L|--locale]}} {{로케일}} {{명령어}}` - -- 검색 문자열을 포함하는 매뉴얼 페이지 검색: - -`man {{[-k|--apropos]}} "{{검색_문자열}}"` diff --git a/pages.ko/linux/mkfs.vfat.md b/pages.ko/linux/mkfs.vfat.md deleted file mode 100644 index 5fbab50776..0000000000 --- a/pages.ko/linux/mkfs.vfat.md +++ /dev/null @@ -1,20 +0,0 @@ -# mkfs.vfat - -> 파티션 내에 MS-DOS 파일 시스템 생성. -> 더 많은 정보: . - -- 장치 b의 파티션 1 (`sdb1`) 에 vfat 파일 시스템 생성: - -`mkfs.vfat {{/dev/sdb1}}` - -- 볼륨 이름과 함께 파일 시스템 생성: - -`mkfs.vfat -n {{볼륨_이름}} {{/dev/sdb1}}` - -- 볼륨 ID와 함께 파일 시스템 생성: - -`mkfs.vfat -i {{볼륨_ID}} {{/dev/sdb1}}` - -- 2 대신 5개의 파일 할당 테이블 사용: - -`mkfs.vfat -f 5 {{/dev/sdb1}}` diff --git a/pages.ko/linux/pngcheck.md b/pages.ko/linux/pngcheck.md deleted file mode 100644 index 1e04b7ac91..0000000000 --- a/pages.ko/linux/pngcheck.md +++ /dev/null @@ -1,21 +0,0 @@ -# pngcheck - -> PNG 기반(PNG, JNG, MNG) 이미지 파일의 무결성을 검증하는 포렌식 도구. -> 파일에서 내장된 이미지와 텍스트를 추출할 수도 있습니다. -> 더 많은 정보: . - -- 이미지 파일의 무결성 검증: - -`pngcheck {{경로/대상/파일.png}}` - -- [v]자세히 및 [c]olorized 출력으로 파일 확인: - -`pngcheck -vc {{경로/대상/파일.png}}` - -- [t]ext 청크 내용 표시 및 특정 파일 내의 PNG 검색: - -`pngcheck -ts {{경로/대상/파일.png}}` - -- 특정 파일 내에 내장된 PNG 검색 및 e[x]tract 추출: - -`pngcheck -x {{경로/대상/파일.png}}` diff --git a/pages.ko/linux/rm.md b/pages.ko/linux/rm.md deleted file mode 100644 index 96b9557e74..0000000000 --- a/pages.ko/linux/rm.md +++ /dev/null @@ -1,29 +0,0 @@ -# rm - -> 파일 또는 디렉터리 삭제. -> 같이 보기: `rmdir`. -> 더 많은 정보: . - -- 특정 파일 삭제: - -`rm {{경로/대상/파일1 경로/대상/파일2 ...}}` - -- 존재하지 않는 파일은 무시하고 특정 파일 삭제: - -`rm {{[-f|--force]}} {{경로/대상/파일1 경로/대상/파일2 ...}}` - -- 특정 파일을 삭제하기 전에 대화형 메시지를 표시하여 특정 파일을 삭제: - -`rm {{[-i|--interactive]}} {{경로/대상/파일1 경로/대상/파일2 ...}}` - -- 특정 파일을 삭제하고 삭제한 파일 정보를 출력: - -`rm {{[-v|--verbose]}} {{경로/대상/파일1 경로/대상/파일2 ...}}` - -- 특정 파일 및 디렉터리를 재귀적으로 삭제: - -`rm {{[-r|--recursive]}} {{경로/대상/파일_또는_폴더1 경로/대상/파일_또는_폴더2 ...}}` - -- 빈 디렉토리 제거 (안전한 방법으로 간주됨): - -`rm {{[-d|--dir]}} {{경로/대상/폴더}}` diff --git a/pages.ko/linux/rmdir.md b/pages.ko/linux/rmdir.md deleted file mode 100644 index d0e0935530..0000000000 --- a/pages.ko/linux/rmdir.md +++ /dev/null @@ -1,13 +0,0 @@ -# rmdir - -> 파일이 없는 디렉토리를 제거합니다. -> 같이 보기: `rm`. -> 더 많은 정보: . - -- 특정 디렉토리 제거: - -`rmdir {{경로/대상/폴더1 경로/대상/폴더2 ...}}` - -- 특정 중첩 디렉토리를 재귀적으로 제거: - -`rmdir {{[-p|--parents]}} {{경로/대상/폴더1 경로/대상/폴더2 ...}}` diff --git a/pages.ko/linux/tac.md b/pages.ko/linux/tac.md deleted file mode 100644 index 3a553c4f9b..0000000000 --- a/pages.ko/linux/tac.md +++ /dev/null @@ -1,25 +0,0 @@ -# tac - -> 파일의 내용을 역순으로 표시하고 연결합니다. -> 같이 보기: `cat`. -> 더 많은 정보: . - -- 특정 파일들을 역순으로 연결: - -`tac {{경로/대상/파일1 경로/대상/파일2 ...}}` - -- `stdin`을 역순으로 표시: - -`{{cat 경로/대상/파일}} | tac` - -- 특정 구분자 사용: - -`tac --separator {{,}} {{경로/대상/파일1 경로/대상/파일2 ...}}` - -- 특정 정규식을 구분자로 사용: - -`tac --regex --separator {{[,;]}} {{경로/대상/파일1 경로/대상/파일2 ...}}` - -- 각 파일 앞에 구분자 사용: - -`tac --before {{경로/대상/파일1 경로/대상/파일2 ...}}` diff --git a/pages.ko/linux/uname.md b/pages.ko/linux/uname.md deleted file mode 100644 index ddf8a671ae..0000000000 --- a/pages.ko/linux/uname.md +++ /dev/null @@ -1,36 +0,0 @@ -# uname - -> Uname은 실행 중인 머신 및 운영 체제 정보를 출력합니다. -> 더 많은 정보: . - -- 모든 정보 출력: - -`uname --all` - -- 현재 커널 이름 출력: - -`uname --kernel-name` - -- 현재 네트워크 노드 호스트명 출력: - -`uname --nodename` - -- 현재 커널 릴리스 출력: - -`uname --kernel-release` - -- 현재 커널 버전 출력: - -`uname --kernel-version` - -- 현재 머신 하드웨어 이름 출력: - -`uname --machine` - -- 현재 프로세서 유형 출력: - -`uname --processor` - -- 현재 운영 체제 이름 출력: - -`uname --operating-system` diff --git a/pages.ko/linux/urpme.md b/pages.ko/linux/urpme.md index c4b1aaec50..2883b97bd1 100644 --- a/pages.ko/linux/urpme.md +++ b/pages.ko/linux/urpme.md @@ -2,7 +2,7 @@ > Mageia에서 패키지를 제거합니다. > 같이 보기: `urpmi`, `urpmi.update`, `urpmi.addmedia`, `urpmi.removemedia`, `urpmf`, `urpmq`. -> 더 많은 정보: . +> 더 많은 정보: . - 패키지 제거: diff --git a/pages.ko/linux/urpmf.md b/pages.ko/linux/urpmf.md index f8dce2ae90..89d9202caa 100644 --- a/pages.ko/linux/urpmf.md +++ b/pages.ko/linux/urpmf.md @@ -2,7 +2,7 @@ > 파일을 패키지에서 찾고 Mageia에서 해당 정보를 조회. > 같이 보기: `urpmi`, `urpme`, `urpmi.addmedia`, `urpmi.removemedia`, `urpmi.update`, `urpmq`. -> 더 많은 정보: . +> 더 많은 정보: . - 파일을 포함하는 패키지 검색: diff --git a/pages.ko/linux/urpmi.addmedia.md b/pages.ko/linux/urpmi.addmedia.md index 51d4c38c3b..21c392ba26 100644 --- a/pages.ko/linux/urpmi.addmedia.md +++ b/pages.ko/linux/urpmi.addmedia.md @@ -3,7 +3,7 @@ > Mageia에 미디어 추가. > 참고: Mageia 문서에서는 미디엄과 저장소를 동의어로 사용합니다. > 같이 보기: `urpmi`, `urpmi.update`, `urpme`, `urpmi.removemedia`, `urpmf`, `urpmq`. -> 더 많은 정보: . +> 더 많은 정보: . - 미디엄 추가: diff --git a/pages.ko/linux/urpmi.md b/pages.ko/linux/urpmi.md index 3017ba987f..12d2385077 100644 --- a/pages.ko/linux/urpmi.md +++ b/pages.ko/linux/urpmi.md @@ -2,7 +2,7 @@ > Mageia에서 패키지를 설치합니다. > 같이 보기: `urpm.update`, `urpme`, `urpmi.addmedia`, `urpmi.removemedia`, `urpmf`, `urpmq`. -> 더 많은 정보: . +> 더 많은 정보: . - 저장소 또는 로컬 RPM 파일에서 패키지 설치: diff --git a/pages.ko/linux/urpmi.removemedia.md b/pages.ko/linux/urpmi.removemedia.md index e03b659fd9..ffa23bba21 100644 --- a/pages.ko/linux/urpmi.removemedia.md +++ b/pages.ko/linux/urpmi.removemedia.md @@ -3,7 +3,7 @@ > Mageia에서 미디어 제거. > 참고: Mageia 문서에서는 미디엄과 저장소를 동의어로 사용합니다. > 같이 보기: `urpmi`, `urpme`, `urpmi.addmedia`, `urpmi.update`, `urpmf`, `urpmq`. -> 더 많은 정보: . +> 더 많은 정보: . - 미디엄 제거: diff --git a/pages.ko/linux/urpmi.update.md b/pages.ko/linux/urpmi.update.md index 5e3efd8d65..e7f1596a01 100644 --- a/pages.ko/linux/urpmi.update.md +++ b/pages.ko/linux/urpmi.update.md @@ -3,7 +3,7 @@ > Mageia에서 패키지 저장소의 패키지 목록을 업데이트합니다. > 참고: Mageia 문서에서는 medium과 저장소를 동의어로 사용합니다. > 같이 보기: `urpmi`, `urpme`, `urpmi.addmedia`, `urpmi.removemedia`, `urpmf`, `urpmq`. -> 더 많은 정보: . +> 더 많은 정보: . - 모든 활성 미디어 업데이트: diff --git a/pages.ko/linux/urpmq.md b/pages.ko/linux/urpmq.md index b7c5cb8a40..b0ce5c0388 100644 --- a/pages.ko/linux/urpmq.md +++ b/pages.ko/linux/urpmq.md @@ -2,7 +2,7 @@ > Mageia에서 패키지 및 미디어에 대한 정보를 조회합니다. > 같이 보기: `urpmi`, `urpmi.update`, `urpmi.addmedia`, `urpmi.removemedia`, `urpmf`, `urpme`. -> 더 많은 정보: . +> 더 많은 정보: . - 설치 가능한 패키지에 대한 정보 표시: diff --git a/pages.ko/linux/w.md b/pages.ko/linux/w.md deleted file mode 100644 index 2f2c63e275..0000000000 --- a/pages.ko/linux/w.md +++ /dev/null @@ -1,20 +0,0 @@ -# w - -> 로그인한 사용자와 그들의 프로세스를 표시합니다. -> 더 많은 정보: . - -- 현재 로그인한 모든 사용자에 대한 정보 표시: - -`w` - -- 특정 사용자에 대한 정보 표시: - -`w {{사용자명}}` - -- 헤더를 포함하지 않고 정보 표시: - -`w --no-header` - -- 로그인, JCPU 및 PCPU 열을 포함하지 않고 정보 표시: - -`w --short` diff --git a/pages.ko/linux/zip.md b/pages.ko/linux/zip.md deleted file mode 100644 index ca9be21aac..0000000000 --- a/pages.ko/linux/zip.md +++ /dev/null @@ -1,33 +0,0 @@ -# zip - -> 파일을 Zip 압축 파일로 패키징하고 압축. -> 같이 보기: `unzip`. -> 더 많은 정보: . - -- 특정 아카이브에 파일/디렉터리 추가: - -`zip {{[-r|--recurse-paths}} {{경로/대상/압축.zip}} {{경로/대상/파일_또는_폴더1 경로/대상/파일_또는_폴더2 ...}}` - -- 특정 아카이브에서 파일/디렉터리 제거: - -`zip {{[-d|--delete]}} {{경로/대상/압축.zip}} {{경로/대상/파일_또는_폴더1 경로/대상/파일_또는_폴더2 ...}}` - -- 특정 파일/디렉터리를 제외하고 아카이브: - -`zip {{경로/대상/압축.zip}} {{경로/대상/파일_또는_폴더1 경로/대상/파일_또는_폴더2 ...}} {{-x|--exclude}} {{경로/대상/제외할_파일_또는_폴더}}` - -- 특정 압축 수준(`0` - 가장 낮음, `9` - 가장 높음)으로 파일/디렉터리 아카이브: - -`zip {{[-r|--recurse-paths}} -{{0..9}} {{경로/대상/압축.zip}} {{경로/대상/파일_또는_폴더1 경로/대상/파일_또는_폴더2 ...}}` - -- 특정 비밀번호로 암호화된 아카이브 생성: - -`zip {{[-r|--recurse-paths}} {{[-e|--encrypt]}} {{경로/대상/압축.zip}} {{경로/대상/파일_또는_폴더1 경로/대상/파일_또는_폴더2 ...}}` - -- 여러 부분으로 나눈 Zip 아카이브로 파일/디렉터리 아카이브 (예: 3GB 파트): - -`zip {{[-r|--recurse-paths}} {{[-s|--split-size]}} {{3g}} {{경로/대상/압축.zip}} {{경로/대상/파일_또는_폴더1 경로/대상/파일_또는_폴더2 ...}}` - -- 특정 아카이브 내용 출력: - -`zip {{[-sf|--split-size --freshen]}} {{경로/대상/압축.zip}}` diff --git a/pages.ko/netbsd/chpass.md b/pages.ko/netbsd/chpass.md index a414a7cfd7..8210083b0a 100644 --- a/pages.ko/netbsd/chpass.md +++ b/pages.ko/netbsd/chpass.md @@ -2,7 +2,7 @@ > 사용자 데이터베이스 정보, 로그인 셸 및 비밀번호를 추가하거나 변경합니다. > 같이 보기: `passwd`. -> 더 많은 정보: . +> 더 많은 정보: . - 현재 사용자에게 특정 로그인 셸을 대화식으로 설정: @@ -14,7 +14,7 @@ - 특정 사용자에게 로그인 셸 설정: -`chpass chsh -s {{경로/대상/셸}} {{사용자명}}` +`chpass -s {{경로/대상/셸}} {{사용자명}}` - `passwd` 파일 형식으로 사용자 데이터베이스 항목 지정: diff --git a/pages.ko/openbsd/chpass.md b/pages.ko/openbsd/chpass.md index 959dc5858a..d28aecab00 100644 --- a/pages.ko/openbsd/chpass.md +++ b/pages.ko/openbsd/chpass.md @@ -2,20 +2,20 @@ > 로그인 셸과 비밀번호를 포함한 사용자 데이터베이스 정보를 추가하거나 변경합니다. > 같이 보기: `passwd`. -> 더 많은 정보: . +> 더 많은 정보: . - 현재 사용자에게 특정 로그인 셸을 대화식으로 설정: -`doas chsh` +`doas chpass` - 현재 사용자에게 특정 로그인 셸을 설정: -`doas chsh -s {{경로/대상/셸}}` +`doas chpass -s {{경로/대상/셸}}` - 특정 사용자에게 로그인 셸을 설정: -`doas chsh -s {{경로/대상/셸}} {{사용자명}}` +`doas chpass -s {{경로/대상/셸}} {{사용자명}}` - `passwd` 파일 형식의 사용자 데이터베이스 항목을 지정: -`doas chsh -a {{사용자명:암호화된_비밀번호:uid:gid:...}}` +`doas chpass -a {{사용자명:암호화된_비밀번호:uid:gid:...}}` diff --git a/pages.ko/osx/ed.md b/pages.ko/osx/ed.md deleted file mode 100644 index c4fea15ae0..0000000000 --- a/pages.ko/osx/ed.md +++ /dev/null @@ -1,25 +0,0 @@ -# ed - -> 오리지널 유닉스 텍스트 편집기. -> 같이 보기: `awk`, `sed`. -> 더 많은 정보: . - -- 빈 문서로 대화형 편집기 세션 시작: - -`ed` - -- 빈 문서로 특정 [p]프롬프트와 함께 대화형 편집기 세션 시작: - -`ed -p '> '` - -- 빈 문서로 진단, 바이트 수, '!' 프롬프트 없이 대화형 편집기 세션 시작: - -`ed -s` - -- 특정 [f]파일 편집 (로딩된 파일의 바이트 수를 표시): - -`ed {{경로/대상/파일}}` - -- 모든 줄에서 문자열을 특정 교체문으로 대체: - -`,s/{{정규_표현식}}/{{교체문}}/g` diff --git a/pages.ko/osx/readlink.md b/pages.ko/osx/readlink.md deleted file mode 100644 index 76d6998b6f..0000000000 --- a/pages.ko/osx/readlink.md +++ /dev/null @@ -1,8 +0,0 @@ -# readlink - -> 심볼릭 링크를 따라가고 심볼릭 링크 정보를 가져옵니다. -> 더 많은 정보: . - -- 심볼릭 링크가 가리키는 절대 경로를 출력: - -`readlink {{경로/대상/심볼릭_링크_파일}}` diff --git a/pages.ml/linux/uname.md b/pages.ml/linux/uname.md deleted file mode 100644 index 302d0058cb..0000000000 --- a/pages.ml/linux/uname.md +++ /dev/null @@ -1,36 +0,0 @@ -# uname - -> ഈ യൂട്ടിലിറ്റി നിങ്ങളുടെ മെഷീൻ അഥവാ ഓപ്പറേറ്റിംഗ് സിസ്റ്റം വിവരങ്ങൾ പ്രിന്റ് ചെയ്യിക്കുന്നു. -> കൂടുതൽ വിവരങ്ങൾ: . - -- എല്ലാവിധ വിവരങ്ങളും പ്രിന്റ് ചെയ്യുവാൻ: - -`uname --all` - -- നിലവിലെ കെർണലിന്റെ പേര് പ്രിന്റ് ചെയ്യുവാൻ: - -`uname --kernel-name` - -- നിലവിലെ നെറ്റ്‌വർക്ക് നൊടിന്റെ ഹോസ്റ്റ് നെയിം പ്രിന്റ് ചെയ്യുവാൻ: - -`uname --nodename` - -- നിലവിലെ കെർണൽ റിലീസ് പ്രിന്റ് ചെയ്യുവാൻ: - -`uname --kernel-release` - -- നിലവിലെ കെർണൽ വേർഷൻ പ്രിന്റ് ചെയ്യുവാൻ: - -`uname --kernel-version` - -- നിലവിലെ മെഷീൻ ഹാർഡ്‌വെയറിന്റെ പേര് പ്രിന്റ് ചെയ്യുവാൻ: - -`uname --machine` - -- നിലവിലെ പ്രൊസസ്സറിന്റെ ടൈപ്പ് പ്രിന്റ് ചെയ്യുവാൻ: - -`uname --processor` - -- നിലവിലെ ഓപ്പറേറ്റിംഗ് സിസ്റ്റത്തിന്റെ പേര് പ്രിന്റ് ചെയ്യുവാൻ: - -`uname --operating-system` diff --git a/pages.nl/common/,.md b/pages.nl/common/,.md new file mode 100644 index 0000000000..752f58dfcf --- /dev/null +++ b/pages.nl/common/,.md @@ -0,0 +1,16 @@ +# Comma + +> Voer commando's uit zonder ze te installeren. +> Meer informatie: . + +- Voer een commando uit: + +`, {{commando -met -vlaggen}}` + +- Voeg een commando toe aan een child shell: + +`, {{[-s|--shell]}} {{command}}` + +- Wis de cache: + +`, {{[-e|--empty-cache]}}` diff --git a/pages.nl/common/a2ping.md b/pages.nl/common/a2ping.md index 15921a494a..78552e38d8 100644 --- a/pages.nl/common/a2ping.md +++ b/pages.nl/common/a2ping.md @@ -29,4 +29,4 @@ - Toon de help: -`a2ping -h` +`a2ping {{[-h|--help]}}` diff --git a/pages.nl/common/ack.md b/pages.nl/common/ack.md index 0e01bd1b81..e029554504 100644 --- a/pages.nl/common/ack.md +++ b/pages.nl/common/ack.md @@ -10,27 +10,27 @@ - Zoek naar een niet-hoofdlettergevoelig patroon: -`ack --ignore-case "{{zoekpatroon}}"` +`ack {{[-i|--ignore-case]}} "{{zoekpatroon}}"` - Zoek naar lijnen die overeenkomen met een patroon en druk alleen de overeenkomende tekst af en niet de rest van de lijn: -`ack -o "{{zoekpatroon}}"` +`ack {{[-o|--output='$&']}} "{{zoekpatroon}}"` - Beperk het zoeken tot bestanden van een specifiek type: -`ack --type {{ruby}} "{{zoekpatroon}}"` +`ack {{[-t|--type]}} {{ruby}} "{{zoekpatroon}}"` - Zoek niet in bestanden van een specifiek type: -`ack --type no{{ruby}} "{{zoekpatroon}}"` +`ack {{[-t|--type]}} no{{ruby}} "{{zoekpatroon}}"` - Tel het totaal aantal gevonden matches: -`ack --count --no-filename "{{zoekpatroon}}"` +`ack {{[-c|--count]}} {{[-h|--no-filename]}} "{{zoekpatroon}}"` - Toon alleen voor elk bestand de bestandsnamen en het aantal overeenkomsten: -`ack --count --files-with-matches "{{zoekpatroon}}"` +`ack {{[-c|--count]}} {{[-l|--files-with-matches]}} "{{zoekpatroon}}"` - Maak een lijst van alle waarden die kunnen worden gebruikt met `--type`: diff --git a/pages.nl/common/acme.sh-dns.md b/pages.nl/common/acme.sh-dns.md index 31b354b396..09d0a59952 100644 --- a/pages.nl/common/acme.sh-dns.md +++ b/pages.nl/common/acme.sh-dns.md @@ -5,20 +5,20 @@ - Geef een certificaat uit met behulp van een automatische DNS API-modus: -`acme.sh --issue --dns {{gnd_gd}} --domain {{voorbeeld.com}}` +`acme.sh --issue --dns {{gnd_gd}} --domain {{example.com}}` - Geef een wildcardcertificaat uit (aangegeven met een asterisk) met behulp van een automatische DNS API-modus: -`acme.sh --issue --dns {{dns_namesilo}} --domain {{voorbeeld.com}} --domain {{*.voorbeeld.com}}` +`acme.sh --issue --dns {{dns_namesilo}} --domain {{example.com}} --domain {{*.example.com}}` - Geef een certificaat uit met behulp van een DNS-aliasmodus: -`acme.sh --issue --dns {{dns_cf}} --domain {{voorbeeld.com}} --challenge-alias {{alias-voor-voorbeeld-validatie.com}}` +`acme.sh --issue --dns {{dns_cf}} --domain {{example.com}} --challenge-alias {{alias-voor-voorbeeld-validatie.com}}` - Geef een certificaat uit terwijl u automatische Cloudflare / Google DNS-polling uitschakelt nadat het DNS-record is toegevoegd door een aangepaste wachttijd in seconden op te geven: -`acme.sh --issue --dns {{dns_namecheap}} --domain {{voorbeeld.com}} --dnssleep {{300}}` +`acme.sh --issue --dns {{dns_namecheap}} --domain {{example.com}} --dnssleep {{300}}` - Geef een certificaat uit met behulp van een handmatige DNS-modus: -`acme.sh --issue --dns --domain {{voorbeeld.com}} --yes-I-know-dns-manual-mode-enough-go-ahead-please` +`acme.sh --issue --dns --domain {{example.com}} --yes-I-know-dns-manual-mode-enough-go-ahead-please` diff --git a/pages.nl/common/acme.sh.md b/pages.nl/common/acme.sh.md index 692dd5d972..3fda1eeca1 100644 --- a/pages.nl/common/acme.sh.md +++ b/pages.nl/common/acme.sh.md @@ -6,28 +6,28 @@ - Geef een certificaat uit met behulp van de webroot-modus: -`acme.sh --issue --domain {{voorbeeld.com}} --webroot {{/pad/naar/webroot}}` +`acme.sh --issue {{[-d|--domain]}} {{example.com}} {{[-w|--webroot]}} {{/pad/naar/webroot}}` - Geef een certificaat uit voor meerdere domeinen in de zelfstandige modus met poort 80: -`acme.sh --issue --standalone --domain {{voorbeeld.com}} --domain {{www.voorbeeld.com}}` +`acme.sh --issue --standalone {{[-d|--domain]}} {{example.com}} {{[-d|--domain]}} {{www.example.com}}` - Geef een certificaat uit met behulp van de zelfstandige TLS-modus met behulp van poort 443: -`acme.sh --issue --alpn --domain {{voorbeeld.com}}` +`acme.sh --issue --alpn {{[-d|--domain]}} {{example.com}}` - Geef een certificaat uit met een werkende Nginx-configuratie: -`acme.sh --issue --nginx --domain {{voorbeeld.com}}` +`acme.sh --issue --nginx {{[-d|--domain]}} {{example.com}}` - Geef een certificaat uit met een werkende Apache-configuratie: -`acme.sh --issue --apache --domain {{voorbeeld.com}}` +`acme.sh --issue --apache {{[-d|--domain]}} {{example.com}}` - Geef een wildcardcertificaat (\*) uit met behulp van een automatische DNS API-modus: -`acme.sh --issue --dns {{dns_cf}} --domain {{*.voorbeeld.com}}` +`acme.sh --issue --dns {{dns_cf}} {{[-d|--domain]}} {{*.example.com}}` - Installeer certificaatbestanden op de opgegeven locaties (handig voor automatische certificaatvernieuwing): -`acme.sh --install-cert -d {{voorbeeld.com}} --key-file {{/pad/naar/voorbeeld.com.key}} --fullchain-file {{/pad/naar/voorbeeld.com.cer}} --reloadcmd "{{systemctl force-reload nginx}}"` +`acme.sh {{[-i|--install-cert]}} {{[-d|--domain]}} {{example.com}} --key-file {{/pad/naar/example.key}} --fullchain-file {{/pad/naar/example.cer}} --reloadcmd "{{systemctl force-reload nginx}}"` diff --git a/pages.nl/common/act.md b/pages.nl/common/act.md index 53dba197e5..489b3a6155 100644 --- a/pages.nl/common/act.md +++ b/pages.nl/common/act.md @@ -3,9 +3,9 @@ > Voer GitHub-acties lokaal uit met behulp van Docker. > Meer informatie: . -- Maak een [l]ijst van de beschikbare acties: +- Maak een lijst van de beschikbare acties: -`act -l` +`act {{[-l|--list]}}` - Voer de standaard evenement uit: @@ -15,18 +15,18 @@ `act {{evenement_type}}` -- Voer een specifieke [j]ob uit: +- Voer een specifieke job uit: -`act -j {{job_id}}` +`act {{[-j|--job]}} {{job_id}}` -- Voer de acties [n]iet daadwerkelijk uit (d.w.z. een proefrit): +- Voer de acties [n]iet daadwerkelijk uit (d.w.z. een dry-run): -`act -n` +`act {{[-n|--dryrun]}}` - Toon uitgebreide logboeken: -`act -v` +`act {{[-v|--verbose]}}` -- Voer een specifieke [W]orkflow uit: +- Voer een specifieke workflow uit: -`act push -W {{pad/naar/workflow}}` +`act push {{[-W|--workflows]}} {{pad/naar/workflow}}` diff --git a/pages.nl/common/ag.md b/pages.nl/common/ag.md index 3dab971b3f..d5a58fb339 100644 --- a/pages.nl/common/ag.md +++ b/pages.nl/common/ag.md @@ -5,23 +5,23 @@ - Zoek bestanden die "foo" bevatten en druk de regelovereenkomsten in context af: -`ag {{foo}}` +`ag foo` - Vind bestanden die "foo" bevatten in een specifieke map: -`ag {{foo}} {{pad/naar/map}}` +`ag foo {{pad/naar/map}}` - Vind bestanden die "foo" bevatten, maar vermeld alleen de bestandsnamen: -`ag -l {{foo}}` +`ag {{[-l|--files-with-matches]}} foo` - Vind bestanden die "FOO" niet hoofdlettergevoelig bevatten en druk alleen de overeenkomst af in plaats van de hele regel: -`ag -i -o {{FOO}}` +`ag {{[-i|--ignore-case]}} {{[-o|--only-matching]}} FOO` - Zoek "foo" in bestanden met een naam die overeenkomt met "bar": -`ag {{foo}} -G {{bar}}` +`ag foo {{[-G|--file-search-regex]}} bar` - Vind bestanden waarvan de inhoud overeenkomt met een reguliere expressie: @@ -29,4 +29,4 @@ - Zoek bestanden met een naam die overeenkomt met "foo": -`ag -g {{foo}}` +`ag {{[-g|--filename-pattern]}} foo` diff --git a/pages.nl/common/agate.md b/pages.nl/common/agate.md index e1604cb2ce..4ca7a3b278 100644 --- a/pages.nl/common/agate.md +++ b/pages.nl/common/agate.md @@ -5,7 +5,7 @@ - Voer een persoonlijke sleutel en certificaat uit en genereer deze: -`agate --content {{pad/naar/inhoud/}} --addr {{[::]:1965}} --addr {{0.0.0.0:1965}} --hostname {{voorbeeld.com}} --lang {{nl-NL}}` +`agate --content {{pad/naar/inhoud/}} --addr {{[::]:1965}} --addr {{0.0.0.0:1965}} --hostname {{example.com}} --lang {{nl-NL}}` - Server starten: @@ -13,4 +13,4 @@ - Toon de help: -`agate -h` +`agate {{[-h|--help]}}` diff --git a/pages.nl/common/age-keygen.md b/pages.nl/common/age-keygen.md index 0f7f46bed1..8c28a4c332 100644 --- a/pages.nl/common/age-keygen.md +++ b/pages.nl/common/age-keygen.md @@ -1,13 +1,13 @@ # age-keygen > Genereer `age` sleutelparen. -> Bekijk `age` hoe je bestanden kan versleutelen/decoderen. +> Bekijk ook: `age` om bestanden te versleutelen/decoderen. > Meer informatie: . - Genereer een sleutelpaar, sla de privésleutel op in een niet-versleuteld bestand en druk de openbare sleutel af naar `stdout`: -`age-keygen --output {{pad/naar/bestand}}` +`age-keygen {{[-o|--output]}} {{pad/naar/bestand}}` -- Converteer een identity naar een recipient een print de publieke sleutel naar `stdout`: +- Converteer een identiteit naar een ontvanger en print de publieke sleutel naar `stdout`: `age-keygen -y {{pad/naar/bestand}}` diff --git a/pages.nl/common/ajson.md b/pages.nl/common/ajson.md index 2d41aa26f0..2d9521371d 100644 --- a/pages.nl/common/ajson.md +++ b/pages.nl/common/ajson.md @@ -13,7 +13,7 @@ - Lees JSON van een URL en evalueer een opgegeven JSONPath-expressie: -`ajson '{{avg($..price)}}' '{{https://voorbeeld.com/api/}}'` +`ajson '{{avg($..price)}}' '{{https://example.com/api/}}'` - Lees wat eenvoudige JSON en bereken een waarde: diff --git a/pages.nl/common/alacritty.md b/pages.nl/common/alacritty.md index 4406f44e14..713b157e2c 100644 --- a/pages.nl/common/alacritty.md +++ b/pages.nl/common/alacritty.md @@ -19,9 +19,9 @@ `alacritty --working-directory {{pad/naar/map}}` -- Vo[e]r een commando uit in een nieuw Alacritty-venster: +- Voer een commando uit in een nieuw Alacritty-venster: -`alacritty -e {{commando}}` +`alacritty {{[-e|--command]}} {{commando}}` - Geef een alternatief configuratiebestand op (standaard ingesteld op `$XDG_CONFIG_HOME/alacritty/alacritty.toml`): diff --git a/pages.nl/common/ani-cli.md b/pages.nl/common/ani-cli.md index b7f503dfd1..ae985c4b24 100644 --- a/pages.nl/common/ani-cli.md +++ b/pages.nl/common/ani-cli.md @@ -7,30 +7,30 @@ `ani-cli "{{anime_naam}}"` -- [d]ownload aflevering: +- Download een aflevering: -`ani-cli -d "{{anime_naam}}"` +`ani-cli {{[-d|--download]}} "{{anime_naam}}"` -- [d]ownload een [r]eeks van afleveringen: +- Download een reeks van afleveringen: -`ani-cli -d -r "{{1 6}}" "{{anime_naam}}"` +`ani-cli {{[-d|--download]}} {{[-r|--range]}} "{{1 6}}" "{{anime_naam}}"` -- [d]ownload de gehele serie (een reeks van alle afleveringen): +- Download de gehele serie (een reeks van alle afleveringen): -`ani-cli -d -r "1 -1" "{{anime_naam}}"` +`ani-cli {{[-d|--download]}} {{[-r|--range]}} "1 -1" "{{anime_naam}}"` -- Gebruik [v]LC als de media player: +- Gebruik VLC als de media player: -`ani-cli -v "{{anime_naam}}"` +`ani-cli {{[-v|-vlc]}} "{{anime_naam}}"` -- Bekjk een specifieke afl[e]vering: +- Bekjk een specifieke aflevering: -`ani-cli -e {{afleveringnummer}} "{{anime_naam}}"` +`ani-cli {{[-e|--episode]}} {{afleveringnummer}} "{{anime_naam}}"` -- Bekijk anime verder ([c]) uit je geschiedenis: +- Bekijk anime verder uit je geschiedenis: -`ani-cli -c` +`ani-cli {{[-c|--continue]}}` -- [U]pdate `ani-cli`: +- Update `ani-cli`: -`ani-cli -U` +`ani-cli {{[-U|--update]}}` diff --git a/pages.nl/common/ansible.md b/pages.nl/common/ansible.md index 34ad84658e..986e2989a8 100644 --- a/pages.nl/common/ansible.md +++ b/pages.nl/common/ansible.md @@ -10,24 +10,24 @@ - Ping een groep met hosts, met gebruik van de ping module: -`ansible {{groep}} -m ping` +`ansible {{groep}} {{[-m|--module-name]}} ping` - Toon feiten van een groep met hosts, met gebruik van de installatie module: -`ansible {{groep}} -m setup` +`ansible {{groep}} {{[-m|--module-name]}} setup` - Voer een commando op een groep met hosts uit. met gebruik van de commando module met argumenten: -`ansible {{groep}} -m command -a '{{mijn_commando}}'` +`ansible {{groep}} {{[-m|--module-name]}} command {{[-a|--args]}} '{{mijn_commando}}'` - Voer een commando uit met administratieve rechten: -`ansible {{groep}} --become --ask-become-pass -m command -a '{{mijn_commando}}'` +`ansible {{groep}} {{[-b|--become]}} --ask-become-pass {{[-m|--module-name]}} command {{[-a|--args]}} '{mijn_commando}}'` - Voer een commando uit met een aangepast inventaris bestand: -`ansible {{groep}} -i {{inventaris_bestand}} -m command -a '{{mijn_command}}'` +`ansible {{groep}} {{[-i|--inventory]}} {{inventaris_bestand}} {{[-m|--module-name]}} command {{[-a|--args]}} '{{mijn_commando}}'` - Toon de groepen in een inventaris: -`ansible localhost -m debug -a '{{var=groups.keys()}}'` +`ansible localhost {{[-m|--module-name]}} debug {{[-a|--args]}} '{{var=groups.keys()}}'` diff --git a/pages.nl/common/asciinema.md b/pages.nl/common/asciinema.md index e88f2dd2b7..97a31c4ea3 100644 --- a/pages.nl/common/asciinema.md +++ b/pages.nl/common/asciinema.md @@ -8,11 +8,7 @@ `asciinema auth` -- Maak een nieuwe opname (gebruiker krijgt een vraag om het lokaal op te slaan of te uploaden als de opname klaar is): - -`asciinema rec` - -- Maak een nieuwe opname en sla het op in een lokaal bestand: +- Maak een nieuwe opname en sla het op in een lokaal bestand (sluit het af met `` of typ `exit`): `asciinema rec {{pad/naar/opname.cast}}` diff --git a/pages.nl/common/at.md b/pages.nl/common/at.md index 13ca2055aa..4b966cfd33 100644 --- a/pages.nl/common/at.md +++ b/pages.nl/common/at.md @@ -4,17 +4,13 @@ > Resultaten worden naar de e-mail van de gebruiker gestuurd. > Meer informatie: . -- Start de `atd`-daemon: - -`systemctl start atd` - - Maak commando's interactief en voer ze over 5 minuten uit (druk op `` wanneer klaar): `at now + 5 minutes` - Maak commando's interactief en voer ze uit op een specifiek tijdstip: -`at {{uu:mm}}` +`at {{hh:mm}}` - Voer een commando uit vanuit `stdin` om 10:00 uur vandaag: @@ -23,3 +19,11 @@ - Voer commando's uit vanuit een opgegeven bestand volgende dinsdag: `at -f {{pad/naar/bestand}} 9:30 PM Tue` + +- Toon alle jobs in de wachtrij voor de huidige gebruiker (hetzelfde als `atq`): + +`at -l` + +- Toon een specifieke job: + +`at -c {{job_nummer}}` diff --git a/pages.nl/common/b2sum.md b/pages.nl/common/b2sum.md index 508d15532f..b9dc15d9d6 100644 --- a/pages.nl/common/b2sum.md +++ b/pages.nl/common/b2sum.md @@ -17,16 +17,16 @@ - Lees een bestand van BLAKE2 sums en bestandsnamen en verifieer dat alle bestanden overeenkomende checksums hebben: -`b2sum --check {{pad/naar/bestand.b2}}` +`b2sum {{[-c|--check]}} {{pad/naar/bestand.b2}}` - Toon alleen een melding voor missende bestanden of als verificatie faalt: -`b2sum --check --quiet {{pad/naar/bestand.b2}}` +`b2sum {{[-c|--check]}} --quiet {{pad/naar/bestand.b2}}` - Toon alleen een melding als een verificatie faalt en negeer missende bestanden: -`b2sum --ignore-missing --check --quiet {{pad/naar/bestand.b2}}` +`b2sum --ignore-missing {{[-c|--check]}} --quiet {{pad/naar/bestand.b2}}` - Controleer een bekende BLAKE2 checksum van een bestand: -`echo {{bekende_blake2_checksum_van_het_bestand}} {{pad/naar/bestand}} | b2sum --check` +`echo {{bekende_blake2_checksum_van_het_bestand}} {{pad/naar/bestand}} | b2sum {{[-c|--check]}}` diff --git a/pages.nl/common/basenc.md b/pages.nl/common/basenc.md index 60729350ae..751538256d 100644 --- a/pages.nl/common/basenc.md +++ b/pages.nl/common/basenc.md @@ -9,11 +9,11 @@ - Decodeer een bestand met base64 encoding: -`basenc --decode --base64 {{pad/naar/bestand}}` +`basenc {{[-d|--decode]}} --base64 {{pad/naar/bestand}}` - Encodeer `stdin` met base32 encoding met 42 kolommen: -`{{command}} | basenc --base32 -w42` +`{{command}} | basenc --base32 {{[-w|--wrap]}} 42` - Encodeer `stdin` met base32 encoding: diff --git a/pages.nl/common/batch.md b/pages.nl/common/batch.md index 0f126752d8..f9de4c762e 100644 --- a/pages.nl/common/batch.md +++ b/pages.nl/common/batch.md @@ -5,10 +5,6 @@ > Bekijk ook: `at`, `atq`, `atrm` `mail`. > Meer informatie: . -- Start de `atd` daemon: - -`systemctl start atd` - - Voer commando's uit vanaf `stdin` (druk op `` om te stoppen): `batch` diff --git a/pages.nl/common/bc.md b/pages.nl/common/bc.md index a134da1944..e09b9b8019 100644 --- a/pages.nl/common/bc.md +++ b/pages.nl/common/bc.md @@ -8,9 +8,9 @@ `bc` -- Start een [i]nteractieve sessie met de standaard wiskundige [b]ibliotheek ingeschakeld: +- Start een interactieve sessie met de standaard wiskundige bibliotheek ingeschakeld: -`bc --interactive --mathlib` +`bc {{[-i|--interactive]}} {{[-l|--mathlib]}}` - Bereken een uitdrukking: @@ -26,7 +26,7 @@ - Bereken een sinus/cosinus/arctangens/natuurlijke logaritme/exponentiële functie met behulp van `mathlib`: -`echo '{{s|c|a|l|e}}({{1}})' | bc --mathlib` +`echo '{{s|c|a|l|e}}({{1}})' | bc {{[-l|--mathlib]}}` - Voer een inline faculteitsscript uit: diff --git a/pages.nl/common/bmptopnm.md b/pages.nl/common/bmptopnm.md index abf98cdc95..30ec90a63d 100644 --- a/pages.nl/common/bmptopnm.md +++ b/pages.nl/common/bmptopnm.md @@ -9,8 +9,8 @@ - Rapporteer de inhoud van een BMP header naar `stderr`: -`bmptopnm -verbose {{pad/naar/bestand.bmp}}` +`bmptopnm {{[-verb|-verbose]}} {{pad/naar/bestand.bmp}}` - Toon de versie: -`bmptopnm -version` +`bmptopnm {{[-v|-version]}}` diff --git a/pages.nl/common/copr-cli.md b/pages.nl/common/copr-cli.md new file mode 100644 index 0000000000..eed60572a3 --- /dev/null +++ b/pages.nl/common/copr-cli.md @@ -0,0 +1,20 @@ +# copr-cli + +> Interface met Fedora-projecten copr instantie voor het bouwen van RPM's en het publiceren ervan. +> Meer informatie: . + +- Toon de gebruiker ingelogd in copr: + +`copr-cli whoami` + +- Bouw een lokaal spec-bestand op copr: + +`copr-cli build {{repository}} {{pad/naar/spec_bestand}}` + +- Controleer de status van de builds: + +`copr-cli list-builds {{repository}}` + +- Trigger een copr build van een spec-bestand vanuit een publieke (Git) repository:repository: + +`copr-cli buildscm {{repository}} --clone-url {{https://git.example.org/repo}} --spec {{spec_bestandsnaam}}` diff --git a/pages.nl/common/ftp.md b/pages.nl/common/ftp.md index 5939beb50b..b8dca783ec 100644 --- a/pages.nl/common/ftp.md +++ b/pages.nl/common/ftp.md @@ -5,7 +5,7 @@ - Verbinden met een FTP-server: -`ftp {{ftp.voorbeeld.com}}` +`ftp {{ftp.example.com}}` - Verbinden met een FTP-server met opgave van IP-adres en poort: diff --git a/pages.nl/common/getadusers.py.md b/pages.nl/common/getadusers.py.md new file mode 100644 index 0000000000..52927de4dc --- /dev/null +++ b/pages.nl/common/getadusers.py.md @@ -0,0 +1,21 @@ +# GetADUsers.py + +> Haal een lijst met gebruikers op van Active Directory, inclusief attributen zoals laatste logon timestamp en email. +> Onderdeel van de Impacket suite. +> Meer informatie: . + +- Ga over alle Active Directory gebruikers en de attributen: + +`GetADUsers.py -all -dc-ip {{domain_controller_ip}} {{domein}}/{{gebruikersnaam}}:{{wachtwoord}}` + +- Verkrijg informatie voor een specifieke gebruiker: + +`GetADUsers.py -user {{gebruiker}} -dc-ip {{domain_controller_ip}} {{domein}}/{{gebruikersnaam}}:{{wachtwoord}}` + +- Extraheer gebruiksdetials door gebruik te maken van pass-the-hash authentication: + +`GetADUsers.py -all -dc-ip {{domain_controller_ip}} -hashes {{LM_Hash}}:{{NT_Hash}} {{domein}}/{{gebruikersnaam}}` + +- Sla de output op in een bestand: + +`GetADUsers.py -all -dc-ip {{domain_controller_ip}} {{domein}}/{{gebruikersnaam}}:{{wachtwoord}} > {{pad/naar/output.txt}}` diff --git a/pages.nl/common/getarch.py.md b/pages.nl/common/getarch.py.md new file mode 100644 index 0000000000..5736ba194f --- /dev/null +++ b/pages.nl/common/getarch.py.md @@ -0,0 +1,21 @@ +# getArch.py + +> Bepaal de OS architectuur (x86 og x64) van een remote Windows systeem. +> Onderdeel van de Impacket suite. +> Meer informatie: . + +- Controleer de architectuur van een enkel doel-systeem: + +`getArch.py -target {{doel}}` + +- Controleer de architectuur van meerdere doelen van een bestand (één per regel): + +`getArch.py -targets {{pad/naar/doelen_file}}` + +- Stel een custom socket timeout in (standaard is 2 seconden): + +`getArch.py -target {{target}} -timeout {{seconden}}` + +- Schakel debug-modus in voor gedetailleerde uitvoer: + +`getArch.py -target {{target}} -debug` diff --git a/pages.nl/common/getnpusers.py.md b/pages.nl/common/getnpusers.py.md new file mode 100644 index 0000000000..68e1ef66ca --- /dev/null +++ b/pages.nl/common/getnpusers.py.md @@ -0,0 +1,25 @@ +# GetNPUsers.py + +> Ga over alle Active Directory accounts met Kerberos pre-authentication uitgeschakeld, die vatbaar kunnen zijn voor AS-REP roasing aanvallen. +> Onderdeel van de Impacket suite. +> Meer informatie: . + +- Ga over alle gebruikers met Kerberos pre-authentication uitgeschakeld (standaard anonieme enumeration): + +`GetNPUsers.py {{domein}}/ -usersfile {{pad/naar/gebruikerslijst}} -dc-ip {{domain_controller_ip}}` + +- Voer AS-REP roasting uit en dump kraakbare hashes voor offline kraking: + +`GetNPUsers.py {{domein}}/ -usersfile {{pad/naar/gebruikerslijst}} -dc-ip {{domain_controller_ip}} -request` + +- Authenticeer met valide credentials (als anonieme binding is uitgeschakeld): + +`GetNPUsers.py {{domein}}/{{username}}:{{password}} -usersfile {{pad/naar/gebruikerslijst}} -dc-ip {{domain_controller_ip}}` + +- Gebruik pass-the-hash authenticatie in plaats van een wachtwoord: + +`GetNPUsers.py {{domein}}/{{username}} -hashes {{LM_Hash}}:{{NT_Hash}} -usersfile {{pad/naar/gebruikerslijst}} -dc-ip {{domain_controller_ip}}` + +- Sla de output op in een bestand: + +`GetNPUsers.py {{domein}}/ -usersfile {{pad/naar/gebruikerslijst}} -dc-ip {{domain_controller_ip}} -request > {{pad/naar/output.txt}}` diff --git a/pages.nl/common/hostname.md b/pages.nl/common/hostname.md index fa8e09822c..3e0123ffe2 100644 --- a/pages.nl/common/hostname.md +++ b/pages.nl/common/hostname.md @@ -9,15 +9,11 @@ - Toon het netwerkadres van de hostnaam: -`hostname -i` - -- Toon alle netwerkadressen van de host: - -`hostname -I` +`hostname {{[-i|--ip-addresses]}}` - Toon de FQDN (Fully Qualified Domain Name): -`hostname --fqdn` +`hostname {{[-f|--fqdn]}}` - Stel een nieuwe hostnaam in: diff --git a/pages.nl/common/impacket-getadusers.md b/pages.nl/common/impacket-getadusers.md index 496d9deecc..a1d60662cc 100644 --- a/pages.nl/common/impacket-getadusers.md +++ b/pages.nl/common/impacket-getadusers.md @@ -1,7 +1,6 @@ # impacket-GetADUsers > Dit commando is een alias van `GetADUsers.py`. -> Meer informatie: . - Bekijk de documentatie van het originele commando: diff --git a/pages.nl/common/impacket-getarch.md b/pages.nl/common/impacket-getarch.md index dc3ade60bb..84bdc0766c 100644 --- a/pages.nl/common/impacket-getarch.md +++ b/pages.nl/common/impacket-getarch.md @@ -1,7 +1,6 @@ # impacket-getArch > Dit commando is een alias van `getArch.py`. -> Meer informatie: . - Bekijk de documentatie van het originele commando: diff --git a/pages.nl/common/impacket-getnpusers.md b/pages.nl/common/impacket-getnpusers.md index 9a2be5c3a0..c586d6a030 100644 --- a/pages.nl/common/impacket-getnpusers.md +++ b/pages.nl/common/impacket-getnpusers.md @@ -1,7 +1,6 @@ # impacket-GetNPUsers > Dit commando is een alias van `GetNPUsers.py`. -> Meer informatie: . - Bekijk de documentatie van het originele commando: diff --git a/pages.nl/common/impacket-getuserspns.md b/pages.nl/common/impacket-getuserspns.md index ccbf7eebfd..00baf58b34 100644 --- a/pages.nl/common/impacket-getuserspns.md +++ b/pages.nl/common/impacket-getuserspns.md @@ -1,7 +1,6 @@ # impacket-GetUserSPNs > Dit commando is een alias van `GetUserSPNs.py`. -> Meer informatie: . - Bekijk de documentatie van het originele commando: diff --git a/pages.nl/common/impacket-mssqlclient.md b/pages.nl/common/impacket-mssqlclient.md index ad5f867065..1791379239 100644 --- a/pages.nl/common/impacket-mssqlclient.md +++ b/pages.nl/common/impacket-mssqlclient.md @@ -1,7 +1,6 @@ # impacket-mssqlclient > Dit commando is een alias van `mssqlclient.py`. -> Meer informatie: . - Bekijk de documentatie van het originele commando: diff --git a/pages.nl/common/impacket-ping.md b/pages.nl/common/impacket-ping.md new file mode 100644 index 0000000000..f458dfe9fb --- /dev/null +++ b/pages.nl/common/impacket-ping.md @@ -0,0 +1,7 @@ +# impacket-ping + +> Dit commando is een alias van `ping.py`. + +- Bekijk de documentatie van het originele commando: + +`tldr ping.py` diff --git a/pages.nl/common/impacket-ping6.md b/pages.nl/common/impacket-ping6.md new file mode 100644 index 0000000000..f7ac7908ff --- /dev/null +++ b/pages.nl/common/impacket-ping6.md @@ -0,0 +1,7 @@ +# impacket-ping6 + +> Dit commando is een alias van `ping6.py`. + +- Bekijk de documentatie van het originele commando: + +`tldr ping6.py` diff --git a/pages.nl/common/impacket-rpcdump.md b/pages.nl/common/impacket-rpcdump.md new file mode 100644 index 0000000000..862f2080ef --- /dev/null +++ b/pages.nl/common/impacket-rpcdump.md @@ -0,0 +1,7 @@ +# impacket-rpcdump + +> Dit commando is een alias van `rpcdump.py`. + +- Bekijk de documentatie van het originele commando: + +`tldr rpcdump.py` diff --git a/pages.nl/common/impacket-rpcmap.md b/pages.nl/common/impacket-rpcmap.md new file mode 100644 index 0000000000..eeabcbfa4d --- /dev/null +++ b/pages.nl/common/impacket-rpcmap.md @@ -0,0 +1,7 @@ +# impacket-rpcmap + +> Dit commando is een alias van `rpcmap.py`. + +- Bekijk de documentatie van het originele commando: + +`tldr rpcmap.py` diff --git a/pages.nl/common/impacket-secretsdump.md b/pages.nl/common/impacket-secretsdump.md index 5586de4bd6..a2730f257f 100644 --- a/pages.nl/common/impacket-secretsdump.md +++ b/pages.nl/common/impacket-secretsdump.md @@ -1,7 +1,6 @@ # impacket-secretsdump > Dit commando is een alias van `secretsdump.py`. -> Meer informatie: . - Bekijk de documentatie van het originele commando: diff --git a/pages.nl/common/impacket-sniff.md b/pages.nl/common/impacket-sniff.md index 334e18f085..3fea1ef7cb 100644 --- a/pages.nl/common/impacket-sniff.md +++ b/pages.nl/common/impacket-sniff.md @@ -1,7 +1,6 @@ # impacket-sniff > Dit commando is een alias van `sniff.py`. -> Meer informatie: . - Bekijk de documentatie van het originele commando: diff --git a/pages.nl/common/impacket-sniffer.md b/pages.nl/common/impacket-sniffer.md index 8f5e3fdafd..957f86b75c 100644 --- a/pages.nl/common/impacket-sniffer.md +++ b/pages.nl/common/impacket-sniffer.md @@ -1,7 +1,6 @@ # impacket-sniffer > Dit commando is een alias van `sniffer.py`. -> Meer informatie: . - Bekijk de documentatie van het originele commando: diff --git a/pages.nl/common/magick-mogrify.md b/pages.nl/common/magick-mogrify.md index 078184d9e9..a910e1873b 100644 --- a/pages.nl/common/magick-mogrify.md +++ b/pages.nl/common/magick-mogrify.md @@ -28,3 +28,7 @@ - Verklein de bestandsgrootte van alle GIF-afbeeldingen in de huidige map door de kwaliteit te verlagen: `magick mogrify -layers 'optimize' -fuzz {{7%}} {{*.gif}}` + +- Toon de help: + +`magick mogrify -help` diff --git a/pages.nl/common/nano.md b/pages.nl/common/nano.md index 9a139f1e55..3dfebdf1dc 100644 --- a/pages.nl/common/nano.md +++ b/pages.nl/common/nano.md @@ -30,3 +30,7 @@ - Open een bestand en maak een reservekopie (`pad/naar/bestand~`) bij het opslaan: `nano {{[-B|--backup]}} {{pad/naar/bestand}}` + +- Sluit nano: + +`` diff --git a/pages.nl/common/npm-home.md b/pages.nl/common/npm-home.md index 51339b480f..4f4f4579f4 100644 --- a/pages.nl/common/npm-home.md +++ b/pages.nl/common/npm-home.md @@ -1,16 +1,16 @@ -# npm home +# npm-home -> Open de npm-pagina, Yarn-pagina of GitHub-repository van een pakket in de webbrowser. +> Open de `npm`-pagina, Yarn-pagina of GitHub-repository van een pakket in de webbrowser. > Meer informatie: . -- Open de npm-pagina van een specifiek pakket in de webbrowser: +- Open de `npm`-pagina van een specifiek pakket in de webbrowser: `npm-home {{pakket}}` - Open de GitHub-repository van een specifiek pakket in de webbrowser: -`npm-home -g {{pakket}}` +`npm-home {{[-g|--github]}} {{pakket}}` - Open de Yarn-pagina van een specifiek pakket in de webbrowser: -`npm-home -y {{pakket}}` +`npm-home {{[-y|--yarn]}} {{pakket}}` diff --git a/pages.nl/common/pushd.md b/pages.nl/common/pushd.md index d5c23f100a..b956669493 100644 --- a/pages.nl/common/pushd.md +++ b/pages.nl/common/pushd.md @@ -2,7 +2,7 @@ > Plaats een map op een stack zodat deze later kan worden benaderd. > Bekijk ook `popd` om terug te schakelen naar de originele map en `dirs` om de inhoud van de mapstapel weer te geven. -> Meer informatie: . +> Meer informatie: . - Schakel naar een map en zet deze op de stapel: diff --git a/pages.nl/common/pwd.md b/pages.nl/common/pwd.md index 5d9573d650..01b73213f9 100644 --- a/pages.nl/common/pwd.md +++ b/pages.nl/common/pwd.md @@ -10,3 +10,7 @@ - Print de huidige directory en los alle symlinks op (d.w.z. toon het "fysieke" pad): `pwd {{[-P|--physical]}}` + +- Toon de help: + +`pwd --help` diff --git a/pages.nl/common/readarray.md b/pages.nl/common/readarray.md index 3c10321e98..12141ee598 100644 --- a/pages.nl/common/readarray.md +++ b/pages.nl/common/readarray.md @@ -18,3 +18,7 @@ - Kopieer maximaal het opgegeven aantal regels: `readarray -n {{N}} {{array_naam}} < {{pad/naar/bestand.txt}}` + +- Toon de help: + +`help mapfile` diff --git a/pages.nl/common/stty.md b/pages.nl/common/stty.md index 09a84dd756..943d0f3a74 100644 --- a/pages.nl/common/stty.md +++ b/pages.nl/common/stty.md @@ -5,7 +5,7 @@ - Toon alle instellingen voor de huidige terminal: -`stty --all` +`stty {{[-a|--all]}}` - Stel het aantal rijen of kolommen in: @@ -13,7 +13,7 @@ - Verkrijg de daadwerkelijke overdrachtssnelheid van een apparaat: -`stty --file {{pad/naar/apparaat_bestand}} speed` +`stty {{[-F|--file]}} {{pad/naar/apparaat_bestand}} speed` - Reset alle modi naar redelijke waarden voor de huidige terminal: @@ -26,3 +26,7 @@ - Zet karakter echoing uit of aan: `stty {{-echo|echo}}` + +- Toon de help: + +`stty --help` diff --git a/pages.nl/common/transmission-cli.md b/pages.nl/common/transmission-cli.md index 6dd9935313..d011a10f9d 100644 --- a/pages.nl/common/transmission-cli.md +++ b/pages.nl/common/transmission-cli.md @@ -2,7 +2,7 @@ > Een lichtgewicht, command-line BitTorrent client. > Deze tool is verouderd, bekijk `transmission-remote`. -> Meer informatie: . +> Meer informatie: . - Download een specifieke torrent: @@ -10,7 +10,7 @@ - Download een torrent naar een specifieke map: -`transmission-cli --download-dir {{pad/naar/download_map}} {{url|magnet|pad/naar/bestand}}` +`transmission-cli {{[-w|--download-dir]}} {{pad/naar/download_map}} {{url|magnet|pad/naar/bestand}}` - Maak een torrent bestand van een specifiek bestand of map: @@ -18,20 +18,20 @@ - Zet de download snelheid limiet naar 50 KB/s: -`transmission-cli --downlimit {{50}} {{url|magnet|pad/naar/bestand}}` +`transmission-cli {{[-d|--downlimit]}} {{50}} {{url|magnet|pad/naar/bestand}}` - Zet de upload snelheid limiet naar 50 KB/s: -`transmission-cli --uplimit {{50}} {{url|magnet|pad/naar/bestand}}` +`transmission-cli {{[-u|--uplimit]}} {{50}} {{url|magnet|pad/naar/bestand}}` - Gebruik een specifieke poort voor verbindingen: -`transmission-cli --port {{poort_nummer}} {{url|magnet|pad/naar/bestand}}` +`transmission-cli {{[-p|--port]}} {{poort_nummer}} {{url|magnet|pad/naar/bestand}}` - Forceer versleuteling voor alle peer-verbindingen: -`transmission-cli --encryption-required {{url|magnet|pad/naar/bestand}}` +`transmission-cli {{[-er|--encryption-required]}} {{url|magnet|pad/naar/bestand}}` - Gebruik een Bluetack-geformatteerde peer blocklist: -`transmission-cli --blocklist {{blocklist_url|pad/naar/blocklist}} {{url|magnet|pad/naar/bestand}}` +`transmission-cli {{[-b|--blocklist]}} {{blocklist_url|pad/naar/blocklist}} {{url|magnet|pad/naar/bestand}}` diff --git a/pages.nl/common/transmission-create.md b/pages.nl/common/transmission-create.md index e5ce309659..31b9881950 100644 --- a/pages.nl/common/transmission-create.md +++ b/pages.nl/common/transmission-create.md @@ -4,22 +4,22 @@ > Bekijk ook: `transmission`. > Meer informatie: . -- Maak een torrent met een stukgrootte van 2048 KB: +- Maak een torrent met een specifieke stukgrootte (in KB): -`transmission-create -o {{pad/naar/voorbeeld.torrent}} --tracker {{aankondigings-url_van_tracker}} --piecesize {{2048}} {{pad/naar/bestand_of_map}}` +`transmission-create {{[-o|--outfile]}} {{pad/naar/voorbeeld.torrent}} {{[-t|--tracker]}} {{aankondigings-url_van_tracker}} {{[-s|--piecesize]}} {{2048}} {{pad/naar/bestand_of_map}}` -- Maak een privé torrent met een stukgrootte van 2048 KB: +- Maak een privé torrent met een specifieke stukgrootte (in KB): -`transmission-create -p -o {{pad/naar/voorbeeld.torrent}} --tracker {{aankondigings-url_van_tracker}} --piecesize {{2048}} {{pad/naar/bestand_of_map}}` +`transmission-create {{[-p|--private]}} {{[-o|--outfile]}} {{pad/naar/voorbeeld.torrent}} {{[-t|--tracker]}} {{aankondigings-url_van_tracker}} {{[-s|--piecesize]}} {{2048}} {{pad/naar/bestand_of_map}}` - Maak een torrent met een opmerking: -`transmission-create -o {{pad/naar/voorbeeld.torrent}} --tracker {{tracker_url1}} -c {{opmerking}} {{pad/naar/bestand_of_map}}` +`transmission-create {{[-o|--outfile]}} {{pad/naar/voorbeeld.torrent}} {{[-t|--tracker]}} {{tracker_url1}} {{[-c|--comment]}} {{opmerking}} {{pad/naar/bestand_of_map}}` - Maak een torrent met meerdere trackers: -`transmission-create -o {{pad/naar/voorbeeld.torrent}} --tracker {{tracker_url1}} --tracker {{tracker_url2}} {{pad/naar/bestand_of_map}}` +`transmission-create {{[-o|--outfile]}} {{pad/naar/voorbeeld.torrent}} {{[-t|--tracker]}} {{tracker_url1}} {{[-t|--tracker]}} {{tracker_url2}} {{pad/naar/bestand_of_map}}` - Toon de help-pagina: -`transmission-create --help` +`transmission-create {{[-h|--help]}}` diff --git a/pages.nl/common/transmission-daemon.md b/pages.nl/common/transmission-daemon.md index f5e3988732..305083a03b 100644 --- a/pages.nl/common/transmission-daemon.md +++ b/pages.nl/common/transmission-daemon.md @@ -10,12 +10,12 @@ - Start en bewaak een specifieke map voor nieuwe torrents: -`transmission-daemon --watch-dir {{pad/naar/map}}` +`transmission-daemon {{[-c|--watch-dir]}} {{pad/naar/map}}` - Dump daemon-instellingen in JSON formaat: -`transmission-daemon --dump-settings > {{pad/naar/bestand.json}}` +`transmission-daemon {{[-d|--dump-settings]}} > {{pad/naar/bestand.json}}` - Start met specifieke instellingen voor de web interface: -`transmission-daemon --auth --username {{gebruikersnaam}} --password {{wachtwoord}} --port {{9091}} --allowed {{127.0.0.1}}` +`transmission-daemon {{[-t|--auth]}} {{[-u|--username]}} {{gebruikersnaam}} {{[-v|--password]}} {{wachtwoord}} {{[-p|--port]}} {{9091}} {{[-a|--allowed]}} {{127.0.0.1}}` diff --git a/pages.nl/common/transmission-edit.md b/pages.nl/common/transmission-edit.md index 62599d22ec..59bffbab4c 100644 --- a/pages.nl/common/transmission-edit.md +++ b/pages.nl/common/transmission-edit.md @@ -4,10 +4,14 @@ > Bekijk ook: `transmission`. > Meer informatie: . -- Voeg een URL toe aan of verwijder deze uit de aankondigingslijst van een torrent: +- Voeg een URL toe aan de aankondigingslijst van een torrent: -`transmission-edit --{{add|delete}} {{http://example.com}} {{pad/naar/bestand.torrent}}` +`transmission-edit {{[-a|--add]}} {{http://example.com}} {{pad/naar/bestand.torrent}}` + +- Verwijder een URL van de aankondigingslijst van een torrent: + +`transmission-edit {{[-d|--delete]}} {{http://example.com}} {{pad/naar/bestand.torrent}}` - Werk de toegangscode van een tracker bij in een torrentbestand: -`transmission-edit --replace {{oude-toegangscode}} {{nieuwe-toegangscode}} {{pad/naar/bestand.torrent}}` +`transmission-edit {{[-r|--replace]}} {{oude-toegangscode}} {{nieuwe-toegangscode}} {{pad/naar/bestand.torrent}}` diff --git a/pages.nl/common/transmission-remote.md b/pages.nl/common/transmission-remote.md index e20624cc32..76883665b9 100644 --- a/pages.nl/common/transmission-remote.md +++ b/pages.nl/common/transmission-remote.md @@ -1,32 +1,32 @@ # transmission-remote > Externe besturingshulpprogramma voor `transmission-daemon` en `transmission`. -> Meer informatie: . +> Meer informatie: . - Voeg een torrentbestand of magnet-link toe aan Transmission en download naar een opgegeven map: -`transmission-remote {{hostname}} -a {{torrent|url}} -w {{/pad/naar/download_map}}` +`transmission-remote {{hostnaam}} {{[-a|--all]}} {{torrent|url}} {{[-w|--download-dir]}} {{/pad/naar/download_map}}` - Verander de standaard downloadmap: -`transmission-remote {{hostname}} -w {{/pad/naar/download_map}}` +`transmission-remote {{hostnaam}} {{[-w|--download-dir]}} {{/pad/naar/download_map}}` - Toon alle torrents: -`transmission-remote {{hostname}} --list` +`transmission-remote {{hostnaam}} {{[-l|--list]}}` - Start torrent 1 en 2, stop torrent 3: -`transmission-remote {{hostname}} -t "{{1,2}}" --start -t {{3}} --stop` +`transmission-remote {{hostnaam}} {{[-t|--torrent]}} "1,2" {{[-s|--start]}} {{[-t|--torrent]}} 3 {{[-S|--stop]}}` - Verwijder torrent 1 en 2 en verwijder ook alle lokale gegevens voor torrent 2: -`transmission-remote {{hostname}} -t {{1}} --remove -t {{2}} --remove-and-delete` +`transmission-remote {{hostnaam}} {{[-t|--torrent]}} 1 {{[-r|--remove]}} {{[-t|--torrent]}} 2 {{[-rad|--remove-and-delete]}}` - Stop alle torrents: -`transmission-remote {{hostname}} -t {{all}} --stop` +`transmission-remote {{hostnaam}} {{[-t|--torrent]}} {{all}} {{[-S|--stop]}}` - Verplaats torrents 1-10 en 15-20 naar een nieuwe map (die wordt aangemaakt als deze nog niet bestaat): -`transmission-remote {{hostname}} -t "{{1-10,15-20}}" --move {{/pad/naar/nieuwe_map}}` +`transmission-remote {{hostnaam}} {{[-t|--torrent]}} "1-10,15-20" --move {{/path/to/new_directory}}` diff --git a/pages.nl/common/transmission-show.md b/pages.nl/common/transmission-show.md index 8be3b73211..dd9d7c6f98 100644 --- a/pages.nl/common/transmission-show.md +++ b/pages.nl/common/transmission-show.md @@ -10,8 +10,8 @@ - Genereer een magnet-link voor een specifieke torrent: -`transmission-show --magnet {{pad/naar/bestand.torrent}}` +`transmission-show {{[-m|--magnet]}} {{pad/naar/bestand.torrent}}` - Vraag de trackers van een torrent op en toon het huidige aantal peers: -`transmission-show --scrape {{pad/naar/bestand.torrent}}` +`transmission-show {{[-s|--scrape]}} {{pad/naar/bestand.torrent}}` diff --git a/pages.nl/common/transmission.md b/pages.nl/common/transmission.md index 57059c8bcb..08a7a910db 100644 --- a/pages.nl/common/transmission.md +++ b/pages.nl/common/transmission.md @@ -4,26 +4,26 @@ > Transmission is geen commando, maar een set commando's. Zie de onderstaande pagina's. > Meer informatie: . -- Toon de tdlr pagina voor het uitvoeren van de daemon van Transmission: +- Toon de documentatie voor het uitvoeren van de daemon van Transmission: `tldr transmission-daemon` -- Toon de tldr pagina voor interactie met de daemon: +- Toon de documentatie voor interactie met de daemon: `tldr transmission-remote` -- Toon de tldr pagina voor het maken van torrent-bestanden: +- Toon de documentatie voor het maken van torrent-bestanden: `tldr transmission-create` -- Toon de tldr pagina voor het wijzigen van torrent-bestanden: +- Toon de documentatie voor het wijzigen van torrent-bestanden: `tldr transmission-edit` -- Toon de tldr pagina voor het verkrijgen van informatie over torrent-bestanden: +- Toon de documentatie voor het verkrijgen van informatie over torrent-bestanden: `tldr transmission-show` -- Toon de tldr pagina voor de verouderde methode voor interactie met de daemon: +- Toon de documentatie voor de verouderde methode voor interactie met de daemon: `tldr transmission-cli` diff --git a/pages.nl/common/vdir.md b/pages.nl/common/vdir.md index f4a97c625a..feaecb6bcb 100644 --- a/pages.nl/common/vdir.md +++ b/pages.nl/common/vdir.md @@ -1,8 +1,8 @@ # vdir -> Toon de inhoud van een map. -> Vervanger voor `ls -l`. -> Meer informatie: . +> Toon uitgebreid de inhoud van een map. +> Vervanger voor `ls -l -b`. +> Meer informatie: . - Toon bestanden en mappen in de huidige map, één per regel, met details: @@ -10,11 +10,11 @@ - Toon met bestandsgroottes in mens-leesbare eenheden (KB, MB, GB): -`vdir -h` +`vdir {{[-h|--human-readable]}}` - Toon inclusief verborgen bestanden (beginnend met een punt): -`vdir -a` +`vdir {{[-a|--all]}}` - Toon bestanden en mappen gesorteerd op grootte (grootste eerst): @@ -30,4 +30,4 @@ - Toon recursief alle bestanden en mappen in een specifieke map: -`vdir --recursive {{pad/naar/map}}` +`vdir {{[-R|--recursive]}} {{pad/naar/map}}` diff --git a/pages.nl/common/xargs.md b/pages.nl/common/xargs.md index 845bd7a87b..eeffa9c07d 100644 --- a/pages.nl/common/xargs.md +++ b/pages.nl/common/xargs.md @@ -14,11 +14,11 @@ - Gzip alle bestanden met een `.log` extensie en profiteer van het voordeel van meerdere threads (`-print0` gebruikt een nul-teken om bestandsnamen te splitsen en `-0` gebruikt het als scheidingsteken): -`find . -name '*.log' -print0 | xargs {{[-0|--null]}} {{[-P|--max-procs]}} {{4}} {{-n|--max-args}} 1 gzip` +`find . -name '*.log' -print0 | xargs {{[-0|--null]}} {{[-P|--max-procs]}} {{4}} {{[-n|--max-args]}} 1 gzip` - Voer het commando eenmaal per argument uit: -`{{argumenten_bron}} | xargs {{-n|--max-args}} 1 {{commando}}` +`{{argumenten_bron}} | xargs {{[-n|--max-args]}} 1 {{commando}}` - Voer het commando één keer uit voor elke invoerregel, waarbij elke plaatsaanduiding (hier gemarkeerd als `_`) wordt vervangen door de invoerregel: diff --git a/pages.nl/linux/abrt.md b/pages.nl/linux/abrt.md new file mode 100644 index 0000000000..67e29583fe --- /dev/null +++ b/pages.nl/linux/abrt.md @@ -0,0 +1,7 @@ +# abrt + +> Dit commando is een alias van `abrt-cli`. + +- Bekijk de documentatie van het originele commando: + +`tldr abrt-cli` diff --git a/pages.nl/linux/certbot.md b/pages.nl/linux/certbot.md index 04c3f0cb04..9e67b9a273 100644 --- a/pages.nl/linux/certbot.md +++ b/pages.nl/linux/certbot.md @@ -2,19 +2,19 @@ > De Let's Encrypt Agent om automatisch TLS certificaten te verkrijgen en te vernieuwen. > Opvolger van `letsencrypt`. -> Meer informatie: . +> Meer informatie: . - Verkrijg een nieuw certificaat via webroot authorisatie, maar installeer het certificaat niet automatisch: -`sudo certbot certonly --webroot --webroot-path {{pad/naar/webroot}} --domain {{subdomein.voorbeeld.com}}` +`sudo certbot certonly --webroot {{[-w|--webroot-path]}} {{pad/naar/webroot}} {{[-d|--domain]}} {{subdomein.example.com}}` - Verkrijg een nieuw certificaat via nginx authorisatie, installeer het nieuwe certificaat automatisch: -`sudo certbot --nginx --domain {{subdomein.voorbeeld.com}}` +`sudo certbot --nginx {{[-d|--domain]}} {{subdomein.example.com}}` - Verkrijg een nieuw certificaat via apache authorisatie, installeer het nieuwe certificaat automatisch: -`sudo certbot --apache --domain {{subdomein.voorbeeld.com}}` +`sudo certbot --apache {{[-d|--domain]}} {{subdomein.example.com}}` - Vernieuw alle Let's Encrypt certificaten die binnen 30 dagen verlopen (vergeet achteraf niet alle servers te herstarten die dit certificaat gebruiken): @@ -22,8 +22,8 @@ - Simuleer het verkrijgen van een nieuw certificaat, maar sla deze niet op, op een harde schijf: -`sudo certbot --webroot --webroot-path {{pad/naar/webroot}} --domain {{subdomein.voorbeeld.com}} --dry-run` +`sudo certbot --webroot {{[-w|--webroot-path]}} {{pad/naar/webroot}} {{[-d|--domain]}} {{subdomein.example.com}} --dry-run` - Verkrijg een onvertrouwd test certificaat: -`sudo certbot --webroot --webroot-path {{pad/naar/webroot}} --domain {{subdomein.voorbeeld.com}} --test-cert` +`sudo certbot --webroot {{[-w|--webroot-path]}} {{pad/naar/webroot}} {{[-d|--domain]}} {{subdomein.example.com}} --test-cert` diff --git a/pages.nl/linux/mkfs.vfat.md b/pages.nl/linux/mkfs.vfat.md new file mode 100644 index 0000000000..0b0146d944 --- /dev/null +++ b/pages.nl/linux/mkfs.vfat.md @@ -0,0 +1,7 @@ +# mkfs.vfat + +> Dit commando is een alias van `mkfs.fat`. + +- Bekijk de documentatie van het originele commando: + +`tldr mkfs.fat` diff --git a/pages.nl/linux/renice.md b/pages.nl/linux/renice.md index f8e8a6d0fc..3a9d8261a3 100644 --- a/pages.nl/linux/renice.md +++ b/pages.nl/linux/renice.md @@ -5,14 +5,18 @@ > Bekijk ook: `nice`. > Meer informatie: . -- Stel de absolute prioriteit van een lopend [p]roces in: +- Stel de absolute prioriteit van een lopend proces in: -`renice {{+3}} -p {{pid}}` +`renice --priority {{3}} {{[-p|--pid]}} {{pid}}` -- Verhoog/verlaag de prioriteit van alle processen die eigendom zijn van een [g]ebruiker: +- Verhoog de prioriteit van een lopend proces: -`renice --relative {{-4}} -u {{uid|user}}` +`sudo renice --relative {{-4}} {{[-p|--pid]}} {{pid}}` -- Stel de prioriteit in van alle processen die behoren tot een proces[g]roep: +- Verlaag de prioriteit van alle processen die eigendom zijn van een gebruiker: -`renice --absolute {{5}} -g {{proces_groep}}` +`renice --relative {{4}} {{[-p|--pid]}} {{pid}}` + +- Stel de prioriteit in van alle processen die behoren tot een procesgroep: + +`sudo renice {{-5}} {{[-g|--pgrp]}} {{process_group}}` diff --git a/pages.nl/linux/semanage-permissive.md b/pages.nl/linux/semanage-permissive.md index 539b57e3cd..4b4ee15c28 100644 --- a/pages.nl/linux/semanage-permissive.md +++ b/pages.nl/linux/semanage-permissive.md @@ -9,6 +9,10 @@ `sudo semanage permissive {{[-l|--list]}}` -- Stel de permissieve modus in of uit voor een domein: +- Stel de permissieve modus in voor een domein: -`sudo semanage permissive {{-a|--add|-d|--delete}} {{httpd_t}}` +`sudo semanage permissive {{[-a|--add]}} {{httpd_t}}` + +- Zet de permissieve modus uit voor een domein: + +`sudo semanage permissive {{[-d|--delete]}} {{httpd_t}}` diff --git a/pages.nl/linux/usermod.md b/pages.nl/linux/usermod.md index 9fe46bb6d6..a44691cf58 100644 --- a/pages.nl/linux/usermod.md +++ b/pages.nl/linux/usermod.md @@ -18,8 +18,16 @@ - Voeg een gebruiker toe aan aanvullende groepen (let op het ontbreken van spaties): -`sudo usermod {{[-a|--append]}} {{[-G|--groups]}} {{groep1,groep2,...}} {{gebruikersnaam}}` +`sudo usermod {{[-aG|--append --groups]}} {{groep1,groep2,...}} {{gebruikersnaam}}` - Verander een gebruikers thuismap: `sudo usermod {{[-m|--move-home]}} {{[-d|--home]}} {{pad/naar/nieuwe_thuismap}} {{gebruikersnaam}}` + +- Vergrendel een account: + +`sudo usermod {{[-L|--lock]}} {{gebruikersnaam}}` + +- Ontgrendel een account: + +`sudo usermod {{[-U|--unlock]}} {{gebruikersnaam}}` diff --git a/pages.nl/netbsd/chpass.md b/pages.nl/netbsd/chpass.md index ae13c71535..2e5ad1da5c 100644 --- a/pages.nl/netbsd/chpass.md +++ b/pages.nl/netbsd/chpass.md @@ -2,7 +2,7 @@ > Gebruikersdatabase informatie toevoegen of wijzigen, inclusief login shell en wachtwoord. > Bekijk ook: `passwd`. -> Meer informatie: . +> Meer informatie: . - Stel interactief een specifieke login shell in voor de huidige gebruiker: @@ -14,7 +14,7 @@ - Stel een login [s]hell in voor een specifieke gebruiker: -`chpass chsh -s {{pad/naar/shell}} {{gebruikersnaam}}` +`chpass -s {{pad/naar/shell}} {{gebruikersnaam}}` - Specificeer een gebruikersdatabase entry in het `passwd` bestandsformaat: diff --git a/pages.nl/openbsd/chpass.md b/pages.nl/openbsd/chpass.md index 0ea5ee963f..b30d0f102c 100644 --- a/pages.nl/openbsd/chpass.md +++ b/pages.nl/openbsd/chpass.md @@ -2,20 +2,20 @@ > Gebruikersdatabase informatie toevoegen of wijzigen, inclusief login shell en wachtwoord. > Bekijk ook: `passwd`. -> Meer informatie: . +> Meer informatie: . - Stel interactief een specifieke login shell in voor de huidige gebruiker: -`doas chsh` +`doas chpass` - Stel een specifieke login [s]hell in voor de huidige gebruiker: -`doas chsh -s {{pad/naar/shell}}` +`doas chpass -s {{pad/naar/shell}}` - Stel een login [s]hell in voor een specifieke gebruiker: -`doas chsh -s {{pad/naar/shell}} {{gebruikersnaam}}` +`doas chpass -s {{pad/naar/shell}} {{gebruikersnaam}}` - Specificeer een gebruikersdatabase entry in het `passwd` bestandsformaat: -`doas chsh -a {{gebruikersnaam:gecodeerd_wachtwoord:uid:gid:...}}` +`doas chpass -a {{gebruikersnaam:gecodeerd_wachtwoord:uid:gid:...}}` diff --git a/pages.nl/osx/date.md b/pages.nl/osx/date.md index 12e9c9cf0e..2518e6c684 100644 --- a/pages.nl/osx/date.md +++ b/pages.nl/osx/date.md @@ -18,3 +18,7 @@ - Toon een specifieke datum (gerepresenteerd als een Unix timestamp) met het standaard formaat: `date -r {{1473305798}}` + +- Toon een datum relatief aan de huidige datum met het standaard formaat: + +`date -v {{+1d}} -v {{-20m}}` diff --git a/pages.nl/windows/chromium.md b/pages.nl/windows/chromium.md index 57d1bec5c4..ab00755931 100644 --- a/pages.nl/windows/chromium.md +++ b/pages.nl/windows/chromium.md @@ -14,7 +14,7 @@ - Open in een nieuw venster: -`chromium --new-window {{voorbeeld.com}}` +`chromium --new-window {{example.com}}` - Open in applicatie modus (zonder werkbalken, URL balk, knoppen, etc.): diff --git a/pages.pl/netbsd/chpass.md b/pages.pl/netbsd/chpass.md index a390cca5ec..a6f41fd908 100644 --- a/pages.pl/netbsd/chpass.md +++ b/pages.pl/netbsd/chpass.md @@ -2,7 +2,7 @@ > Dodaj lub zmień informacje w bazie danych użytkowników, w tym powłokę logowania i hasło. > Zobacz także: `passwd`. -> Więcej informacji: . +> Więcej informacji: . - Ustaw określoną powłokę logowania dla bieżącego użytkownika w sposób interaktywny: @@ -14,7 +14,7 @@ - Ustaw powłokę (z ang. [s]hell) logowania dla określonego użytkownika: -`chpass chsh -s {{ścieżka/do/powłoki}} {{nazwa_użytkownika}}` +`chpass -s {{ścieżka/do/powłoki}} {{nazwa_użytkownika}}` - Określ wpis bazy danych użytkownika w formacie pliku `passwd`: diff --git a/pages.pl/openbsd/chpass.md b/pages.pl/openbsd/chpass.md index a425ccac78..4212a0be96 100644 --- a/pages.pl/openbsd/chpass.md +++ b/pages.pl/openbsd/chpass.md @@ -2,20 +2,20 @@ > Dodaj lub zmień informacje o użytkowniku w bazie danych, w tym powłoki logowania i hasła. > Zobacz także: `passwd`. -> Więcej informacji: . +> Więcej informacji: . - Interaktywnie ustaw określoną powłokę logowania dla bieżącego użytkownika: -`doas chsh` +`doas chpass` - Ustaw określoną powłokę (z ang. [s]hell) logowania dla bieżącego użytkownika: -`doas chsh -s {{ścieżka/do/powłoki}}` +`doas chpass -s {{ścieżka/do/powłoki}}` - Ustaw określoną powłokę (z ang. [s]hell) logowania dla określonego użytkownika: -`doas chsh -s {{ścieżka/do/powłoki}} {{nazwa_użytkownika}}` +`doas chpass -s {{ścieżka/do/powłoki}} {{nazwa_użytkownika}}` - Określ wpis bazy danych użytkownika w formacie pliku `passwd`: -`doas chsh -a {{nazwa_użytkownika:zaszyfrowane_hasło:uid:gid:...}}` +`doas chpass -a {{nazwa_użytkownika:zaszyfrowane_hasło:uid:gid:...}}` diff --git a/pages.pt_BR/linux/cp.md b/pages.pt_BR/linux/cp.md deleted file mode 100644 index c8c839a036..0000000000 --- a/pages.pt_BR/linux/cp.md +++ /dev/null @@ -1,36 +0,0 @@ -# cp - -> Copia arquivos e diretórios. -> Mais informações: . - -- Copia um arquivo para outra localização: - -`cp {{caminho/para/arquivo_entrada.ext}} {{caminho/para/arquivo_saída.ext}}` - -- Copia um arquivo para dentro de outro diretório, mantendo o nome: - -`cp {{caminho/para/arquivo.ext}} {{caminho/para/diretório}}` - -- Copia recursivamente o conteúdo de um diretório para outra localização (se o destino existe, o diretório é copiado para dentro dele): - -`cp {{[-r|--recursive]}} {{caminho/para/diretório_fonte}} {{caminho/para/diretório_alvo}}` - -- Copia um diretório recursivamente, em modo verboso (mostra os arquivos conforme eles são copiados): - -`cp {{[-vr|--verbose --recursive]}} {{caminho/para/diretório_fonte}} {{caminho/para/diretório_alvo}}` - -- Copia múltiplos arquivos de uma só vez para um diretório: - -`cp {{[-t|--target-directory]}} {{caminho/para/diretorio_fonte}} {{caminho/para/arquivo1 caminho/para/arquivo2 ...}}` - -- Copia arquivos de texto para outra localização, em modo interativo (exige confirmação do usuário antes de sobrescrever): - -`cp {{[-i|--interactive]}} {{*.txt}} {{caminho/para/diretório_alvo}}` - -- Segue links simbólicos antes de copiar: - -`cp {{[-L|--dereference]}} {{link}} {{caminho/para/diretório_alvo}}` - -- Usa todo o caminho dos arquivos fonte, criando quaisquer diretórios intermediários ausentes quando copia: - -`cp --parents {{fonte/caminho/para/arquivo}} {{caminho/para/arquivo_alvo}}` diff --git a/pages.pt_BR/linux/man.md b/pages.pt_BR/linux/man.md deleted file mode 100644 index 8c0e1442e2..0000000000 --- a/pages.pt_BR/linux/man.md +++ /dev/null @@ -1,36 +0,0 @@ -# man - -> Formata e exibe páginas do manual. -> Mais informações: . - -- Exibe a página do manual para um comando: - -`man {{comando}}` - -- Exibe a página do manual para um comando no navegador web (necessário ter a variável de sistema `BROWSER` definida): - -`man {{[-Hbrowser_name|--html=browser_name]}} {{command}}` - -- Exibe a página do manual para um comando da seção 7: - -`man {{7}} {{comando}}` - -- Lista todas as seções disponíveis para um comando: - -`man {{[-f|--whatis]}} {{comando}}` - -- Exibe o caminho pesquisado para páginas do manual: - -`man {{[-w|--path]}}` - -- Exibe a localização de uma página do manual em vez da página em si: - -`man {{[-w|--where]}} {{comando}}` - -- Exibe a página do manual usando uma localização específica: - -`man {{[-L|--locale]}} {{localização}} {{comando}}` - -- Procura por páginas do manual que contenham uma certa string: - -`man {{[-k|--apropos]}} "{{string_buscada}}"` diff --git a/pages.pt_BR/linux/rm.md b/pages.pt_BR/linux/rm.md deleted file mode 100644 index 76acd2ca74..0000000000 --- a/pages.pt_BR/linux/rm.md +++ /dev/null @@ -1,29 +0,0 @@ -# rm - -> Remove arquivos ou diretórios. -> Veja também: `rmdir`. -> Mais informações: . - -- Remove arquivos específicos: - -`rm {{caminho/para/arquivo1 caminho/para/arquivo2 ...}}` - -- Remove arquivos específicos ignorando os inexistentes: - -`rm {{[-f|--force]}} {{caminho/para/arquivo1 caminho/para/arquivo2 ...}}` - -- Remove arquivos específicos interativamente avisando antes de cada remoção: - -`rm {{[-i|--interactive]}} {{caminho/para/arquivo1 caminho/para/arquivo2 ...}}` - -- Remove arquivos específicos imprimindo informações sobre cada remoção: - -`rm {{[-v|--verbose]}} {{caminho/para/arquivo1 caminho/para/arquivo2 ...}}` - -- Remove arquivos e diretórios específicos recursivamente: - -`rm {{[-r|--recursive]}} {{caminho/para/arquivo_ou_diretório1 caminho/para/arquivo_ou_diretório2 ...}}` - -- Remove diretórios vazios (este é considerado o método seguro): - -`rm {{[-d|--dir]}} {{caminho/para/diretório}}` diff --git a/pages.pt_BR/linux/rmdir.md b/pages.pt_BR/linux/rmdir.md deleted file mode 100644 index 8d29574d84..0000000000 --- a/pages.pt_BR/linux/rmdir.md +++ /dev/null @@ -1,13 +0,0 @@ -# rmdir - -> Remove diretórios sem arquivos. -> Veja também: `rm`. -> Mais informações: . - -- Remove diretórios específicos: - -`rmdir {{caminho/para/diretório1 caminho/para/diretório2 ...}}` - -- Remove diretórios aninhados específicos recursivamente: - -`rmdir {{[-p|--parents]}} {{caminho/para/diretório1 caminho/para/diretório2 ...}}` diff --git a/pages.pt_BR/osx/ed.md b/pages.pt_BR/osx/ed.md deleted file mode 100644 index 27542c1a29..0000000000 --- a/pages.pt_BR/osx/ed.md +++ /dev/null @@ -1,25 +0,0 @@ -# ed - -> Editor de texto original do Unix. -> Veja também: `awk`, `sed`. -> Mais informações: . - -- Inicia uma sessão interativa do editor com um documento vazio: - -`ed` - -- Inicia uma sessão interativa do editor com um documento vazio e um [p]rompt específico: - -`ed -p '> '` - -- Inicia uma sessão interativa do editor com um documento vazio e sem diagnósticos, contagens de bytes, e prompt '!': - -`ed -s` - -- Edita um arquivo específico (mostra a contagem de bytes do arquivo carregado): - -`ed {{caminho/para/arquivo}}` - -- Substitui uma string por uma substituição específica em todas as linhas: - -`,s/{{expressão_regular}}/{{substituição}}/g` diff --git a/pages.pt_PT/linux/man.md b/pages.pt_PT/linux/man.md deleted file mode 100644 index d4b2510d66..0000000000 --- a/pages.pt_PT/linux/man.md +++ /dev/null @@ -1,32 +0,0 @@ -# man - -> Formata e exibe páginas do manual. -> Mais informações: . - -- Exibe a página do manual para um comando: - -`man {{comando}}` - -- Exibe a página do manual para um comando da seção 7: - -`man {{7}} {{comando}}` - -- Lista todas as seções disponíveis para um comando: - -`man {{[-f|--whatis]}} {{comando}}` - -- Exibe o caminho pesquisado para páginas do manual: - -`man {{[-w|--path]}}` - -- Exibe a localização de uma página do manual em vez da página em si: - -`man {{[-w|--where]}} {{comando}}` - -- Exibe a página do manual usando uma localização específica: - -`man {{[-L|--locale]}} {{localização}} {{comando}}` - -- Procura por páginas do manual que contenham uma certa string: - -`man {{[-k|--apropos]}} "{{string_buscada}}"` diff --git a/pages.pt_PT/osx/readlink.md b/pages.pt_PT/osx/readlink.md deleted file mode 100644 index a2ddb814bd..0000000000 --- a/pages.pt_PT/osx/readlink.md +++ /dev/null @@ -1,8 +0,0 @@ -# readlink - -> Segue um link simbólico e obtêm a sua informação. -> Mais informações: . - -- Mostra o caminho absoluto apontado por um link simbólico: - -`readlink {{caminho/para/link_simbolico}}` diff --git a/pages.ru/linux/man.md b/pages.ru/linux/man.md deleted file mode 100644 index 33a7f459a5..0000000000 --- a/pages.ru/linux/man.md +++ /dev/null @@ -1,32 +0,0 @@ -# man - -> Утилита просмотра справочных страницs. -> Больше информации: . - -- Показать справочную страницу для команды: - -`man {{команда}}` - -- Показать справочную страницу пакета макросов команды из раздела: - -`man {{1..9}} {{команда}}` - -- Отобразить краткое описание из справочной страницы, если оно есть: - -`man {{[-f|--whatis]}} {{команда}}` - -- Отобразить путь поиска справочных страниц: - -`man {{[-w|--path]}}` - -- Отобразить расположение справочной страницы, а не саму справочную страницу: - -`man {{[-w|--where]}} {{команда}}` - -- Отобразить справочную страницу с использованием определённой локали: - -`man {{[-L|--locale]}} {{локаль}} {{команда}}` - -- Найти справочную страницу, содержащую строку поиска: - -`man {{[-k|--apropos]}} "{{строка_поиска}}"` diff --git a/pages.ru/osx/ed.md b/pages.ru/osx/ed.md deleted file mode 100644 index 761ae95242..0000000000 --- a/pages.ru/osx/ed.md +++ /dev/null @@ -1,25 +0,0 @@ -# ed - -> Оригинальный текстовый редактор Unix. -> Смотрите также: `awk`, `sed`. -> Больше информации: . - -- Запустить интерактивную сессию редактора с пустым документом: - -`ed` - -- Запустить интерактивную сессию редактора с пустым документом и указанной подсказкой: - -`ed -p '> '` - -- Запустить интерактивную сессию редактора пустым документом и без диагностики, подсчета байтов и '!' подсказки: - -`ed -s` - -- Редактировать указанный файл (это показывает количество байт загруженного файла): - -`ed {{путь/к/файлу}}` - -- Заменить строку указанной на всех строках: - -`,s/{{регулярное_выражение}}/{{замена}}/g` diff --git a/pages.tr/linux/cp.md b/pages.tr/linux/cp.md deleted file mode 100644 index f1c9cf0502..0000000000 --- a/pages.tr/linux/cp.md +++ /dev/null @@ -1,32 +0,0 @@ -# cp - -> Dosya ve dizinleri kopyala. -> Daha fazla bilgi için: . - -- Bir dosyayı başka bir konuma kopyala: - -`cp {{örnek/yol/kaynak_dosya.ext}} {{örnek/yol/hedef_dosya.ext}}` - -- Bir dosyayı ismini değiştirmeden başka bir dizine kopyala: - -`cp {{örnek/yol/kaynak_dosya.ext}} {{örnek/yol/hedef_ana_dizin}}` - -- Bir dizinin içeriğini başka bir konuma tekrarlı şekilde kopyala (eğer belirtilen konum varsa dizin onun içine kopyalanır): - -`cp {{[-r|--recursive]}} {{örnek/yol/kaynak_dizin}} {{örnek/yol/hedef_dizin}}` - -- Bir dizini tekrarlı şekilde ayrıntılı modda kopyala (dosyaları kopyalandıkları gibi gösterir): - -`cp {{[-vr|--verbose --recursive]}} {{örnek/yol/kaynak_dizin}} {{örnek/yol/hedef_dizin}}` - -- Metin dosyalarını interaktif modda başka bir konuma kopyala (üstüne yazmadan önce kullanıcıyı bilgilendirir): - -`cp {{[-i|--interactive]}} {{*.txt}} {{örnek/yol/hedef_dizin}}` - -- Kopyalamadan önce sembolik linkleri izle: - -`cp {{[-L|--dereference]}} {{link}} {{örnek/yol/hedef_dizin}}` - -- Kopyalarken kaynak dosyalarının tam konumunu belirt: - -`cp --parents {{kaynak/örnek/yol/dosya}} {{örnek/yol/hedef_dosya}}` diff --git a/pages.uk/linux/cp.md b/pages.uk/linux/cp.md deleted file mode 100644 index 523ceff598..0000000000 --- a/pages.uk/linux/cp.md +++ /dev/null @@ -1,32 +0,0 @@ -# cp - -> Скопіювати файли і папки. -> Більше інформації: . - -- Скопіювати файл в інше місце: - -`cp {{шлях/до/файлу_який_скопіювати.ext}} {{шлях/до/файлу_в_який_скопіювати.ext}}` - -- Скопіювати файл в іншу папку, зберугіючи назву файлу: - -`cp {{шлях/до/файлу_який_скопіювати.ext}} {{шлях/до/папки_в_яку_скопіювати}}` - -- Рекурсивно скопіювати вміст папки до іншого місця (якщо місце призначення існує, папка скопіюється всередину нього): - -`cp {{[-r|--recursive]}} {{шлях/до/файлу_який_скопіювати}} {{шлях/до/папки_в_яку_скопіювати}}` - -- Скопіювати папку рекурсивно у докладнішому режимі (показує файли у міру їх копіювання): - -`cp {{[-vr|--verbose --recursive]}} {{шлях/до/папки_яку_спопіювати}} {{шлях/до/папки_в_яку_скопіювати}}` - -- Скопіювати текстові файли в інше місце в інтерактивному режимі (запитує користувача перед перезаписом): - -`cp {{[-i|--interactive]}} {{*.txt}} {{шлях/до/папки_в_яку_скопіювати}}` - -- Зберігає символічні посилання(symbolic link) перед копіюванням: - -`cp {{[-L|--dereference]}} {{посилання}} {{шлях/до/папки_в_яку_скопіювати}}` - -- Використовує повний шлях файлу який потрібно скопіювати, створюючи будь-які відсутні проміжні папки під час копіювання: - -`cp --parents {{повний/шлях/до/файлу}} {{шлях/до/бажаного_файлу}}` diff --git a/pages.uk/linux/man.md b/pages.uk/linux/man.md deleted file mode 100644 index 43af609f53..0000000000 --- a/pages.uk/linux/man.md +++ /dev/null @@ -1,32 +0,0 @@ -# man - -> Форматування та відображення сторінок посібника. -> Більше інформації: . - -- Відобразити довідкову сторінку для команди: - -`man {{команда}}` - -- Відобразити сторінку довідки для команди з розділу 7: - -`man {{7}} {{команда}}` - -- Відобразити усі доступні розділи для команди: - -`man {{[-f|--whatis]}} {{команда}}` - -- Відобразити шлях пошуку довідкових сторінок: - -`man {{[-w|--path]}}` - -- Відобразити розташування довідкової сторінки, а не довідкову сторінку: - -`man {{[-w|--where]}} {{команда}}` - -- Відобразити довідкову сторінку з використанням певної локалі: - -`man {{[-L|--locale]}} {{локаль}} {{команда}}` - -- Знайти довідкові сторінки, які містять рядок пошуку: - -`man {{[-k|--apropos]}} "{{рядок_пошуку}}"` diff --git a/pages.uk/linux/rm.md b/pages.uk/linux/rm.md deleted file mode 100644 index 28c1c4caca..0000000000 --- a/pages.uk/linux/rm.md +++ /dev/null @@ -1,25 +0,0 @@ -# rm - -> Видалити файли або директорії. -> Дивіться також: `rmdir`. -> Більше інформації: . - -- Видалити певні файли: - -`rm {{шлях/до/файлу1 шлях/до/файлу2 ...}}` - -- Видалити певні файли, ігноруючи неіснуючі: - -`rm {{[-f|--force]}} {{шлях/до/файлу1 шлях/до/файлу2 ...}}` - -- Видалити певні файли інтерактивно запитуючи перед кожним видаленням: - -`rm {{[-i|--interactive]}} {{шлях/до/файлу1 шлях/до/файлу2 ...}}` - -- Видалити певні файли, друкуючи інформацію про кожне видалення: - -`rm {{[-v|--verbose]}} {{шлях/до/файлу1 шлях/до/файлу2 ...}}` - -- Видалити певні файли та директорії рекурсивно: - -`rm {{[-r|--recursive]}} {{шлях/до/файлу_або_папки1 шлях/до/файлу_або_папки2 ...}}` diff --git a/pages.zh/common/,.md b/pages.zh/common/,.md new file mode 100644 index 0000000000..e696fff4d4 --- /dev/null +++ b/pages.zh/common/,.md @@ -0,0 +1,16 @@ +# Comma + +> 无需安装即可运行命令。 +> 更多信息：. + +- 运行命令： + +`, {{命令 -带 -参数}}` + +- 将命令添加到子 shell 中： + +`, {{[-s|--shell]}} {{命令}}` + +- 清除缓存： + +`, {{[-e|--empty-cache]}}` diff --git a/pages.zh/common/asdf.md b/pages.zh/common/asdf.md index 005186a7ce..a69f09e8ad 100644 --- a/pages.zh/common/asdf.md +++ b/pages.zh/common/asdf.md @@ -26,3 +26,7 @@ - 设置软件包的本地版本： `asdf set {{软件包名}} {{版本}}` + +- 查看软件包当前使用的版本： + +`asdf current {{软件包名}}` diff --git a/pages.zh/common/at.md b/pages.zh/common/at.md index ab14a50c31..559cd45b13 100644 --- a/pages.zh/common/at.md +++ b/pages.zh/common/at.md @@ -4,10 +4,6 @@ > 结果将被发送到用户的邮箱。 > 更多信息：. -- 启动 `atd` 守护进程： - -`systemctl start atd` - - 交互式创建命令并在 5 分钟后执行（完成后按 ``）： `at now + 5 minutes` @@ -23,3 +19,11 @@ - 在下周二晚上 9:30 从指定文件执行命令： `at -f {{路径/到/文件}} 9:30 PM Tue` + +- 列出当前用户的所有待执行任务（等同于 `atq`）： + +`at -l` + +- 查看指定任务： + +`at -c {{任务编号}}` diff --git a/pages.zh/common/case.md b/pages.zh/common/case.md index 7e00d259e0..af23d09c83 100644 --- a/pages.zh/common/case.md +++ b/pages.zh/common/case.md @@ -1,6 +1,6 @@ # case -> case ... esac 与其他语言中的 switch ... case 语句类似，是一种多分枝选择结构。 +> Bash 内置的多重条件语句结构。 > 更多信息：. - 通过字符串字面量判断执行分支： @@ -18,3 +18,7 @@ - 继续执行下一个模式的命令而不检查模式： `case {{$动物}} in {{猫}}) echo "这是一只猫" ;& {{狗}}) echo "这是一只狗或猫的匹配结果" ;& *) echo "其他动物" ;; esac` + +- 显示帮助： + +`help case` diff --git a/pages.zh/common/compgen.md b/pages.zh/common/compgen.md index 8d88ae9239..65bfab0c1a 100644 --- a/pages.zh/common/compgen.md +++ b/pages.zh/common/compgen.md @@ -26,3 +26,11 @@ - 查看以 'ls' 开头的所有可用命令和别名： `compgen -ac {{ls}}` + +- 列出系统中所有用户： + +`compgen -u` + +- 显示帮助信息： + +`compgen --help` diff --git a/pages.zh/common/git-alias.md b/pages.zh/common/git-alias.md new file mode 100644 index 0000000000..3f200d37fa --- /dev/null +++ b/pages.zh/common/git-alias.md @@ -0,0 +1,17 @@ +# git alias + +> 为 Git 命令创建快捷方式。 +> 属于 `git-extras`的一部分 +> 更多信息：. + +- 列出所有别名 + +`git alias` + +- 为命令创建一个别名 + +`git alias "{{别名}}" "{{命令}}"` + +- 搜索一个现有的别名 + +`git alias ^{{别名}}` diff --git a/pages.zh/common/git-am.md b/pages.zh/common/git-am.md new file mode 100644 index 0000000000..629537eebe --- /dev/null +++ b/pages.zh/common/git-am.md @@ -0,0 +1,21 @@ +# git am + +> 应用补丁文件并创建提交。在通过电子邮件接收提交时非常有用。 +> 另请参阅 `git format-patch`，该命令可以生成补丁文件。 +> 更多信息：. + +- 应用本地补丁文件并提交更改： + +`git am {{路径/到/目录.patch}}` + +- 应用远程补丁文件并提交更改： + +`curl {{[-L|--location]}} {{https://example.com/file.patch}} | git apply` + +- 中止应用补丁文件的过程： + +`git am --abort` + +- 尽可能应用补丁文件，将失败的代码块保存到拒绝文件中： + +`git am --reject {{路径/到/目录.patch}}` diff --git a/pages.zh/common/git-annex.md b/pages.zh/common/git-annex.md new file mode 100644 index 0000000000..8bf00fd0ae --- /dev/null +++ b/pages.zh/common/git-annex.md @@ -0,0 +1,29 @@ +# git annex + +> 用 Git 管理文件，但不将其内容提交到版本库中。 +> 当文件被附属时，其内容会被移至键值存储中，并创建一个指向该内容的符号链接。 +> 更多信息：. + +- 初始化一个带有 Git annex 的仓库： + +`git annex init` + +- 添加文件： + +`git annex add {{路径/到/文件或目录}}` + +- 显示文件或目录的当前状态： + +`git annex status {{路径/到/文件或目录}}` + +- 同步本地仓库与远程仓库： + +`git annex {{远程仓库名}}` + +- 获取文件或目录（从键值存储中恢复内容）： + +`git annex get {{路径/到/文件或目录}}` + +- 显示帮助信息： + +`git annex help` diff --git a/pages.zh/common/git-annotate.md b/pages.zh/common/git-annotate.md new file mode 100644 index 0000000000..3b01ef0630 --- /dev/null +++ b/pages.zh/common/git-annotate.md @@ -0,0 +1,18 @@ +# git annotate + +> 显示文件中每一行的提交哈希值和最后修改作者。 +> 参见 `git blame`（推荐优先使用该命令） +> 提供`git annotate` 主要是为了照顾熟悉其他版本控制系统的用户 +> 更多信息：. + +- 打印文件内容，并在每行前附加作者姓名和提交哈希值： + +`git annotate {{路径/到/文件}}` + +- 打印文件内容，并在每行前附加作者邮箱和提交哈希值： + +`git annotate {{[-e|--show-email]}} {{路径/到/文件}}` + +- 仅打印匹配正则表达式的行： + +`git annotate -L :{{正则表达式}} {{路径/到/文件}}` diff --git a/pages.zh/common/git-apply.md b/pages.zh/common/git-apply.md new file mode 100644 index 0000000000..4d913faf59 --- /dev/null +++ b/pages.zh/common/git-apply.md @@ -0,0 +1,29 @@ +# git apply + +> 将补丁应用到文件和/或暂存区，但不创建提交。 +> 另请参阅 `git am`，该命令不仅能应用补丁还会创建提交。 +> 更多信息：. + +- 显示补丁文件的应用详情： + +`git apply --verbose {{路径/到/文件}}` + +- 应用补丁并将修改添加到暂存区： + +`git apply --index {{路径/到/文件}}` + +- 应用远程补丁文件： + +`curl -L {{https://example.com/file.patch}} | git apply` + +- 应用远程补丁文件： + +`git apply --stat --apply {{路径/到/文件}}` + +- 反向应用补丁（撤销更改）： + +`git apply --reverse {{路径/到/文件}}` + +- 将补丁结果存入暂存区但不修改工作区： + +`git apply --cache {{路径/到/文件}}` diff --git a/pages.zh/common/git-archive-file.md b/pages.zh/common/git-archive-file.md new file mode 100644 index 0000000000..5b29147344 --- /dev/null +++ b/pages.zh/common/git-archive-file.md @@ -0,0 +1,9 @@ +# git archive-file + +> 将当前 Git 分支的所有文件导出为 Zip 压缩包。 +> 属于 `git-extras`的一部分。 +> 更多信息：. + +- 将当前检出的提交打包成 Zip 压缩包： + +`git archive-file` diff --git a/pages.zh/common/git-archive.md b/pages.zh/common/git-archive.md new file mode 100644 index 0000000000..dcbfd6edfe --- /dev/null +++ b/pages.zh/common/git-archive.md @@ -0,0 +1,28 @@ +# git archive + +> 从代码树创建文件归档。 +> 更多信息：. + +- 从当前 HEAD 内容创建 tar 归档并输出到标准输出： + +`git archive {{[-v|--verbose]}} HEAD` + +- 使用 Zip 格式并显示详细进度： + +`git archive {{[-v|--verbose]}} --format zip HEAD` + +- 将 Zip 归档输出到指定文件： + +`git archive {{[-v|--verbose]}} {{[-o|--output]}} {{路径/到/文件.zip}} HEAD` + +- 从指定分支的最新提交内容创建 tar 归档： + +`git archive {{[-o|--output]}} {{路径/到/文件.tar}} {{指定分支}}` + +- 使用特定目录的内容创建归档： + +`git archive {{[-o|--output]}} {{路径/到/文件.tar}} HEAD:{{路径/到/目录}}` + +- 为归档中的每个文件添加前缀路径： + +`git archive {{[-o|--output]}} {{路径/到/文件.tar}} --prefix {{路径/到/前缀路径}}/ HEAD` diff --git a/pages.zh/common/git-authors.md b/pages.zh/common/git-authors.md new file mode 100644 index 0000000000..59d291389a --- /dev/null +++ b/pages.zh/common/git-authors.md @@ -0,0 +1,17 @@ +# git authors + +> 生成 Git 仓库的提交者列表。 +> 属于 `git-extras`的一部分。 +> 更多信息：. + +- 将完整的提交者列表输出到标准输出，而不是写入到 `AUTHORS` 文件： + +`git authors --list` + +- 将提交者列表追加到 `AUTHORS` 文件并用默认编辑器打开： + +`git authors` + +- 将提交者列表（不包含邮箱）追加到 `AUTHORS` 文件并用默认编辑器打开： + +`git authors --no-email` diff --git a/pages.zh/common/git-bisect.md b/pages.zh/common/git-bisect.md new file mode 100644 index 0000000000..bd24fb7e63 --- /dev/null +++ b/pages.zh/common/git-bisect.md @@ -0,0 +1,25 @@ +# git bisect + +> 使用二分查找定位引入错误的提交。 +> Git 会自动在提交历史中来回跳转，逐步缩小问题提交的范围。 +> 更多信息：. + +- 在已知有问题提交和已知正常提交（通常较旧）之间开始二分查找会话： + +`git bisect start {{问题提交}} {{正常提交}}` + +- 对 `git bisect` 自动选中的每个提交进行测试后，标记为"正常"或"有问题"： + +`git bisect {{good|bad}}` + +- 当 `git bisect` 定位到问题提交后，结束二分查找会话并返回原分支： + +`git bisect reset` + +- 在二分查找过程中跳过某个提交（例如因其他问题导致测试失败的提交）： + +`git bisect skip` + +- 显示当前二分查找的进度日志： + +`git bisect log` diff --git a/pages.zh/common/git-blame-someone-else.md b/pages.zh/common/git-blame-someone-else.md new file mode 100644 index 0000000000..3b3161f32d --- /dev/null +++ b/pages.zh/common/git-blame-someone-else.md @@ -0,0 +1,8 @@ +# git blame-someone-else + +> 将你的糟糕代码归咎于其他人。 +> 更多信息：. + +- 更改提交的提交者和作者： + +`git blame-someone-else "{{作者 }}" {{提交}}` diff --git a/pages.zh/common/git-blame.md b/pages.zh/common/git-blame.md new file mode 100644 index 0000000000..82a990d472 --- /dev/null +++ b/pages.zh/common/git-blame.md @@ -0,0 +1,28 @@ +# git blame + +> 显示文件每一行的最后修改者和提交哈希值。 +> 更多信息：. + +- 显示文件的每一行，包含作者名字和提交哈希值： + +`git blame {{路径/到/文件}}` + +- 显示文件的每一行，包含作者邮箱和提交哈希值： + +`git blame {{[-e|--show-email]}} {{路径/到/文件}}` + +- 显示文件在指定提交时的每一行，包含作者名字和提交哈希值： + +`git blame {{commit}} {{路径/到/文件}}` + +- 显示文件在指定提交之前的每一行，包含作者名字和提交哈希值： + +`git blame {{commit}}~ {{路径/到/文件}}` + +- 显示指定行范围内的作者名字和提交哈希值信息： + +`git blame -L {{start_line}},{{end_line}} {{路径/到/文件}}` + +- 忽略空白字符和行移动： + +`git blame -w -C -C -C {{路径/到/文件}}` diff --git a/pages.zh/common/git-browse-ci.md b/pages.zh/common/git-browse-ci.md new file mode 100644 index 0000000000..cdc3cf6776 --- /dev/null +++ b/pages.zh/common/git-browse-ci.md @@ -0,0 +1,13 @@ +# git browse-ci + +> 在默认浏览器中打开当前 `git` 代码库的 CI 网站。 +> 属于 `git-extras` 工具集的一部分。 +> 更多信息：. + +- 在默认浏览器中打开当前代码库的 CI 配置页面（基于上游网站）： + +`git browse-ci` + +- 为指定远程仓库打开当前代码库的 CI 配置页面： + +`git browse-ci {{远程名称}}` diff --git a/pages.zh/common/git-browse.md b/pages.zh/common/git-browse.md new file mode 100644 index 0000000000..1d5e1320c7 --- /dev/null +++ b/pages.zh/common/git-browse.md @@ -0,0 +1,13 @@ +# git browse + +> 在默认浏览器中查看上游代码库 +> 属于 `git-extras` 工具集的一部分。 +> 更多信息：. + +- 在默认浏览器中打开第一个上游代码库： + +`git browse` + +- 在默认浏览器中打开指定的上游代码库： + +`git browse {{上游名称}}` diff --git a/pages.zh/common/git-brv.md b/pages.zh/common/git-brv.md new file mode 100644 index 0000000000..494fcde9f4 --- /dev/null +++ b/pages.zh/common/git-brv.md @@ -0,0 +1,9 @@ +# git brv + +> 按最后提交日期排序显示分支列表。 +> 属于 `git-extras`的一部分。 +> 更多信息：. + +- 列出所有分支，显示日期、最新提交哈希和提交信息： + +`git brv` diff --git a/pages.zh/common/git-bug.md b/pages.zh/common/git-bug.md new file mode 100644 index 0000000000..b6666530b4 --- /dev/null +++ b/pages.zh/common/git-bug.md @@ -0,0 +1,33 @@ +# git bug + +> 一个使用 Git 内部存储的分布式问题追踪器，不会在项目中添加额外文件。 +> 您可以像提交和分支一样，将问题提交到与他人交互的同一个 Git 远程仓库。 +> 更多信息：. + +- 创建新身份： + +`git bug user create` + +- 创建新问题： + +`git bug add` + +- 推送新问题条目到远程仓库： + +`git bug push` + +- 拉取更新： + +`git bug pull` + +- 列出已有问题： + +`git bug ls` + +- 使用查询条件筛选和排序问题： + +`git bug ls "{{状态}}:{{open}} {{排序}}:{{edit}}"` + +- 按文本内容搜索问题： + +`git bug ls "{{搜索查询}}" baz` diff --git a/pages.zh/common/git-bugreport.md b/pages.zh/common/git-bugreport.md new file mode 100644 index 0000000000..698d2ebe54 --- /dev/null +++ b/pages.zh/common/git-bugreport.md @@ -0,0 +1,16 @@ +# git bugreport + +> 收集系统和用户的调试信息，生成文本文件以帮助报告 Git 中的问题。 +> 更多信息：. + +- 在当前目录创建新的问题报告文件： + +`git bugreport` + +- 在指定目录创建新的问题报告文件（如目录不存在则自动创建）： + +`git bugreport {{[-o|--output-directory]}} {{path/to/directory}}` + +- 使用指定格式的时间戳后缀创建问题报告文件（ `strftime` 格式）： + +`git bugreport {{[-s|--suffix]}} {{%m%d%y}}` diff --git a/pages.zh/common/git-bulk.md b/pages.zh/common/git-bulk.md new file mode 100644 index 0000000000..bb7e45b8e6 --- /dev/null +++ b/pages.zh/common/git-bulk.md @@ -0,0 +1,37 @@ +# git bulk + +> 批量操作多个 Git 仓库。 +> 属于 `git-extras`的一部分。 +> 更多信息：. + +- 将当前目录注册为工作区： + +`git bulk --addcurrent {{工作区名称}}` + +- 注册一个工作区用于批量操作： + +`git bulk --addworkspace {{工作区名称}} {{到仓库的绝对路径}}` + +- 在指定目录克隆仓库并注册为工作区： + +`git bulk --addworkspace {{工作区名称}} {{仓库父目录的绝对路径}} --from {{远程仓库地址}}` + +- 从换行分隔的远程仓库列表克隆并注册为工作区： + +`git bulk --addworkspace {{工作区名称}} {{/路径/到/根/目录}} --from {{/路径/到/文件}}` + +- 列出所有已注册的工作区： + +`git bulk --listall` + +- 在当前工作区的所有仓库上执行 Git 命令： + +`git bulk {{命令}} {{命令参数}}` + +- 删除指定工作区： + +`git bulk --removeworkspace {{工作区名称}}` + +- 删除所有工作区： + +`git bulk --purge` diff --git a/pages.zh/common/git-bundle.md b/pages.zh/common/git-bundle.md new file mode 100644 index 0000000000..5e9cfd9818 --- /dev/null +++ b/pages.zh/common/git-bundle.md @@ -0,0 +1,36 @@ +# git bundle + +> 将对象和引用打包成归档文件。 +> 更多信息：. + +- 创建包含特定分支所有对象和引用的打包文件： + +`git bundle create {{路径/到/文件.bundle}} {{分支名}}` + +- 创建包含所有分支的打包文件： + +`git bundle create {{路径/到/文件.bundle}} --all` + +- 创建当前分支最近5次提交的打包文件： + +`git bundle create {{路径/到/文件.bundle}} -5 {{HEAD}}` + +- 创建最近7天提交的打包文件： + +`git bundle create {{路径/到/文件.bundle}} --since 7.days {{HEAD}}` + +- 验证打包文件是否有效且可应用到当前仓库： + +`git bundle verify {{路径/到/文件.bundle}}` + +- 显示打包文件中包含的引用列表： + +`git bundle unbundle {{路径/到/文件.bundle}}` + +- 从打包文件中解包特定分支到当前仓库： + +`git pull {{路径/到/文件.bundle}} {{分支名}}` + +- 从打包文件创建新仓库： + +`git clone {{路径/到/文件.bundle}}` diff --git a/pages.zh/common/git-cat-file.md b/pages.zh/common/git-cat-file.md new file mode 100644 index 0000000000..b2324d0db1 --- /dev/null +++ b/pages.zh/common/git-cat-file.md @@ -0,0 +1,16 @@ +# git cat-file + +> 查看 Git 仓库对象的内容或类型和大小信息。 +> 更多信息：. + +- 获取 HEAD 提交的字节大小： + +`git cat-file -s HEAD` + +- 获取指定 Git 对象的类型（blob、tree、commit、tag）： + +`git cat-file -t {{8c442dc3}}` + +- 根据对象类型打印指定 Git 对象的内容： + +`git cat-file -p {{HEAD~2}}` diff --git a/pages.zh/common/git-changelog.md b/pages.zh/common/git-changelog.md new file mode 100644 index 0000000000..a2fa94963c --- /dev/null +++ b/pages.zh/common/git-changelog.md @@ -0,0 +1,33 @@ +# git changelog + +> 从仓库提交和标签生成变更日志报告。 +> 属于 `git-extras` 的一部分。 +> 更多信息：. + +- 更新现有文件或创建新的 `History.md` 文件，包含自最新 Git 标签以来的提交信息： + +`git changelog` + +- 列出当前版本的提交： + +`git changelog --list` + +- 列出从标签 `2.1.0` 到现在的提交范围 + +`git changelog --list --start-tag {{2.1.0}}` + +- 以美观格式列出标签 `0.5.0` 到 `1.0.0` 之间的提交： + +`git changelog --start-tag {{0.5.0}} --final-tag {{1.0.0}}` + +- 以美观格式列出提交 `0b97430` 到标签 `1.0.0` 之间的提交： + +`git changelog --start-commit {{0b97430}} --final-tag {{1.0.0}}` + +- 指定 `CHANGELOG.md` 作为输出文件： + +`git changelog {{CHANGELOG.md}}` + +- 完全替换当前变更日志文件的内容： + +`git changelog --prune-old` diff --git a/pages.zh/common/git-check-attr.md b/pages.zh/common/git-check-attr.md new file mode 100644 index 0000000000..8fe05bd0e1 --- /dev/null +++ b/pages.zh/common/git-check-attr.md @@ -0,0 +1,20 @@ +# git check-attr + +> 检查每个路径的文件属性状态（未指定/已设置/未设置）。 +> 更多信息：. + +- 检查文件的所有属性状态： + +`git check-attr --all {{路径/到/文件}}` + +- Check the value of a specific attribute on a file: + +`git check-attr {{属性}} {{路径/到/文件}}` + +- Check the values of all attributes on specific files: + +`git check-attr --all {{路径/到/文件1 路径/到/文件2 ...}}` + +- Check the value of a specific attribute on one or more files: + +`git check-attr {{属性}} {{路径/到/文件1 路径/到/文件2 ...}}` diff --git a/pages.zh/common/git-check-ignore.md b/pages.zh/common/git-check-ignore.md new file mode 100644 index 0000000000..299f1bd170 --- /dev/null +++ b/pages.zh/common/git-check-ignore.md @@ -0,0 +1,24 @@ +# git check-ignore + +> 分析和调试 Git 忽略规则（.gitignore 文件）。 +> 更多信息：. + +- 检查文件或目录是否被忽略： + +`git check-ignore {{路径/到/文件或目录}}` + +- 检查多个文件或目录是否被忽略： + +`git check-ignore {{路径/到/文件或目录1 路径/到/文件或目录2 ...}}` + +- 从标准输入读取路径列表（每行一个路径）： + +`git check-ignore --stdin < {{路径/到/文件列表}}` + +- 不检查索引（用于调试为何某些路径被跟踪而非忽略）： + +`git check-ignore --no-index {{路径/到/文件或目录1 路径/到/文件或目录2 ...}}` + +- 显示每个路径匹配的具体忽略规则： + +`git check-ignore --verbose {{路径/到/文件或目录1 路径/到/文件或目录2 ...}}` diff --git a/pages.zh/common/git-check-mailmap.md b/pages.zh/common/git-check-mailmap.md new file mode 100644 index 0000000000..79900f049a --- /dev/null +++ b/pages.zh/common/git-check-mailmap.md @@ -0,0 +1,8 @@ +# git check-mailmap + +> 显示联系人的规范名称和电子邮件地址。 +> 更多信息：. + +- 查找与电子邮件地址关联的规范名称： + +`git check-mailmap "<{{邮箱@example.com}}>"` diff --git a/pages.zh/common/git-check-ref-format.md b/pages.zh/common/git-check-ref-format.md new file mode 100644 index 0000000000..2f344d4276 --- /dev/null +++ b/pages.zh/common/git-check-ref-format.md @@ -0,0 +1,16 @@ +# git check-ref-format + +> 检查引用名称格式是否合法，不合法时返回非零状态码。 +> 更多信息：. + +- 检查指定引用名称的格式是否合法： + +`git check-ref-format {{refs/head/refname}}` + +- 打印最近检出的分支名称 + +`git check-ref-format --branch @{-1}` + +- 规范化引用名称格式： + +`git check-ref-format --normalize {{refs/head/refname}}` diff --git a/pages.zh/common/git-checkout-index.md b/pages.zh/common/git-checkout-index.md new file mode 100644 index 0000000000..2dc0f0aa33 --- /dev/null +++ b/pages.zh/common/git-checkout-index.md @@ -0,0 +1,20 @@ +# git checkout-index + +> 将文件从暂存区复制到工作区。 +> 更多信息：. + +- 恢复自上次提交以来删除的所有文件： + +`git checkout-index --all` + +- 恢复自上次提交以来删除或修改的所有文件（强制覆盖）： + +`git checkout-index --all --force` + +- 恢复自上次提交以来修改的文件（忽略已删除的文件）： + +`git checkout-index --all --force --no-create` + +- 将最后一次提交的整个工作树导出到指定目录（注意结尾斜杠）： + +`git checkout-index --all --force --prefix={{路径/到/导出目录/}}` diff --git a/pages.zh/common/git-cherry-pick.md b/pages.zh/common/git-cherry-pick.md new file mode 100644 index 0000000000..d791d60493 --- /dev/null +++ b/pages.zh/common/git-cherry-pick.md @@ -0,0 +1,21 @@ +# git cherry-pick + +> 将现有提交的变更应用到当前分支。 +> 如需应用到其他分支，请先用 `git checkout` 切换到目标分支。 +> 更多信息：. + +- 将单个提交应用到当前分支： + +`git cherry-pick {{提交哈希}}` + +- 将连续多个提交应用到当前分支（也可参考 `git rebase --onto`）： + +`git cherry-pick {{起始提交}}~..{{结束提交}}` + +- 将多个（非连续的）提交应用到当前分支： + +`git cherry-pick {{提交1 提交2 ...}}` + +- 将提交变更应用到工作区但不自动创建提交： + +`git cherry-pick --no-commit {{提交哈希}}` diff --git a/pages.zh/common/git-cherry.md b/pages.zh/common/git-cherry.md new file mode 100644 index 0000000000..73d7127a83 --- /dev/null +++ b/pages.zh/common/git-cherry.md @@ -0,0 +1,16 @@ +# git cherry + +> 查找尚未应用到上游分支的提交。 +> 更多信息：. + +- 显示已在上游分支有对应提交的提交（包含提交信息）： + +`git cherry {{[-v|--verbose]}}` + +- 指定不同的上游分支和主题分支进行比较： + +`git cherry {{上游分支}} {{主题分支}}` + +- 限定比较范围到某个基准点之后的提交： + +`git cherry {{上游分支}} {{主题分支}} {{基准点}}` diff --git a/pages.zh/common/git-clean.md b/pages.zh/common/git-clean.md new file mode 100644 index 0000000000..e042b15539 --- /dev/null +++ b/pages.zh/common/git-clean.md @@ -0,0 +1,28 @@ +# git clean + +> 从工作区删除未被 Git 跟踪的文件。 +> 更多信息：. + +- 删除未跟踪的文件： + +`git clean` + +- 交互式删除未跟踪的文件： + +`git clean {{[-i|--interactive]}}` + +- 显示将被删除的文件（模拟运行，不实际删除）： + +`git clean {{[-n|--dry-run]}}` + +- 强制删除未跟踪的文件： + +`git clean {{[-f|--force]}}` + +- 强制删除未跟踪的目录： + +`git clean {{[-f|--force]}} -d` + +- 删除未跟踪的文件（包括被忽略的文件，在 `.gitignore` 和 `.git/info/exclude`的文件）： + +`git clean -x` diff --git a/pages.zh/common/git-clear-soft.md b/pages.zh/common/git-clear-soft.md new file mode 100644 index 0000000000..b5d7bee6f8 --- /dev/null +++ b/pages.zh/common/git-clear-soft.md @@ -0,0 +1,9 @@ +# git clear-soft + +> 将 Git 工作目录清理至如同刚克隆时的状态（不包含 `.gitignore` 中的文件）。 +> 属于 `git-extras` 一部分。 +> 更多信息：. + +- 重置所有已跟踪文件并删除所有未跟踪文件： + +`git clear-soft` diff --git a/pages.zh/common/git-clear.md b/pages.zh/common/git-clear.md new file mode 100644 index 0000000000..be2d16a853 --- /dev/null +++ b/pages.zh/common/git-clear.md @@ -0,0 +1,9 @@ +# git clear + +> 将 Git 工作目录清理至如同刚克隆时的状态（包含 `.gitignore` 中的文件）。 +> 属于 `git-extras` 的一部分。 +> 更多信息：. + +- 重置所有已跟踪文件并删除所有未跟踪文件（包括 `.gitignore` 中的文件）： + +`git clear` diff --git a/pages.zh/common/git-cliff.md b/pages.zh/common/git-cliff.md new file mode 100644 index 0000000000..333275497d --- /dev/null +++ b/pages.zh/common/git-cliff.md @@ -0,0 +1,24 @@ +# git cliff + +> 高度可定制的变更日志生成工具。 +> 更多信息：. + +- 从 Git 仓库所有提交生成变更日志并保存到 `CHANGELOG.md` ： + +`git cliff > {{CHANGELOG.md}}` + +- 从最新标签之后的提交生成变更日志并输出到标准输出： + +`git cliff {{[-l|--latest]}}` + +- 为当前标签对应的提交生成变更日志（需先使用 `git checkout` 检出到一个标签）： + +`git cliff --current` + +- 为尚未打标签的提交生成变更日志： + +`git cliff {{[-u|--unreleased]}}` + +- 在当前目录生成默认配置文件 `cliff.toml` ： + +`git cliff {{[-i|--init]}}` diff --git a/pages.zh/common/git-coauthor.md b/pages.zh/common/git-coauthor.md new file mode 100644 index 0000000000..1db755448a --- /dev/null +++ b/pages.zh/common/git-coauthor.md @@ -0,0 +1,9 @@ +# git coauthor + +> 为最新提交添加共同作者（会重写 Git 历史，下次推送需使用 `--force` 选项）。 +> 属于 `git-extras`一部分。 +> 更多信息：. + +- 为最新提交添加共同作者： + +`git coauthor {{作者姓名}} {{作者邮箱}}` diff --git a/pages.zh/common/git-cola.md b/pages.zh/common/git-cola.md new file mode 100644 index 0000000000..c38ad7bb44 --- /dev/null +++ b/pages.zh/common/git-cola.md @@ -0,0 +1,24 @@ +# git cola + +> 功能强大且界面直观的 Git 图形化界面工具。 +> 更多信息：. + +- 启动图形界面： + +`git cola` + +- 以修订模式启动图形界面： + +`git cola --amend` + +- 提示选择 Git 仓库（默认为当前目录）： + +`git cola --prompt` + +- 打开指定路径的 Git 仓库： + +`git cola --repo {{路径/到/git仓库}}` + +- 在状态组件中应用路径过滤器： + +`git cola --status-filter {{过滤器}}` diff --git a/pages.zh/common/git-column.md b/pages.zh/common/git-column.md new file mode 100644 index 0000000000..9c99b7a1ff --- /dev/null +++ b/pages.zh/common/git-column.md @@ -0,0 +1,16 @@ +# git column + +> 以列格式显示数据。 +> 更多信息：. + +- 将标准输入内容格式化为多列显示： + +`ls | git column --mode={{column}}` + +- 以最大宽度 `100` 的列格式显示标准输入内容： + +`ls | git column --mode=column --width={{100}}` + +- 以最大边距 `30` 的列格式显示标准输入内容： + +`ls | git column --mode=column --padding={{30}}` diff --git a/pages.zh/common/git-commit-graph.md b/pages.zh/common/git-commit-graph.md new file mode 100644 index 0000000000..b3081c345b --- /dev/null +++ b/pages.zh/common/git-commit-graph.md @@ -0,0 +1,16 @@ +# git commit-graph + +> 生成和验证 Git 提交图文件。 +> 更多信息：. + +- 为仓库本地 `.git` 目录中的打包提交生成提交图文件： + +`git commit-graph write` + +- 生成包含所有可达提交的提交图文件： + +`git show-ref --hash | git commit-graph write --stdin-commits` + +- 生成包含当前提交图文件中所有提交以及从 `HEAD` 可达提交的提交图文件（追加模式）： + +`git rev-parse {{HEAD}} | git commit-graph write --stdin-commits --append` diff --git a/pages.zh/common/git-commit-tree.md b/pages.zh/common/git-commit-tree.md new file mode 100644 index 0000000000..9f9e0e3383 --- /dev/null +++ b/pages.zh/common/git-commit-tree.md @@ -0,0 +1,21 @@ +# git commit-tree + +> 用于创建提交对象的底层工具。 +> 参考： `git commit`. +> 更多信息：. + +- 创建带有指定提交信息的提交对象： + +`git commit-tree {{树对象哈希}} -m "{{提交信息}}"` + +- 从文件读取提交信息创建提交对象（使用 `-` 表示从标准输入读取）： + +`git commit-tree {{树对象哈希}} -F {{路径/到/文件}}` + +- 创建 GPG 签名过的提交对象： + +`git commit-tree {{树对象哈希}} -m "{{提交信息}}" --gpg-sign` + +- 创建指定父提交的提交对象： + +`git commit-tree {{树对象哈希}} -m "{{提交信息}}" -p {{父提交哈希}}` diff --git a/pages.zh/common/git-commits-since.md b/pages.zh/common/git-commits-since.md new file mode 100644 index 0000000000..4a49c0b1e1 --- /dev/null +++ b/pages.zh/common/git-commits-since.md @@ -0,0 +1,21 @@ +# git commits-since + +> 显示从指定时间点以来的提交记录。 +> 属于 `git-extras` 一部分。 +> 更多信息：. + +- 显示从昨天以来的所有提交： + +`git commits-since {{yesterday}}` + +- 显示从上周以来的所有提交： + +`git commits-since {{last week}}` + +- 显示从上个月以来的所有提交： + +`git commits-since {{last month}}` + +- 显示从昨天下午2点以来的所有提交： + +`git commits-since {{yesterday 2pm}}` diff --git a/pages.zh/common/git-contrib.md b/pages.zh/common/git-contrib.md new file mode 100644 index 0000000000..7a86ca0e2e --- /dev/null +++ b/pages.zh/common/git-contrib.md @@ -0,0 +1,9 @@ +# git contrib + +> 显示指定作者的提交记录。 +> 属于 `git-extras` 一部分。 +> 更多信息：. + +- 显示指定作者的所有提交哈希及对应提交信息： + +`git contrib {{作者名}}` diff --git a/pages.zh/common/git-create-branch.md b/pages.zh/common/git-create-branch.md new file mode 100644 index 0000000000..ae29871503 --- /dev/null +++ b/pages.zh/common/git-create-branch.md @@ -0,0 +1,17 @@ +# git create-branch + +> 在 Git 仓库中创建分支。 +> 属于 `git-extras` 一部分。 +> 更多信息：. + +- ​​创建本地分支​​： + +`git create-branch {{分支名}}` + +- ​​创建本地分支并推送到 origin 远程​​： + +`git create-branch --remote {{分支名}}` + +- ​​创建本地分支并推送到 upstream 远程（常用于 fork 的工作流）​​： + +`git create-branch --remote upstream {{分支名}}` diff --git a/pages.zh/common/git-credential-cache.md b/pages.zh/common/git-credential-cache.md new file mode 100644 index 0000000000..b2729c8aff --- /dev/null +++ b/pages.zh/common/git-credential-cache.md @@ -0,0 +1,8 @@ +# git credential-cache + +> Git 凭证缓存助手，用于在内存中临时存储密码。 +> 更多信息：. + +- Git 凭证缓存助手，用于在内存中临时存储密码。 + +`git config credential.helper 'cache --timeout={{秒数}}'` diff --git a/pages.zh/common/git-credential-store.md b/pages.zh/common/git-credential-store.md new file mode 100644 index 0000000000..a4e2ee21e4 --- /dev/null +++ b/pages.zh/common/git-credential-store.md @@ -0,0 +1,8 @@ +# git credential-store + +> Git 凭证存储助手，用于将密码存储在磁盘上。 +> 更多信息：. + +- ​​指定凭证存储文件路径​​： + +`git config credential.helper 'store --file={{路径/到/文件}}'` diff --git a/pages.zh/common/git-credential.md b/pages.zh/common/git-credential.md new file mode 100644 index 0000000000..91e7b858c0 --- /dev/null +++ b/pages.zh/common/git-credential.md @@ -0,0 +1,16 @@ +# git credential + +> 用于管理和存储 Git 用户凭证（如用户名和密码）。 +> 更多信息：. + +- ​​获取凭证信息​​（从配置文件中读取用户名和密码）： + +`echo "{{url=http://example.com}}" | git credential fill` + +- 存储凭证信息​​（保存到配置的凭证助手中）： + +`echo "{{url=http://example.com}}" | git credential approve` + +- 删除凭证信息​​（从所有配置的凭证助手中清除）： + +`echo "{{url=http://example.com}}" | git credential reject` diff --git a/pages.zh/common/glances.md b/pages.zh/common/glances.md index 14122cfe56..e223254b4f 100644 --- a/pages.zh/common/glances.md +++ b/pages.zh/common/glances.md @@ -3,22 +3,30 @@ > 一个跨平台的系统监控工具。 > 更多信息：. -- 启动 glances，实时显示系统状态： +- 在终端中运行 `glances` -- 以网页服务器模式启动，在浏览器中查看监控数据： +- 以网页服务器模式运行，在浏览器中查看结果： -`glances -w` +`glances {{[-w|--webserver]}}` - 以服务器模式启动，允许其他 glances 客户端连接以查看数据： -`glances -s` +`glances {{[-s|--server]}}` - 作为客户端连接到 glances 服务器： -`glances -c {{主机名或IP地址}}` +`glances {{[-c|--client]}} {{主机名}}` - 在（网页）服务器模式下启用密码保护： -`glances -s --password` +`glances {{[-s|--server]}} --password` + +- 退出Glances： + +`` + +- 显示帮助信息： + +`glances {{[-h|--help]}}` diff --git a/pages.zh/common/hostname.md b/pages.zh/common/hostname.md index fab93f370f..94a61c25fa 100644 --- a/pages.zh/common/hostname.md +++ b/pages.zh/common/hostname.md @@ -9,15 +9,11 @@ - 显示主机名的网络地址： -`hostname -i` - -- 显示主机的所有网络地址： - -`hostname -I` +`hostname {{[-i|--ip-addresses]}}` - 显示 FQDN（完全限定域名）： -`hostname --fqdn` +`hostname {{[-f|--fqdn]}}` - 设置本机主机名： diff --git a/pages.zh/common/logger.md b/pages.zh/common/logger.md index 912decfd2b..5ac997e27e 100644 --- a/pages.zh/common/logger.md +++ b/pages.zh/common/logger.md @@ -1,24 +1,8 @@ # logger -> 向系统日志增加记录（/var/log/syslog）。 -> 更多信息：. +> 向系统日志增加记录。 +> 更多信息：. - 向系统日志增加记录： `logger {{消息内容}}` - -- 从 `stdin` 获取输入并记录到系统日志 syslog： - -`echo {{记录内容}} | logger` - -- 将输出发送到在给定端口上运行的远程系统日志服务器。默认端口为 514： - -`echo {{记录内容}} | logger --server {{服务器名}} --port {{端口}}` - -- 对记录的每一行使用特定的标签。默认值是登录用户的名： - -`echo {{记录内容}} | logger --tag {{标签}}` - -- 以给定的错误等级记录消息。默认是 `user.notice`. 使用 `man logger` 查询所有可选等级： - -`echo {{记录内容}} | logger --priority {{user.warning}}` diff --git a/pages.zh/common/pushd.md b/pages.zh/common/pushd.md index f5726c8868..a047fc6eb1 100644 --- a/pages.zh/common/pushd.md +++ b/pages.zh/common/pushd.md @@ -2,7 +2,7 @@ > 将目录放在堆栈上，以便以后访问。 > 另见 `popd` 切换回原始目录和 `dirs` 显示目录堆栈内容。 -> 更多信息：. +> 更多信息：. - 切换到目录并将其添加到堆栈上： diff --git a/pages.zh/common/ulimit.md b/pages.zh/common/ulimit.md index 1a2768895b..783fa33c66 100644 --- a/pages.zh/common/ulimit.md +++ b/pages.zh/common/ulimit.md @@ -18,3 +18,7 @@ - 设置每个用户的最大进程限制： `ulimit -u 30` + +- 显示帮助信息： + +`help ulimit` diff --git a/pages.zh/common/w.md b/pages.zh/common/w.md index b9731ac220..6a4c4da9ef 100644 --- a/pages.zh/common/w.md +++ b/pages.zh/common/w.md @@ -1,13 +1,20 @@ # w -> 显示有哪些用户登录了本机以及他们当前的活动。 -> 打印用户登录，TTY, 远程主机，登录时间，闲置时间，当前进程。 +> 显示已登录用户及其进程信息。 > 更多信息：. -- 获取已登录用户信息： +- 显示所有当前已登录用户的信息： `w` -- 无标题栏模式： +- 显示指定用户的信息： -`w -h` +`w {{用户名}}` + +- 显示已登录用户信息，但不显示标题行： + +`w {{[-h|--no-header]}}` + +- 显示信息时不包含登录时间、JCPU 和 PCPU 列： + +`w {{[-s|--short]}}` diff --git a/pages.zh/common/whereis.md b/pages.zh/common/whereis.md deleted file mode 100644 index 6378f4b937..0000000000 --- a/pages.zh/common/whereis.md +++ /dev/null @@ -1,28 +0,0 @@ -# whereis - -> 找到命令的二进制文件、源文件和手册文件。 -> 更多信息：. - -- 找到 SSH 命令的二进制、源文件和手册页： - -`whereis {{ssh}}` - -- 查找 `ls` 命令的二进制和手册页： - -`whereis -bm {{ls}}` - -- 找到 `gcc` 的源文件和 `git` 的手册页： - -`whereis -s {{gcc}} -m {{git}}` - -- 仅在 /usr/bin/ 目录中查找 `gcc` 的二进制文件： - -`whereis -b -B {{/usr/bin/}} -f {{gcc}}` - -- 查找不寻常的二进制文件（系统上有多个或少于一个二进制文件的二进制文件）： - -`whereis -u *` - -- 查找有不寻常手册条目的二进制文件（安装了多个或少于一个手册的二进制文件）： - -`whereis -u -m *` diff --git a/pages.zh/linux/archlinux-java.md b/pages.zh/linux/archlinux-java.md index 0e5ca733e8..131a5ee609 100644 --- a/pages.zh/linux/archlinux-java.md +++ b/pages.zh/linux/archlinux-java.md @@ -7,9 +7,13 @@ `archlinux-java status` +- 返回当前默认 Java 环境的简称： + +`archlinux-java get` + - 设置默认的 Java 环境： -`archlinux-java set {{java_environment}}` +`archlinux-java set {{java环境}}` - 取消默认的 Java 环境： diff --git a/pages.zh/linux/arecord.md b/pages.zh/linux/arecord.md index 96761326b2..4410cad4cd 100644 --- a/pages.zh/linux/arecord.md +++ b/pages.zh/linux/arecord.md @@ -22,3 +22,7 @@ - 允许交互式界面（例如使用``或``播放或暂停）： `arecord --interactive` + +- 通过录制 5 秒音频样本并回放来测试麦克风： + +`arecord -d 5 test-mic.wav && aplay test-mic.wav && rm test-mic.wav` diff --git a/pages.zh/linux/cp.md b/pages.zh/linux/cp.md deleted file mode 100644 index 4a006b8ebc..0000000000 --- a/pages.zh/linux/cp.md +++ /dev/null @@ -1,32 +0,0 @@ -# cp - -> 复制文件和目录。 -> 更多信息：. - -- 复制一个文件到另外一个地方： - -`cp {{文件的原始路径}} {{文件的目标路径}}` - -- 复制一个文件到另外一个目录, 保持文件名不变： - -`cp {{文件的原始路径}} {{目标目录路径}}` - -- 递归的复制一个目录内的内容到另外一个地方（如果目标目录存在，目录被复制到目标目标内部）： - -`cp {{[-r|--recursive]}} {{目录的原始路径}} {{目标目录路径}}` - -- 以详细模式递归的复制一个目录 (当文件被复制的时候显示)： - -`cp {{[-vr|--verbose --recursive]}} {{文件的原始路径}} {{目标目录路径}}` - -- 以交互模式复制文本文件到另外一个地方（在覆盖之前提示用户）： - -`cp {{[-i|--interactive]}} {{*.txt}} {{目标目录路径}}` - -- 跟踪软连接复制： - -`cp {{[-L|--dereference]}} {{链接}} {{目标目录路径}}` - -- 使用原始文件的全路径，在复制的时候目录不存在则离开创建： - -`cp --parents {{文件的原始路径}} {{文件的目标路径}}` diff --git a/pages.zh/linux/iostat.md b/pages.zh/linux/iostat.md new file mode 100644 index 0000000000..1b44d5c39f --- /dev/null +++ b/pages.zh/linux/iostat.md @@ -0,0 +1,28 @@ +# iostat + +> 报告设备和分区的统计信息。 +> 更多信息：. + +- 显示系统启动以来的CPU和磁盘统计报告： + +`iostat` + +- 以MB为单位显示CPU和磁盘统计报告： + +`iostat -m` + +- 显示CPU统计信息： + +`iostat {{[-c|--compact]}}` + +- 显示包含磁盘名称（含LVM）的磁盘统计信息： + +`iostat -N` + +- 显示设备"sda"的扩展磁盘统计信息（包含磁盘名称）： + +`iostat -xN {{sda}}` + +- 每2秒显示一次CPU和磁盘的增量统计报告： + +`iostat {{2}}` diff --git a/pages.zh/linux/iptables.md b/pages.zh/linux/iptables.md index 1670154717..2f7682e9c1 100644 --- a/pages.zh/linux/iptables.md +++ b/pages.zh/linux/iptables.md @@ -1,6 +1,7 @@ # iptables > 可用于配置 Linux 内核防火墙提供的过滤表、规则链和规则的程序。 +> 使用 `ip6tables` 来设置 IPv6 流量规则。另见：`iptables-save`、`iptables-restore`。 > 更多信息：. - 查看过滤表的规则链、规则以及数据包/字节计数器： @@ -19,14 +20,10 @@ `sudo iptables {{[-A|--append]}} {{规则链}} {{[-s|--source]}} {{ip}} {{[-p|--protocol]}} {{协议}} --dport {{端口}} {{[-j|--jump]}} {{规则}}` +- 添加 NAT 规则，将来自 `192.168.0.0/24` 子网的所有流量转换为主机的公共 IP： + +`sudo iptables {{[-t|--table]}} {{nat}} {{[-A|--append]}} {{POSTROUTING}} {{[-s|--source]}} {{192.168.0.0/24}} {{[-j|--jump]}} {{MASQUERADE}}` + - 删除规则链中的规则： `sudo iptables {{[-D|--delete]}} {{规则链}} {{规则所在行号}}` - -- 将指定过滤表的 iptables 配置保存到文件中： - -`sudo iptables-save {{[-t|--table]}} {{过滤表名}} > {{iptables_文件路径}}` - -- 从文件中还原 iptables 配置： - -`sudo iptables-restore < {{iptables_文件路径}}` diff --git a/pages.zh/linux/lsblk.md b/pages.zh/linux/lsblk.md index db383e5aa3..723610a7b4 100644 --- a/pages.zh/linux/lsblk.md +++ b/pages.zh/linux/lsblk.md @@ -19,6 +19,10 @@ `lsblk {{[-f|--fs]}}` +- 使用 ASCII 字符进行树形格式化： + +`lsblk {{[-i|--ascii]}}` + - 输出块设备的拓扑结构： `lsblk {{[-t|--topology]}}` @@ -29,4 +33,4 @@ - 使用逗号分隔的列列表显示自定义摘要： -`lsblk {{[-o|--output]}} {{NAME,SERIAL,MODEL,TRAN,TYPE,SIZE,FSTYPE,MOUNTPOINT,...}}` +`lsblk {{[-o|--output]}} {{名称,序列号,型号,传输方式,类型,大小,文件系统类型,挂载点,...}}` diff --git a/pages.zh/linux/mkfs.vfat.md b/pages.zh/linux/mkfs.vfat.md deleted file mode 100644 index 04ad841fd2..0000000000 --- a/pages.zh/linux/mkfs.vfat.md +++ /dev/null @@ -1,20 +0,0 @@ -# mkfs.vfat - -> 在分区内创建一个 MS-DOS 文件系统。 -> 更多信息：. - -- 在设备 b 的分区 1 内创建一个 vfat 文件系统（`sdb1`）： - -`mkfs.vfat {{/dev/sdb1}}` - -- 创建一个带有卷名的文件系统： - -`mkfs.vfat -n {{volume_name}} {{/dev/sdb1}}` - -- 创建一个带有卷 ID 的文件系统： - -`mkfs.vfat -i {{volume_id}} {{/dev/sdb1}}` - -- 使用 5 个而不是 2 个文件分配表： - -`mkfs.vfat -f 5 {{/dev/sdb1}}` diff --git a/pages.zh/linux/poweroff.md b/pages.zh/linux/poweroff.md index b4663067fa..4c9f7aa4fa 100644 --- a/pages.zh/linux/poweroff.md +++ b/pages.zh/linux/poweroff.md @@ -5,4 +5,20 @@ - 关闭系统电源： -`sudo poweroff` +`poweroff` + +- 停止系统（等同于 `halt`）： + +`poweroff --halt` + +- 重启系统（等同于 `reboot`）： + +`poweroff --reboot` + +- 立即关机，不联系系统管理器： + +`poweroff {{[-f|--force]}}` + +- 仅写入 wtmp 关机日志条目而不关闭系统： + +`poweroff {{[-w|--wtmp-only]}}` diff --git a/pages.zh/linux/reboot.md b/pages.zh/linux/reboot.md index 5204c441d0..065575f2ef 100644 --- a/pages.zh/linux/reboot.md +++ b/pages.zh/linux/reboot.md @@ -3,10 +3,22 @@ > 重新启动系统。 > 更多信息：. -- 立即重新启动： +- 重启系统： `reboot` +- 关闭系统（等同于 `poweroff`）： + +`reboot {{[-p|--poweroff]}}` + +- 停止系统（终止所有进程并关闭 CPU，等同于 `halt`）： + +`reboot --halt` + - 立即重启，而无需正常关闭： `reboot {{[-f|--force]}}` + +- 仅写入 wtmp 关机日志条目而不重启系统： + +`reboot {{[-w|--wtmp-only]}}` diff --git a/pages.zh/linux/w.md b/pages.zh/linux/w.md deleted file mode 100644 index 358b999d97..0000000000 --- a/pages.zh/linux/w.md +++ /dev/null @@ -1,20 +0,0 @@ -# w - -> 显示登录者及其进程。 -> 更多信息：. - -- 显示当前登录的所有用户的信息： - -`w` - -- 显示有关特定用户的信息： - -`w {{用户}}` - -- 显示信息而不包括标题： - -`w --no-header` - -- 显示信息不包括登录、JCPU 和 PCPU 列： - -`w --short` diff --git a/pages.zh/osx/date.md b/pages.zh/osx/date.md index b3c86996da..edae9a96e5 100644 --- a/pages.zh/osx/date.md +++ b/pages.zh/osx/date.md @@ -18,3 +18,7 @@ - 使用默认格式显示特定日期（格式化指定 UNIX 时间戳）： `date -r {{1473305798}}` + +- 使用默认格式显示相对于当前日期的日期： + +`date -v {{+1d}} -v {{-20m}}` diff --git a/pages.zh/osx/iostat.md b/pages.zh/osx/iostat.md new file mode 100644 index 0000000000..0a4f985acf --- /dev/null +++ b/pages.zh/osx/iostat.md @@ -0,0 +1,32 @@ +# iostat + +> 报告设备统计信息。 +> 更多信息：. + +- 显示设备统计快照（每传输千字节数、每秒传输次数、每秒兆字节数）、CPU统计（用户模式、系统模式和空闲模式的时间百分比）以及系统负载平均值（过去1、5和15分钟）： + +`iostat` + +- 仅显示设备统计信息： + +`iostat -d` + +- 每2秒显示一次CPU和磁盘的增量统计报告： + +`iostat 2` + +- 无限期每秒显示第一个磁盘的统计信息： + +`iostat -w 1 disk0` + +- 每3秒显示一次第二个磁盘的统计信息，共显示10次： + +`iostat -w 3 -c 10 disk1` + +- 使用旧式iostat显示格式。显示每秒传输的扇区数、每秒传输次数、每次传输的平均毫秒数，以及默认显示格式的CPU统计和负载平均值： + +`iostat -o` + +- 显示设备总统计信息（KB/t：每次传输的千字节数，xfrs：总传输次数，MB：总传输兆字节数）： + +`iostat -I` diff --git a/pages.zh/osx/open.md b/pages.zh/osx/open.md index 6c037ec3a8..5535070dfc 100644 --- a/pages.zh/osx/open.md +++ b/pages.zh/osx/open.md @@ -5,15 +5,15 @@ - 使用系统关联的应用程序打开文件： -`open {{filename.extension}}` +`open {{文件名.扩展名}}` - 运行图形化的 macOS 应用程序： -`open -a {{应用程序名}}` +`open -a "{{应用程序名}}"` -- 运行指定 包名 的图形化 macOS 应用程序（请参阅`OSascript`命令，查询如何获取应用程序的 包名）： +- 运行指定包标识符的图形化 macOS 应用程序（请参阅`OSascript`命令，查询如何获取应用程序的包标识符）： -`open -b {{com.domain.application 应用程序包名}}` +`open -b {{com.domain.application}}` - 在"访达（finder）"中打开当前文件夹： @@ -21,8 +21,12 @@ - 打开"访达（finder）", 并且给出指定文件： -`open -R {{文件路径}}` +`open -R {{路径/到/文件}}` - 使用系统默认应用程序，打开当前目录中所有给定扩展名的文件： -`open {{*.extension}}` +`open {{*.扩展名}}` + +- 通过包标识符打开应用程序的新实例： + +`open -n -b {{com.domain.application}}` diff --git a/pages.zh_TW/linux/cp.md b/pages.zh_TW/linux/cp.md deleted file mode 100644 index 9cbb60ff79..0000000000 --- a/pages.zh_TW/linux/cp.md +++ /dev/null @@ -1,32 +0,0 @@ -# cp - -> 複製檔案與資料夾。 -> 更多資訊：. - -- 複製一個檔案到新位置，並重新命名： - -`cp {{檔案/完整/檔案.副檔名}} {{檔案/完整/新檔案.副檔名}}` - -- 複製一個檔案到目錄內，但保留檔案名稱： - -`cp {{檔案/完整/檔案.副檔名}} {{目錄/完整/路徑}}` - -- 遞迴的複製目錄的所有內容到新位置（若目標路徑已存在，將複製到該目錄的內部）： - -`cp {{[-r|--recursive]}} {{目錄/完整/路徑}} {{目錄/完整/目標路徑}}` - -- 遞迴的複製目錄的所有內容到新位置，並透過 `-v` 參數在複製過程中顯示被複製的內容： - -`cp {{[-vr|--verbose --recursive]}} {{目錄/完整/路徑}} {{目錄/完整/目標路徑}}` - -- 透過「互動模式」複製文字檔到新位置（當新位置有相同名稱的檔案時，需要先經過使用者的同意，方能複製到新位置）： - -`cp {{[-i|--interactive]}} {{*.txt}} {{目錄/完整/目標路徑}}` - -- 複製檔案或「捷徑」指向的「真實」檔案或資料夾： - -`cp {{[-L|--dereference]}} {{捷徑}} {{目錄/完整/目標路徑}}` - -- 使用完整的檔案路徑與檔案名稱，來創建跟原本目錄結構相同的目錄與檔案： - -`cp --parents {{檔案/完整/路徑}} {{檔案/完整/路徑}}` diff --git a/pages/common/a2ping.md b/pages/common/a2ping.md index 9509108838..83379102ae 100644 --- a/pages/common/a2ping.md +++ b/pages/common/a2ping.md @@ -29,4 +29,4 @@ - Display help: -`a2ping -h` +`a2ping {{[-h|--help]}}` diff --git a/pages/common/ack.md b/pages/common/ack.md index a58bba6e6e..b1e94ec47d 100644 --- a/pages/common/ack.md +++ b/pages/common/ack.md @@ -10,27 +10,27 @@ - Search for a case-insensitive pattern: -`ack --ignore-case "{{search_pattern}}"` +`ack {{[-i|--ignore-case]}} "{{search_pattern}}"` -- Search for lines matching a pattern, printing [o]nly the matched text and not the rest of the line: +- Search for lines matching a pattern, printing only the matched text and not the rest of the line: -`ack -o "{{search_pattern}}"` +`ack {{[-o|--output='$&']}} "{{search_pattern}}"` - Limit search to files of a specific type: -`ack --type {{ruby}} "{{search_pattern}}"` +`ack {{[-t|--type]}} {{ruby}} "{{search_pattern}}"` - Do not search in files of a specific type: -`ack --type no{{ruby}} "{{search_pattern}}"` +`ack {{[-t|--type]}} no{{ruby}} "{{search_pattern}}"` - Count the total number of matches found: -`ack --count --no-filename "{{search_pattern}}"` +`ack {{[-c|--count]}} {{[-h|--no-filename]}} "{{search_pattern}}"` - Print the file names and the number of matches for each file only: -`ack --count --files-with-matches "{{search_pattern}}"` +`ack {{[-c|--count]}} {{[-l|--files-with-matches]}} "{{search_pattern}}"` - List all the values that can be used with `--type`: diff --git a/pages/common/acme.sh.md b/pages/common/acme.sh.md index 6fa9237167..417630f4d4 100644 --- a/pages/common/acme.sh.md +++ b/pages/common/acme.sh.md @@ -6,28 +6,28 @@ - Issue a certificate using webroot mode: -`acme.sh --issue --domain {{example.com}} --webroot {{/path/to/webroot}}` +`acme.sh --issue {{[-d|--domain]}} {{example.com}} {{[-w|--webroot]}} {{/path/to/webroot}}` - Issue a certificate for multiple domains using standalone mode using port 80: -`acme.sh --issue --standalone --domain {{example.com}} --domain {{www.example.com}}` +`acme.sh --issue --standalone {{[-d|--domain]}} {{example.com}} {{[-d|--domain]}} {{www.example.com}}` - Issue a certificate using standalone TLS mode using port 443: -`acme.sh --issue --alpn --domain {{example.com}}` +`acme.sh --issue --alpn {{[-d|--domain]}} {{example.com}}` - Issue a certificate using a working Nginx configuration: -`acme.sh --issue --nginx --domain {{example.com}}` +`acme.sh --issue --nginx {{[-d|--domain]}} {{example.com}}` - Issue a certificate using a working Apache configuration: -`acme.sh --issue --apache --domain {{example.com}}` +`acme.sh --issue --apache {{[-d|--domain]}} {{example.com}}` - Issue a wildcard (\*) certificate using an automatic DNS API mode: -`acme.sh --issue --dns {{dns_cf}} --domain {{*.example.com}}` +`acme.sh --issue --dns {{dns_cf}} {{[-d|--domain]}} {{*.example.com}}` - Install certificate files into the specified locations (useful for automatic certificate renewal): -`acme.sh --install-cert -d {{example.com}} --key-file {{/path/to/example.com.key}} --fullchain-file {{/path/to/example.com.cer}} --reloadcmd "{{systemctl force-reload nginx}}"` +`acme.sh {{[-i|--install-cert]}} {{[-d|--domain]}} {{example.com}} --key-file {{/path/to/example.com.key}} --fullchain-file {{/path/to/example.com.cer}} --reloadcmd "{{systemctl force-reload nginx}}"` diff --git a/pages/common/ag.md b/pages/common/ag.md index ae06d3c5eb..eb7db8a61d 100644 --- a/pages/common/ag.md +++ b/pages/common/ag.md @@ -5,23 +5,23 @@ - Find files containing "foo", and print the line matches in context: -`ag {{foo}}` +`ag foo` - Find files containing "foo" in a specific directory: -`ag {{foo}} {{path/to/directory}}` +`ag foo {{path/to/directory}}` - Find files containing "foo", but only list the filenames: -`ag {{[-l|--files-with-matches]}} {{foo}}` +`ag {{[-l|--files-with-matches]}} foo` - Find files containing "FOO" case-insensitively, and print only the match, rather than the whole line: -`ag {{[-i|--ignore-case]}} {{[-o|--only-matching]}} {{FOO}}` +`ag {{[-i|--ignore-case]}} {{[-o|--only-matching]}} FOO` - Find "foo" in files with a name matching "bar": -`ag {{foo}} {{[-G|--file-search-regex]}} {{bar}}` +`ag foo {{[-G|--file-search-regex]}} bar` - Find files whose contents match a regular expression: @@ -29,4 +29,4 @@ - Find files with a name matching "foo": -`ag {{[-g|--filename-pattern]}} {{foo}}` +`ag {{[-g|--filename-pattern]}} foo` diff --git a/pages/common/agate.md b/pages/common/agate.md index 230a25fb19..412f994038 100644 --- a/pages/common/agate.md +++ b/pages/common/agate.md @@ -13,4 +13,4 @@ - Display help: -`agate -h` +`agate {{[-h|--help]}}` diff --git a/pages/common/ani-cli.md b/pages/common/ani-cli.md index 20fecce701..8ad298c454 100644 --- a/pages/common/ani-cli.md +++ b/pages/common/ani-cli.md @@ -7,7 +7,7 @@ `ani-cli "{{anime_name}}"` -- Download episode: +- Download an episode: `ani-cli {{[-d|--download]}} "{{anime_name}}"` diff --git a/pages/common/ansible-doc.md b/pages/common/ansible-doc.md index babc8dc305..2425f78303 100644 --- a/pages/common/ansible-doc.md +++ b/pages/common/ansible-doc.md @@ -6,11 +6,11 @@ - List available action plugins (modules): -`ansible-doc --list` +`ansible-doc {{[-l|--list]}}` - List available plugins of a specific type: -`ansible-doc --type {{become|cache|callback|cliconf|connection|...}} --list` +`ansible-doc {{[-t|--type]}} {{become|cache|callback|cliconf|connection|...}} {{[-l|--list]}}` - Show information about a specific action plugin (module): @@ -18,12 +18,12 @@ - Show information about a plugin with a specific type: -`ansible-doc --type {{become|cache|callback|cliconf|connection|...}} {{plugin_name}}` +`ansible-doc {{[-t|--type]}} {{become|cache|callback|cliconf|connection|...}} {{plugin_name}}` - Show the playbook snippet for action plugin (modules): -`ansible-doc --snippet {{plugin_name}}` +`ansible-doc {{[-s|--snippet]}} {{plugin_name}}` - Show information about an action plugin (module) as JSON: -`ansible-doc --json {{plugin_name}}` +`ansible-doc {{[-j|--json]}} {{plugin_name}}` diff --git a/pages/common/ansible-inventory.md b/pages/common/ansible-inventory.md index d808ace421..9c9719ecf2 100644 --- a/pages/common/ansible-inventory.md +++ b/pages/common/ansible-inventory.md @@ -10,11 +10,11 @@ - Display a custom inventory: -`ansible-inventory --list --inventory {{path/to/file_or_script_or_directory}}` +`ansible-inventory --list {{[-i|--inventory-file]}} {{path/to/file_or_script_or_directory}}` - Display the default inventory in YAML: -`ansible-inventory --list --yaml` +`ansible-inventory --list {{[-y|--yaml]}}` - Dump the default inventory to a file: diff --git a/pages/common/ansible-lint.md b/pages/common/ansible-lint.md new file mode 100644 index 0000000000..e0c6a7e0bb --- /dev/null +++ b/pages/common/ansible-lint.md @@ -0,0 +1,24 @@ +# ansible-lint + +> Apply rules and follow best practices with your automation content. +> More information: . + +- Lint a specific playbook and a role directory: + +`ansible-lint {{path/to/playbook_file}} {{path/to/role_directory}}` + +- Lint a playbook while excluding specific rules: + +`ansible-lint {{[-x|--exclude-rules]}} {{rule1,rule2,...}} {{path/to/playbook_file}}` + +- Lint a playbook in offline mode and format output as PEP8: + +`ansible-lint {{[-o|--offline]}} {{[-p|--parseable]}} {{path/to/playbook_file}}` + +- Lint a playbook using a custom rules directory: + +`ansible-lint {{[-r|--rules]}} {{path/to/custom_rules_directory}} {{path/to/playbook_file}}` + +- Lint all Ansible content recursively in a given directory: + +`ansible-lint {{path/to/project_directory}}` diff --git a/pages/common/ansible-pull.md b/pages/common/ansible-pull.md index 822ecfeb1f..716c7c4f69 100644 --- a/pages/common/ansible-pull.md +++ b/pages/common/ansible-pull.md @@ -5,16 +5,16 @@ - Pull a playbook from a VCS and execute a default local.yml playbook: -`ansible-pull -U {{repository_url}}` +`ansible-pull {{[-U|--url]}} {{repository_url}}` - Pull a playbook from a VCS and execute a specific playbook: -`ansible-pull -U {{repository_url}} {{playbook}}` +`ansible-pull {{[-U|--url]}} {{repository_url}} {{playbook}}` - Pull a playbook from a VCS at a specific branch and execute a specific playbook: -`ansible-pull -U {{repository_url}} -C {{branch}} {{playbook}}` +`ansible-pull {{[-U|--url]}} {{repository_url}} {{[-C|--checkout]}} {{branch}} {{playbook}}` - Pull a playbook from a VCS, specify hosts file and execute a specific playbook: -`ansible-pull -U {{repository_url}} -i {{hosts_file}} {{playbook}}` +`ansible-pull {{[-U|--url]}} {{repository_url}} {{[-i|--inventory-file]}} {{hosts_file}} {{playbook}}` diff --git a/pages/common/ansible.md b/pages/common/ansible.md index 70faa56385..e73b31b2f7 100644 --- a/pages/common/ansible.md +++ b/pages/common/ansible.md @@ -12,7 +12,7 @@ `ansible {{group}} {{[-m|--module-name]}} ping` -- Display facts about a group of hosts by invoking the setup [m]odule: +- Display facts about a group of hosts by invoking the setup module: `ansible {{group}} {{[-m|--module-name]}} setup` diff --git a/pages/common/asciidoctor.md b/pages/common/asciidoctor.md index 8c1b46d6d3..acb32a550d 100644 --- a/pages/common/asciidoctor.md +++ b/pages/common/asciidoctor.md @@ -9,12 +9,12 @@ - Convert a specific `.adoc` file to HTML and link a CSS stylesheet: -`asciidoctor -a stylesheet {{path/to/stylesheet.css}} {{path/to/file.adoc}}` +`asciidoctor {{[-a|--attribute]}} stylesheet {{path/to/stylesheet.css}} {{path/to/file.adoc}}` - Convert a specific `.adoc` file to embeddable HTML, removing everything except the body: -`asciidoctor --embedded {{path/to/file.adoc}}` +`asciidoctor {{[-e|--embedded]}} {{path/to/file.adoc}}` - Convert a specific `.adoc` file to a PDF using the `asciidoctor-pdf` library: -`asciidoctor --backend {{pdf}} --require {{asciidoctor-pdf}} {{path/to/file.adoc}}` +`asciidoctor {{[-b|--backend]}} {{pdf}} {{[-r|--require ]}}{{asciidoctor-pdf}} {{path/to/file.adoc}}` diff --git a/pages/common/asciinema.md b/pages/common/asciinema.md index dfccbf9d3c..00bfb73cc9 100644 --- a/pages/common/asciinema.md +++ b/pages/common/asciinema.md @@ -8,11 +8,7 @@ `asciinema auth` -- Make a new recording (finish it with `` or type `exit`): - -`asciinema rec {{path/to/file.cast}}` - -- Make a new recording and save it to a local file: +- Make a new recording and save it to a local file (finish it with `` or type `exit`): `asciinema rec {{path/to/recording.cast}}` diff --git a/pages/common/autojump.md b/pages/common/autojump.md index dcb1af9a22..5d7691c7d2 100644 --- a/pages/common/autojump.md +++ b/pages/common/autojump.md @@ -22,4 +22,4 @@ - Show the entries in the autojump database: -`j -s` +`j {{[-s|--stat]}}` diff --git a/pages/common/az-lock.md b/pages/common/az-lock.md index 893f00a938..5ce3a1b263 100644 --- a/pages/common/az-lock.md +++ b/pages/common/az-lock.md @@ -24,6 +24,6 @@ `az lock list` -- Show a subscription level lock with a specific [n]ame: +- Show a subscription level lock with a specific name: `az lock show {{[-n|--name]}} {{lock_name}}` diff --git a/pages/common/az-storage-blob.md b/pages/common/az-storage-blob.md index 9c82005cc7..c277e00b79 100644 --- a/pages/common/az-storage-blob.md +++ b/pages/common/az-storage-blob.md @@ -8,7 +8,7 @@ `az storage blob download --account-name {{storage_account_name}} --account-key {{storage_account_key}} {{[-c|--container-name]}} {{container_name}} {{[-n|--name]}} {{path/to/blob}} {{[-f|--file]}} {{path/to/local_file}}` -- [d]ownload blobs from a blob container recursively: +- Download blobs from a blob container recursively: `az storage blob download-batch --account-name {{storage_account_name}} --account-key {{storage_account_key}} {{[-s|--source]}} {{container_name}} {{[-d|--destination]}} {{path/to/remote}} --pattern {{filename_regex}} {{[-d|--destination]}} {{path/to/destination}}` diff --git a/pages/common/bashmarks.md b/pages/common/bashmarks.md index ca16fde0af..1817007808 100644 --- a/pages/common/bashmarks.md +++ b/pages/common/bashmarks.md @@ -3,6 +3,10 @@ > Save and jump to commonly used directories using 1 character commands. > More information: . +- Add the bashmark aliases to your shell: + +`source /usr/share/bashmarks/bashmarks.sh` + - List available bookmarks: `l` diff --git a/pages/common/box.md b/pages/common/box.md index ac7cc9d82f..1d8c7f2fb5 100644 --- a/pages/common/box.md +++ b/pages/common/box.md @@ -7,9 +7,9 @@ `box compile` -- Compile a new Phar file using a specific [c]onfiguration file: +- Compile a new Phar file using a specific configuration file: -`box compile -c {{path/to/config}}` +`box compile {{[-c|--config]}} {{path/to/config}}` - Display information about the PHAR PHP extension: diff --git a/pages/common/brew-bundle.md b/pages/common/brew-bundle.md index bebbfa5945..43539a7422 100644 --- a/pages/common/brew-bundle.md +++ b/pages/common/brew-bundle.md @@ -1,7 +1,7 @@ # brew bundle > Bundler for Homebrew, Homebrew Cask and the Mac App Store. -> More information: . +> More information: . - Install packages from a Brewfile at the current path: diff --git a/pages/common/buku.md b/pages/common/buku.md index 22f2eed236..f56df09824 100644 --- a/pages/common/buku.md +++ b/pages/common/buku.md @@ -1,24 +1,24 @@ # buku > Command-line browser-independent bookmark manager. -> More information: . +> More information: . - Display all bookmarks matching "keyword" and with "privacy" tag: -`buku {{keyword}} --stag {{privacy}}` +`buku {{keyword}} {{[-t|--stag]}} {{privacy}}` - Add bookmark with tags "search engine" and "privacy": -`buku --add {{https://example.com}} {{search engine}}, {{privacy}}` +`buku {{[-a|--add]}} {{https://example.com}} {{search engine}}, {{privacy}}` - Delete a bookmark: -`buku --delete {{bookmark_id}}` +`buku {{[-d|--delete]}} {{bookmark_id}}` - Open editor to edit a bookmark: -`buku --write {{bookmark_id}}` +`buku {{[-w|--write]}} {{bookmark_id}}` - Remove "search engine" tag from a bookmark: -`buku --update {{bookmark_id}} --tag {{-}} {{search engine}}` +`buku {{[-u|--update]}} {{bookmark_id}} --tag - {{search engine}}` diff --git a/pages/common/bzip3.md b/pages/common/bzip3.md index aa66b81daf..9042925e46 100644 --- a/pages/common/bzip3.md +++ b/pages/common/bzip3.md @@ -11,7 +11,7 @@ `bzip3 {{[-d|--decode]}} {{path/to/compressed_file.bz3}}` -- Decompress a file to `stdout` ([c]): +- Decompress a file to `stdout`: `bzip3 {{[-dc|--decode --stdout]}} {{path/to/compressed_file.bz3}}` diff --git a/pages/common/cbonsai.md b/pages/common/cbonsai.md index 4342999b11..fc9ed97988 100644 --- a/pages/common/cbonsai.md +++ b/pages/common/cbonsai.md @@ -5,20 +5,20 @@ - Generate a bonsai in live mode: -`cbonsai -l` +`cbonsai {{[-l|--live]}}` - Generate a bonsai in infinite mode: -`cbonsai -i` +`cbonsai {{[-i|--infinite]}}` - Append a message to the bonsai: -`cbonsai -m "{{message}}"` +`cbonsai {{[-m|--message]}} "{{message}}"` - Display extra information about the bonsai: -`cbonsai -v` +`cbonsai {{[-v|--verbose]}}` - Display help: -`cbonsai -h` +`cbonsai {{[-h|--help]}}` diff --git a/pages/common/charm.md b/pages/common/charm.md index 9cc074fd00..d6009aeaa4 100644 --- a/pages/common/charm.md +++ b/pages/common/charm.md @@ -9,7 +9,7 @@ - Backup Charm account keys to a specific location: -`charm backup-keys -o {{path/to/output_file.tar}}` +`charm backup-keys {{[-o|--output]}} {{path/to/output_file.tar}}` - Import previously backed up Charm account keys: diff --git a/pages/common/chars.md b/pages/common/chars.md index 0d5b8e9a0f..1420acc13d 100644 --- a/pages/common/chars.md +++ b/pages/common/chars.md @@ -1,7 +1,7 @@ # chars > Display names and codes for various ASCII and Unicode characters and code points. -> More information: . +> More information: . - Look up a character by its value: diff --git a/pages/common/cheat.md b/pages/common/cheat.md index 9096053e4f..fe3d9592eb 100644 --- a/pages/common/cheat.md +++ b/pages/common/cheat.md @@ -9,16 +9,16 @@ - Edit the cheat sheet for a command: -`cheat -e {{command}}` +`cheat {{[-e|--edit]}} {{command}}` - List the available cheat sheets: -`cheat -l` +`cheat {{[-l|--list]}}` - Search available the cheat sheets for a specified command name: -`cheat -s {{command}}` +`cheat {{[-s|--search]}} {{command}}` - Display version: -`cheat -v` +`cheat {{[-v|--version]}}` diff --git a/pages/common/chkfont.md b/pages/common/chkfont.md new file mode 100644 index 0000000000..b862ce5d91 --- /dev/null +++ b/pages/common/chkfont.md @@ -0,0 +1,13 @@ +# chkfont + +> Verify the format of a FIGlet font file (`.flf`). +> See also: `figlet`, `figlist`, `showfigfonts`. +> More information: . + +- Check a font file for formatting errors: + +`chkfont {{path/to/font.flf}}` + +- Check all `.flf` font files in a directory: + +`chkfont {{path/to/fonts}}/*.flf` diff --git a/pages/common/circup.md b/pages/common/circup.md index 2dd807a0e7..70775c567a 100644 --- a/pages/common/circup.md +++ b/pages/common/circup.md @@ -19,6 +19,6 @@ `circup freeze` -- Save all libraries on a connected device in the current directory: +- Save all libraries on a connected device in `requirements.txt` in current directory: -`circup freeze -r` +`circup freeze {{[-r|--requirement]}}` diff --git a/pages/common/clamscan.md b/pages/common/clamscan.md index adeab561b3..fddd261559 100644 --- a/pages/common/clamscan.md +++ b/pages/common/clamscan.md @@ -9,7 +9,7 @@ - Scan all files recursively in a specific directory: -`clamscan -r {{path/to/directory}}` +`clamscan {{[-r|--recursive]}} {{path/to/directory}}` - Scan data from `stdin`: @@ -17,15 +17,15 @@ - Specify a virus database file or directory of files: -`clamscan --database {{path/to/database_file_or_directory}}` +`clamscan {{[-d|--database]}} {{path/to/database_file_or_directory}}` - Scan the current directory and output only infected files: -`clamscan --infected` +`clamscan {{[-i|--infected]}}` - Print the scan report to a log file: -`clamscan --log {{path/to/log_file}}` +`clamscan {{[-l|--log]}} {{path/to/log_file}}` - Move infected files to a specific directory: diff --git a/pages/common/clj.md b/pages/common/clj.md index a160990f37..eeaa1de939 100644 --- a/pages/common/clj.md +++ b/pages/common/clj.md @@ -14,7 +14,7 @@ - Run the main function of a specified namespace: -`clj -M -m {{namespace}} {{args}}` +`clj -M {{[-m|--main]}} {{namespace}} {{args}}` - Prepare a project by resolving dependencies, downloading libraries, and making/caching classpaths: @@ -22,8 +22,8 @@ - Start an nREPL server with the CIDER middleware: -`clj -Sdeps '{:deps {nrepl {:mvn/version "0.7.0"} cider/cider-nrepl {:mvn/version "0.25.2"}}}' -m nrepl.cmdline --middleware '["cider.nrepl/cider-middleware"]' --interactive` +`clj -Sdeps '{:deps {nrepl {:mvn/version "0.7.0"} cider/cider-nrepl {:mvn/version "0.25.2"}}}' {{[-m|--main]}} nrepl.cmdline --middleware '["cider.nrepl/cider-middleware"]' --interactive` - Start a REPL for ClojureScript and open a web browser: -`clj -Sdeps '{:deps {org.clojure/clojurescript {:mvn/version "1.10.758"}}}' --main cljs.main --repl` +`clj -Sdeps '{:deps {org.clojure/clojurescript {:mvn/version "1.10.758"}}}' {{[-m|--main]}} cljs.main {{[-r|--repl]}}` diff --git a/pages/common/conda-create.md b/pages/common/conda-create.md index 229f1f5479..369d0ec277 100644 --- a/pages/common/conda-create.md +++ b/pages/common/conda-create.md @@ -5,12 +5,12 @@ - Create a new environment named `py39`, and install Python 3.9 and NumPy v1.11 or above in it: -`conda create --yes --name {{py39}} python={{3.9}} "{{numpy>=1.11}}"` +`conda create {{[-y|--yes]}} {{[-n|--name]}} {{py39}} python={{3.9}} "{{numpy>=1.11}}"` - Make exact copy of an environment: -`conda create --clone {{py39}} --name {{py39-copy}}` +`conda create --clone {{py39}} {{[-n|--name]}} {{py39-copy}}` - Create a new environment with a specified name and install a given package: -`conda create --name {{env_name}} {{package}}` +`conda create {{[-n|--name]}} {{env_name}} {{package}}` diff --git a/pages/common/conda-install.md b/pages/common/conda-install.md index 9eb5f90cb7..ea56999c6d 100644 --- a/pages/common/conda-install.md +++ b/pages/common/conda-install.md @@ -9,11 +9,11 @@ - Install a single package into the currently active conda environment using channel conda-forge: -`conda install -c conda-forge {{package}}` +`conda install {{[-c|--channel]}} conda-forge {{package}}` - Install a single package into the currently active conda environment using channel conda-forge and ignoring other channels: -`conda install -c conda-forge --override-channels {{package}}` +`conda install {{[-c|--channel]}} conda-forge --override-channels {{package}}` - Install a specific version of a package: @@ -21,7 +21,7 @@ - Install a package into a specific environment: -`conda install --name {{environment}} {{package}}` +`conda install {{[-n|--name]}} {{environment}} {{package}}` - Update a package in the current environment: @@ -29,4 +29,4 @@ - Install a package and agree to the transactions without prompting: -`conda install --yes {{package}}` +`conda install {{[-y|--yes]}} {{package}}` diff --git a/pages/common/conda.md b/pages/common/conda.md index e6cc4dbc7d..1e18129068 100644 --- a/pages/common/conda.md +++ b/pages/common/conda.md @@ -2,15 +2,15 @@ > Package, dependency and environment management for any programming language. > Some subcommands such as `create` have their own usage documentation. -> More information: . +> More information: . - Create a new environment, installing named packages into it: -`conda create --name {{environment_name}} {{python=3.9 matplotlib}}` +`conda create {{[-n|--name]}} {{environment_name}} {{python=3.9 matplotlib}}` - List all environments: -`conda info --envs` +`conda info {{[-e|--envs]}}` - Load an environment: @@ -22,7 +22,7 @@ - Delete an environment (remove all packages): -`conda remove --name {{environment_name}} --all` +`conda remove {{[-n|--name]}} {{environment_name}} --all` - Install packages into the current environment: @@ -34,4 +34,4 @@ - Delete unused packages and caches: -`conda clean --all` +`conda clean {{[-a|--all]}}` diff --git a/pages/common/copr-cli.md b/pages/common/copr-cli.md index 8f60a0d215..786f5cb893 100644 --- a/pages/common/copr-cli.md +++ b/pages/common/copr-cli.md @@ -15,6 +15,6 @@ `copr-cli list-builds {{repository}}` -- Trigger a copr build of a spec-file from public (git) repository: +- Trigger a copr build of a spec-file from public (Git) repository: `copr-cli buildscm {{repository}} --clone-url {{https://git.example.org/repo}} --spec {{spec_file_name}}` diff --git a/pages/common/core-validate-commit.md b/pages/common/core-validate-commit.md index 3d33cfeaa8..43ae720e56 100644 --- a/pages/common/core-validate-commit.md +++ b/pages/common/core-validate-commit.md @@ -17,16 +17,16 @@ - List all validation rules: -`core-validate-commit --list` +`core-validate-commit {{[-l|--list]}}` - List all valid Node.js subsystems: -`core-validate-commit --list-subsystem` +`core-validate-commit {{[-ls|--list-subsystem]}}` - Validate the current commit formatting the output in tap format: -`core-validate-commit --tap` +`core-validate-commit {{[-t|--tap]}}` - Display help: -`core-validate-commit --help` +`core-validate-commit {{[-h|--help]}}` diff --git a/pages/common/coreutils.md b/pages/common/coreutils.md new file mode 100644 index 0000000000..1417201b2a --- /dev/null +++ b/pages/common/coreutils.md @@ -0,0 +1,17 @@ +# coreutils + +> Uutils coreutils is a cross-platform reimplementation of the GNU coreutils in Rust Language. +> Uutils includes a multi-call binary from which the utils can be invoked. This reduces the binary size of the binary and can be useful for portability. +> More information: . + +- Run a utility with arguments: + +`coreutils {{util}} {{util_options}}` + +- List files in [l]ong format: + +`coreutils ls -l` + +- Display help for `ls`: + +`coreutils ls --help` diff --git a/pages/common/cowsay.md b/pages/common/cowsay.md index 11a7081cc2..c8f86d694a 100644 --- a/pages/common/cowsay.md +++ b/pages/common/cowsay.md @@ -1,7 +1,7 @@ # cowsay > Print ASCII art (by default a cow) saying or thinking something. -> More information: . +> More information: . - Print an ASCII cow saying "hello, world": diff --git a/pages/common/crictl.md b/pages/common/crictl.md index 44bb958bd5..6ca0deb7b7 100644 --- a/pages/common/crictl.md +++ b/pages/common/crictl.md @@ -9,7 +9,7 @@ - List all containers (Running and Exited): -`crictl ps --all` +`crictl ps {{[-a|--all]}}` - List all images: @@ -21,15 +21,15 @@ - Open a specific shell inside a running container: -`crictl exec -it {{container_id}} {{sh}}` +`crictl exec {{[-it|--interactive --tty]}} {{container_id}} {{sh}}` - Pull a specific image from a registry: `crictl pull {{image:tag}}` -- Print and [f]ollow logs of a specific container: +- Print and follow logs of a specific container: -`crictl logs -f {{container_id}}` +`crictl logs {{[-f|--follow]}} {{container_id}}` - Remove one or more images: diff --git a/pages/common/cronic.md b/pages/common/cronic.md index 0cfdabbb33..64a17bbffb 100644 --- a/pages/common/cronic.md +++ b/pages/common/cronic.md @@ -1,7 +1,7 @@ # cronic > Bash script for wrapping cron jobs to prevent excess email sending. -> More information: . +> More information: . - Call a command and display its output if it returns a non-zero exit code: diff --git a/pages/common/crunch.md b/pages/common/crunch.md index c1d9e4989d..d167afaf19 100644 --- a/pages/common/crunch.md +++ b/pages/common/crunch.md @@ -1,7 +1,7 @@ # crunch > Wordlist generator. -> More information: . +> More information: . - Output a list of words of length 1 to 3 with only lowercase characters: diff --git a/pages/common/csvcut.md b/pages/common/csvcut.md index fe4f472b89..214bb92820 100644 --- a/pages/common/csvcut.md +++ b/pages/common/csvcut.md @@ -6,16 +6,16 @@ - Print indices and names of all columns: -`csvcut -n {{data.csv}}` +`csvcut {{[-n|--names]}} {{data.csv}}` - Extract the first and third columns: -`csvcut -c {{1,3}} {{data.csv}}` +`csvcut {{[-c|--columns]}} {{1,3}} {{data.csv}}` - Extract all columns except the fourth one: -`csvcut -C {{4}} {{data.csv}}` +`csvcut {{[-C|--not-columns]}} {{4}} {{data.csv}}` - Extract the columns named "id" and "first name" (in that order): -`csvcut -c {{id,"first name"}} {{data.csv}}` +`csvcut {{[-c|--columns]}} {{id,"first name"}} {{data.csv}}` diff --git a/pages/common/csvformat.md b/pages/common/csvformat.md index eccb556823..c5fe5bae50 100644 --- a/pages/common/csvformat.md +++ b/pages/common/csvformat.md @@ -6,20 +6,20 @@ - Convert to a tab-delimited file (TSV): -`csvformat -T {{data.csv}}` +`csvformat {{[-T|--out-tabs]}} {{data.csv}}` - Convert delimiters to a custom character: -`csvformat -D "{{custom_character}}" {{data.csv}}` +`csvformat {{[-D|--out-delimiter]}} "{{custom_character}}" {{data.csv}}` - Convert line endings to carriage return (^M) + line feed: -`csvformat -M "{{\r\n}}" {{data.csv}}` +`csvformat {{[-M|--out-lineterminator]}} "{{\r\n}}" {{data.csv}}` - Minimize use of quote characters: -`csvformat -U 0 {{data.csv}}` +`csvformat {{[-U|--out-quoting]}} 0 {{data.csv}}` - Maximize use of quote characters: -`csvformat -U 1 {{data.csv}}` +`csvformat {{[-U|--out-quoting]}} 1 {{data.csv}}` diff --git a/pages/common/csvgrep.md b/pages/common/csvgrep.md index 9ed87c8d1c..bfae6aa229 100644 --- a/pages/common/csvgrep.md +++ b/pages/common/csvgrep.md @@ -6,12 +6,12 @@ - Find rows that have a certain string in column 1: -`csvgrep -c {{1}} -m {{string_to_match}} {{data.csv}}` +`csvgrep {{[-c|--columns]}} {{1}} {{[-m|--match]}} {{string_to_match}} {{data.csv}}` - Find rows in which columns 3 or 4 match a certain regular expression: -`csvgrep -c {{3,4}} -r {{regular_expression}} {{data.csv}}` +`csvgrep {{[-c|--columns]}} {{3,4}} {{[-r|--regex]}} {{regular_expression}} {{data.csv}}` - Find rows in which the "name" column does NOT include the string "John Doe": -`csvgrep -i -c {{name}} -m "{{John Doe}}" {{data.csv}}` +`csvgrep {{[-i|--invert-match]}} {{[-c|--columns]}} {{name}} {{[-m|--match]}} "{{John Doe}}" {{data.csv}}` diff --git a/pages/common/csvkit.md b/pages/common/csvkit.md index 97c0ec31c7..b64e7c5239 100644 --- a/pages/common/csvkit.md +++ b/pages/common/csvkit.md @@ -2,20 +2,20 @@ > Manipulation toolkit for CSV files. > See also: `csvclean`, `csvcut`, `csvformat`, `csvgrep`, `csvlook`, `csvpy`, `csvsort`, `csvstat`. -> More information: . +> More information: . - Run a command on a CSV file with a custom delimiter: -`{{command}} -d {{delimiter}} {{path/to/file.csv}}` +`{{command}} {{[-d|--delimiter]}} {{delimiter}} {{path/to/file.csv}}` - Run a command on a CSV file with a tab as a delimiter (overrides -d): -`{{command}} -t {{path/to/file.csv}}` +`{{command}} {{[-t|--tabs]}} {{path/to/file.csv}}` - Run a command on a CSV file with a custom quote character: -`{{command}} -q {{quote_char}} {{path/to/file.csv}}` +`{{command}} {{[-q|--quotechar]}} {{quote_char}} {{path/to/file.csv}}` - Run a command on a CSV file with no header row: -`{{command}} -H {{path/to/file.csv}}` +`{{command}} {{[-H|--no-header-row]}} {{path/to/file.csv}}` diff --git a/pages/common/csvsort.md b/pages/common/csvsort.md index 48418438c4..ff6b38c2d0 100644 --- a/pages/common/csvsort.md +++ b/pages/common/csvsort.md @@ -6,16 +6,16 @@ - Sort a CSV file by column 9: -`csvsort -c {{9}} {{data.csv}}` +`csvsort {{[-c|--columns]}} {{9}} {{data.csv}}` - Sort a CSV file by the "name" column in descending order: -`csvsort -r -c {{name}} {{data.csv}}` +`csvsort {{[-r|--reverse]}} {{[-c|--columns]}} {{name}} {{data.csv}}` - Sort a CSV file by column 2, then by column 4: -`csvsort -c {{2,4}} {{data.csv}}` +`csvsort {{[-c|--columns]}} {{2,4}} {{data.csv}}` - Sort a CSV file without inferring data types: -`csvsort --no-inference -c {{columns}} {{data.csv}}` +`csvsort {{[-I|--no-inference]}} {{[-c|--columns]}} {{columns}} {{data.csv}}` diff --git a/pages/common/csvstat.md b/pages/common/csvstat.md index 09a6fe27e5..b716862580 100644 --- a/pages/common/csvstat.md +++ b/pages/common/csvstat.md @@ -10,7 +10,7 @@ - Show all stats for columns 2 and 4: -`csvstat -c {{2,4}} {{data.csv}}` +`csvstat {{[-c|--columns]}} {{2,4}} {{data.csv}}` - Show sums for all columns: @@ -18,8 +18,8 @@ - Show the max value length for column 3: -`csvstat -c {{3}} --len {{data.csv}}` +`csvstat {{[-c|--columns]}} {{3}} --len {{data.csv}}` - Show the number of unique values in the "name" column: -`csvstat -c {{name}} --unique {{data.csv}}` +`csvstat {{[-c|--columns]}} {{name}} --unique {{data.csv}}` diff --git a/pages/common/csvtool.md b/pages/common/csvtool.md index bba9069c9a..05f02d9789 100644 --- a/pages/common/csvtool.md +++ b/pages/common/csvtool.md @@ -5,20 +5,20 @@ - Extract the second column from a CSV file: -`csvtool --column {{2}} {{path/to/file.csv}}` +`csvtool {{[-c|--column]}} {{2}} {{path/to/file.csv}}` - Extract the second and fourth columns from a CSV file: -`csvtool --column {{2,4}} {{path/to/file.csv}}` +`csvtool {{[-c|--column]}} {{2,4}} {{path/to/file.csv}}` - Extract lines from a CSV file where the second column exactly matches 'Foo': -`csvtool --column {{2}} --search '{{^Foo$}}' {{path/to/file.csv}}` +`csvtool {{[-c|--column]}} {{2}} {{[-s|--search]}} '{{^Foo$}}' {{path/to/file.csv}}` - Extract lines from a CSV file where the second column starts with 'Bar': -`csvtool --column {{2}} --search '{{^Bar}}' {{path/to/file.csv}}` +`csvtool {{[-c|--column]}} {{2}} {{[-s|--search]}} '{{^Bar}}' {{path/to/file.csv}}` - Find lines in a CSV file where the second column ends with 'Baz' and then extract the third and sixth columns: -`csvtool --column {{2}} --search '{{Baz$}}' {{path/to/file.csv}} | csvtool --no-header --column {{3,6}}` +`csvtool {{[-c|--column]}} {{2}} {{[-s|--search]}} '{{Baz$}}' {{path/to/file.csv}} | csvtool {{[-e|--no-header]}} {{[-c|--column]}} {{3,6}}` diff --git a/pages/common/ctest.md b/pages/common/ctest.md index ff5849c7e5..0124712de2 100644 --- a/pages/common/ctest.md +++ b/pages/common/ctest.md @@ -3,14 +3,14 @@ > CMake test driver program. > More information: . -- Run all tests defined in the CMake project, executing 4 jobs at a time in parallel: +- Run all tests defined in the CMake project, executing 4 [j]obs at a time in parallel: -`ctest -j{{4}} --output-on-failure` +`ctest {{[-j|--parallel]}} {{4}} --output-on-failure` - List available tests: -`ctest -N` +`ctest {{[-N|--show-only]}}` - Run a single test based on its name, or filter on a regular expression: -`ctest --output-on-failure -R '^{{test_name}}$'` +`ctest --output-on-failure {{[-R|--tests-regex]}} '^{{test_name}}$'` diff --git a/pages/common/daps.md b/pages/common/daps.md index 77f4a8a0b8..18cbd9cf88 100644 --- a/pages/common/daps.md +++ b/pages/common/daps.md @@ -5,19 +5,19 @@ - Check if a DocBook XML file is valid: -`daps -d {{path/to/file.xml}} validate` +`daps {{[-d|--docconfig]}} {{path/to/file.xml}} validate` - Convert a DocBook XML file into PDF: -`daps -d {{path/to/file.xml}} pdf` +`daps {{[-d|--docconfig]}} {{path/to/file.xml}} pdf` - Convert a DocBook XML file into a single HTML file: -`daps -d {{path/to/file.xml}} html --single` +`daps {{[-d|--docconfig]}} {{path/to/file.xml}} html --single` - Display help: -`daps --help` +`daps {{[-h|--help]}}` - Display version: diff --git a/pages/common/darkhttpd.md b/pages/common/darkhttpd.md index ee3593f0e9..e378bcc526 100644 --- a/pages/common/darkhttpd.md +++ b/pages/common/darkhttpd.md @@ -1,7 +1,7 @@ # darkhttpd > Darkhttpd web server. -> More information: . +> More information: . - Start server serving the specified document root: diff --git a/pages/common/ddgr.md b/pages/common/ddgr.md index 64a76fb8e6..c92f8c8211 100644 --- a/pages/common/ddgr.md +++ b/pages/common/ddgr.md @@ -13,11 +13,11 @@ - Limit the number of search results to `n`: -`ddgr -n {{n}} {{keyword}}` +`ddgr {{[-n|--num]}} {{n}} {{keyword}}` - Display the complete URL in search results: -`ddgr -x {{keyword}}` +`ddgr {{[-x|--expand]}} {{keyword}}` - Search DuckDuckGo for a keyword and open the first result in the browser: @@ -25,7 +25,7 @@ - Perform a website-specific search: -`ddgr -w {{site}} {{keyword}}` +`ddgr {{[-w|--site]}} {{site}} {{keyword}}` - Search for a specific file type: diff --git a/pages/common/deluge-console.md b/pages/common/deluge-console.md index d425beb17c..5fb8a59b5b 100644 --- a/pages/common/deluge-console.md +++ b/pages/common/deluge-console.md @@ -1,7 +1,7 @@ # deluge-console > An interactive interface for the Deluge BitTorrent client. -> More information: . +> More information: . - Start the interactive console interface: diff --git a/pages/common/deluge.md b/pages/common/deluge.md index a105a2c001..4af2d08e33 100644 --- a/pages/common/deluge.md +++ b/pages/common/deluge.md @@ -1,7 +1,7 @@ # deluge > A command-line BitTorrent client. -> More information: . +> More information: . - Download a torrent: @@ -9,7 +9,7 @@ - Download a torrent using a specific configuration file: -`deluge -c {{path/to/configuration_file}} {{url|magnet|path/to/file}}` +`deluge {{[-c|--config]}} {{path/to/configuration_file}} {{url|magnet|path/to/file}}` - Download a torrent and launch the specified user interface: @@ -17,4 +17,4 @@ - Download a torrent and output the log to a file: -`deluge -l {{path/to/log_file}} {{url|magnet|path/to/file}}` +`deluge {{[-l|--logfile]}} {{path/to/log_file}} {{url|magnet|path/to/file}}` diff --git a/pages/common/deluged.md b/pages/common/deluged.md index 5475e9ef35..5d7f660f00 100644 --- a/pages/common/deluged.md +++ b/pages/common/deluged.md @@ -1,7 +1,7 @@ # deluged > A daemon process for the Deluge BitTorrent client. -> More information: . +> More information: . - Start the Deluge daemon: @@ -9,12 +9,12 @@ - Start the Deluge daemon on a specific port: -`deluged -p {{port}}` +`deluged {{[-p|--port]}} {{port}}` - Start the Deluge daemon using a specific configuration file: -`deluged -c {{path/to/configuration_file}}` +`deluged {{[-c|--config]}} {{path/to/configuration_file}}` - Start the Deluge daemon and output the log to a file: -`deluged -l {{path/to/log_file}}` +`deluged {{[-l|--logfile]}} {{path/to/log_file}}` diff --git a/pages/common/detox.md b/pages/common/detox.md index 56b2642e03..f796482c35 100644 --- a/pages/common/detox.md +++ b/pages/common/detox.md @@ -2,7 +2,7 @@ > Renames files to make them easier to work with. > It removes spaces and other such annoyances like duplicate underline characters. -> More information: . +> More information: . - Remove spaces and other undesirable characters from a file's name: @@ -10,7 +10,7 @@ - Show how detox would rename all the files in a directory tree: -`detox --dry-run -r {{path/to/directory}}` +`detox {{[-n|--dry-run]}} -r {{path/to/directory}}` - Remove spaces and other undesirable characters from all files in a directory tree: diff --git a/pages/common/dexdump.md b/pages/common/dexdump.md index 5bafcddbc6..98d9adc7ae 100644 --- a/pages/common/dexdump.md +++ b/pages/common/dexdump.md @@ -1,7 +1,7 @@ # dexdump > Display information about Android DEX files. -> More information: . +> More information: . - Extract classes and methods from an APK file: diff --git a/pages/common/dexter.md b/pages/common/dexter.md index e16cf16ec6..42cd076afe 100644 --- a/pages/common/dexter.md +++ b/pages/common/dexter.md @@ -5,8 +5,8 @@ - Create and authenticate a user with Google OIDC: -`dexter auth -i {{client_id}} -s {{client_secret}}` +`dexter auth {{[-i|--client-id]}} {{client_id}} {{[-s|--client-secret]}} {{client_secret}}` - Override the default kube configuration file location: -`dexter auth -i {{client_id}} -s {{client_secret}} --kube-config {{sample/config}}` +`dexter auth {{[-i|--client-id]}} {{client_id}} {{[-s|--client-secret]}} {{client_secret}} {{[-k|--kube-config]}} {{sample/config}}` diff --git a/pages/common/dhcpig.md b/pages/common/dhcpig.md index f1729788cf..f30c8b10c2 100644 --- a/pages/common/dhcpig.md +++ b/pages/common/dhcpig.md @@ -10,24 +10,24 @@ - Exhaust IPv6 addresses using eth1 interface: -`sudo ./pig.py -6 {{eth1}}` +`sudo ./pig.py {{[-6|--ipv6]}} {{eth1}}` - Send fuzzed/malformed data packets using the interface: -`sudo ./pig.py --fuzz {{eth1}}` +`sudo ./pig.py {{[-f|--fuzz]}} {{eth1}}` - Enable color output: -`sudo ./pig.py -c {{eth1}}` +`sudo ./pig.py {{[-c|--color]}} {{eth1}}` - Enable minimal verbosity and color output: -`sudo ./pig.py -c --verbosity=1 {{eth1}}` +`sudo ./pig.py {{[-c|--color]}} {{[-v|--verbosity]}} 1 {{eth1}}` - Use a debug verbosity of 100 and scan network of neighboring devices using ARP packets: -`sudo ./pig.py -c --verbosity=100 --neighbors-scan-arp {{eth1}}` +`sudo ./pig.py {{[-c|--color]}} {{[-v|--verbosity]}} 100 {{[-n|--neighbors-scan-arp]}} {{eth1}}` - Enable printing lease information, attempt to scan and release all neighbor IP addresses: -`sudo ./pig.py --neighbors-scan-arp -r --show-options {{eth1}}` +`sudo ./pig.py {{[-n|--neighbors-scan-arp]}} {{[-r|--neighbors-attack-release]}} {{[-o|--show-options]}} {{eth1}}` diff --git a/pages/common/dhcpwn.md b/pages/common/dhcpwn.md index 8a42b927df..04148b700c 100644 --- a/pages/common/dhcpwn.md +++ b/pages/common/dhcpwn.md @@ -5,8 +5,8 @@ - Flood the network with IP requests: -`dhcpwn --interface {{network_interface}} flood --count {{number_of_requests}}` +`dhcpwn {{[-i|--interface]}} {{network_interface}} flood {{[-c|--count]}} {{number_of_requests}}` - Sniff local DHCP traffic: -`dhcpwn --interface {{network_interface}} sniff` +`dhcpwn {{[-i|--interface]}} {{network_interface}} sniff` diff --git a/pages/common/dict.md b/pages/common/dict.md index 55fe509560..bc4b923302 100644 --- a/pages/common/dict.md +++ b/pages/common/dict.md @@ -5,15 +5,15 @@ - List available databases: -`dict -D` +`dict {{[-D|--dbs]}}` - Get information about a database: -`dict -i {{database_name}}` +`dict {{[-i|--info]}} {{database_name}}` - Look up a word in a specific database: -`dict -d {{database_name}} {{word}}` +`dict {{[-d|--database]}} {{database_name}} {{word}}` - Look up a word in all available databases: @@ -21,4 +21,4 @@ - Show information about the DICT server: -`dict -I` +`dict {{[-I|--serverinfo]}}` diff --git a/pages/common/dirsearch.md b/pages/common/dirsearch.md index 1911f6c90e..1d20d2fb24 100644 --- a/pages/common/dirsearch.md +++ b/pages/common/dirsearch.md @@ -5,24 +5,24 @@ - Scan a web server for common paths with common extensions: -`dirsearch --url {{url}} --extensions-list` +`dirsearch {{[-u|--url]}} {{url}} --extensions-list` -- Scan a list of web servers for common paths with the `.php` extension: +- Scan a list of web servers for common paths with given file extensions: -`dirsearch --url-list {{path/to/url-list.txt}} --extensions {{php}}` +`dirsearch {{[-l|--url-list]}} {{path/to/url-list.txt}} {{[-e|--extensions]}} {{php,jsp,aspx,...}}` - Scan a web server for user-defined paths with common extensions: -`dirsearch --url {{url}} --extensions-list --wordlist {{path/to/url-paths.txt}}` +`dirsearch {{[-u|--url]}} {{url}} --extensions-list {{[-w|--wordlists]}} {{path/to/url-paths.txt,path/to/url-paths.txt,...}}` - Scan a web server using a cookie: -`dirsearch --url {{url}} --extensions {{php}} --cookie {{cookie}}` +`dirsearch {{[-u|--url]}} {{url}} {{[-e|--extensions]}} {{php}} --cookie {{cookie}}` - Scan a web server using the `HEAD` HTTP method: -`dirsearch --url {{url}} --extensions {{php}} --http-method {{HEAD}}` +`dirsearch {{[-u|--url]}} {{url}} {{[-e|--extensions]}} {{php}} {{[-m|--http-method]}} {{HEAD}}` - Scan a web server, saving the results to a `.json` file: -`dirsearch --url {{url}} --extensions {{php}} --json-report {{path/to/report.json}}` +`dirsearch {{[-u|--url]}} {{url}} {{[-e|--extensions]}} {{php}} --json-report {{path/to/report.json}}` diff --git a/pages/common/django-admin.md b/pages/common/django-admin.md index bab8c2e588..b7f29666b9 100644 --- a/pages/common/django-admin.md +++ b/pages/common/django-admin.md @@ -1,7 +1,7 @@ # django-admin > Django’s utility for administrative tasks. -> More information: . +> More information: . - Create a new Django project: diff --git a/pages/common/docker-build.md b/pages/common/docker-build.md index 77415bfcd9..372f7788ee 100644 --- a/pages/common/docker-build.md +++ b/pages/common/docker-build.md @@ -13,19 +13,19 @@ - Build a Docker image and tag it: -`docker build --tag {{name:tag}} .` +`docker build {{[-t|--tag]}} {{name:tag}} .` - Build a Docker image with no build context: -`docker build --tag {{name:tag}} - < {{Dockerfile}}` +`docker build {{[-t|--tag]}} {{name:tag}} - < {{Dockerfile}}` - Do not use the cache when building the image: -`docker build --no-cache --tag {{name:tag}} .` +`docker build --no-cache {{[-t|--tag]}} {{name:tag}} .` - Build a Docker image using a specific Dockerfile: -`docker build --file {{Dockerfile}} .` +`docker build {{[-f|--file]}} {{Dockerfile}} .` - Build with custom build-time variables: diff --git a/pages/common/docker-commit.md b/pages/common/docker-commit.md index 566fc197bd..04985f454c 100644 --- a/pages/common/docker-commit.md +++ b/pages/common/docker-commit.md @@ -9,23 +9,23 @@ - Apply a `CMD` Dockerfile instruction to the created image: -`docker commit --change "CMD {{command}}" {{container}} {{image}}:{{tag}}` +`docker commit {{[-c|--change]}} "CMD {{command}}" {{container}} {{image}}:{{tag}}` - Apply an `ENV` Dockerfile instruction to the created image: -`docker commit --change "ENV {{name}}={{value}}" {{container}} {{image}}:{{tag}}` +`docker commit {{[-c|--change]}} "ENV {{name}}={{value}}" {{container}} {{image}}:{{tag}}` - Create an image with a specific author in the metadata: -`docker commit --author "{{author}}" {{container}} {{image}}:{{tag}}` +`docker commit {{[-a|--author]}} "{{author}}" {{container}} {{image}}:{{tag}}` - Create an image with a specific comment in the metadata: -`docker commit --message "{{comment}}" {{container}} {{image}}:{{tag}}` +`docker commit {{[-m|--message]}} "{{comment}}" {{container}} {{image}}:{{tag}}` - Create an image without pausing the container during commit: -`docker commit --pause {{false}} {{container}} {{image}}:{{tag}}` +`docker commit {{[-p|--pause]}} {{false}} {{container}} {{image}}:{{tag}}` - Display help: diff --git a/pages/common/docker-compose.md b/pages/common/docker-compose.md index 117a9b801f..6a6db64625 100644 --- a/pages/common/docker-compose.md +++ b/pages/common/docker-compose.md @@ -9,7 +9,7 @@ - Create and start all containers in the background using a `docker-compose.yml` file from the current directory: -`docker compose up --detach` +`docker compose up {{[-d|--detach]}}` - Start all containers, rebuild if necessary: @@ -17,7 +17,7 @@ - Start all containers by specifying a project name and using an alternate compose file: -`docker compose -p {{project_name}} --file {{path/to/file}} up` +`docker compose {{[-p|--project-name]}} {{project_name}} {{[-f|--file]}} {{path/to/file}} up` - Stop all running containers: @@ -25,12 +25,12 @@ - Stop and remove all containers, networks, images, and volumes: -`docker compose down --rmi all --volumes` +`docker compose down --rmi all {{[-v|--volumes]}}` - Follow logs for all containers: -`docker compose logs --follow` +`docker compose logs {{[-f|--follow]}}` - Follow logs for a specific container: -`docker compose logs --follow {{container_name}}` +`docker compose logs {{[-f|--follow]}} {{container_name}}` diff --git a/pages/common/docker-cp.md b/pages/common/docker-cp.md index d7c8269ee8..80c28d791d 100644 --- a/pages/common/docker-cp.md +++ b/pages/common/docker-cp.md @@ -13,4 +13,4 @@ - Copy a file or directory from the host to a container, following symlinks (copies the symlinked files directly, not the symlinks themselves): -`docker cp --follow-link {{path/to/symlink_on_host}} {{container_name}}:{{path/to/file_or_directory_in_container}}` +`docker cp {{[-L|--follow-link]}} {{path/to/symlink_on_host}} {{container_name}}:{{path/to/file_or_directory_in_container}}` diff --git a/pages/common/docker-image.md b/pages/common/docker-image.md index c1f8d24a47..aa66893355 100644 --- a/pages/common/docker-image.md +++ b/pages/common/docker-image.md @@ -14,7 +14,7 @@ - Delete all unused images (not just those without a tag): -`docker image prune --all` +`docker image prune {{[-a|--all]}}` - Show the history of a local Docker image: diff --git a/pages/common/docker-images.md b/pages/common/docker-images.md index 9e62eaea37..1fefc0ed57 100644 --- a/pages/common/docker-images.md +++ b/pages/common/docker-images.md @@ -25,4 +25,4 @@ - Sort images by size: -`docker images --format "\{\{.ID\}\}\t\{\{.Size\}\}\t\{\{.Repository\}\}:\{\{.Tag\}\}" | sort -k 2 -h` +`docker images --format "\{\{.ID\}\}\t\{\{.Size\}\}\t\{\{.Repository\}\}:\{\{.Tag\}\}" | sort {{[-k|--key]}} 2 {{[-h|--human-numeric-sort]}}` diff --git a/pages/common/docker-inspect.md b/pages/common/docker-inspect.md index f74be958fa..2c313bb951 100644 --- a/pages/common/docker-inspect.md +++ b/pages/common/docker-inspect.md @@ -13,20 +13,20 @@ - Display a container's IP address: -`docker inspect --format '\{\{range.NetworkSettings.Networks\}\}\{\{.IPAddress\}\}\{\{end\}\}' {{container}}` +`docker inspect {{[-f|--format]}} '\{\{range.NetworkSettings.Networks\}\}\{\{.IPAddress\}\}\{\{end\}\}' {{container}}` - Display the path to the container's log file: -`docker inspect --format='\{\{.LogPath\}\}' {{container}}` +`docker inspect {{[-f|--format]}} '\{\{.LogPath\}\}' {{container}}` - Display the image name of the container: -`docker inspect --format='\{\{.Config.Image\}\}' {{container}}` +`docker inspect {{[-f|--format]}} '\{\{.Config.Image\}\}' {{container}}` - Display the configuration information as JSON: -`docker inspect --format='\{\{json .Config\}\}' {{container}}` +`docker inspect {{[-f|--format]}} '\{\{json .Config\}\}' {{container}}` - Display all port bindings: -`docker inspect --format='\{\{range $p, $conf := .NetworkSettings.Ports\}\} \{\{$p\}\} -> \{\{(index $conf 0).HostPort\}\} \{\{end\}\}' {{container}}` +`docker inspect {{[-f|--format]}} '\{\{range $p, $conf := .NetworkSettings.Ports\}\} \{\{$p\}\} -> \{\{(index $conf 0).HostPort\}\} \{\{end\}\}' {{container}}` diff --git a/pages/common/docker-load.md b/pages/common/docker-load.md index 222268f92b..3dcedf9bc3 100644 --- a/pages/common/docker-load.md +++ b/pages/common/docker-load.md @@ -9,8 +9,8 @@ - Load a Docker image from a specific file: -`docker load --input {{path/to/image_file.tar}}` +`docker load {{[-i|--input]}} {{path/to/image_file.tar}}` - Load a Docker image from a specific file in quiet mode: -`docker load --quiet --input {{path/to/image_file.tar}}` +`docker load {{[-q|--quiet]}} {{[-i|--input]}} {{path/to/image_file.tar}}` diff --git a/pages/common/docker-login.md b/pages/common/docker-login.md index 5d0e4650fb..2d93c860c7 100644 --- a/pages/common/docker-login.md +++ b/pages/common/docker-login.md @@ -9,12 +9,12 @@ - Log into a registry with a specific username (user will be prompted for a password): -`docker login --username {{username}}` +`docker login {{[-u|--username]}} {{username}}` - Log into a registry with username and password: -`docker login --username {{username}} --password {{password}} {{server}}` +`docker login {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} {{server}}` - Log into a registry with password from `stdin`: -`echo "{{password}}" | docker login --username {{username}} --password-stdin` +`echo "{{password}}" | docker login {{[-u|--username]}} {{username}} --password-stdin` diff --git a/pages/common/docker-network.md b/pages/common/docker-network.md index 0e9c99c201..c3c1b82f56 100644 --- a/pages/common/docker-network.md +++ b/pages/common/docker-network.md @@ -9,7 +9,7 @@ - Create a user-defined network: -`docker network create --driver {{driver_name}} {{network_name}}` +`docker network create {{[-d|--driver]}} {{driver_name}} {{network_name}}` - Display detailed information about one or more networks: diff --git a/pages/common/docker-rmi.md b/pages/common/docker-rmi.md index 4ad2445707..4f380950e8 100644 --- a/pages/common/docker-rmi.md +++ b/pages/common/docker-rmi.md @@ -13,7 +13,7 @@ - Force remove an image: -`docker rmi --force {{image}}` +`docker rmi {{[-f|--force]}} {{image}}` - Remove an image without deleting untagged parents: diff --git a/pages/common/docker-save.md b/pages/common/docker-save.md index 5a43409868..dd9330fbc5 100644 --- a/pages/common/docker-save.md +++ b/pages/common/docker-save.md @@ -9,12 +9,12 @@ - Save an image to a tar archive: -`docker save --output {{path/to/file.tar}} {{image}}:{{tag}}` +`docker save {{[-o|--output]}} {{path/to/file.tar}} {{image}}:{{tag}}` - Save all tags of the image: -`docker save --output {{path/to/file.tar}} {{image_name}}` +`docker save {{[-o|--output]}} {{path/to/file.tar}} {{image_name}}` - Cherry-pick particular tags of an image to save: -`docker save --output {{path/to/file.tar}} {{image_name:tag1 image_name:tag2 ...}}` +`docker save {{[-o|--output]}} {{path/to/file.tar}} {{image_name:tag1 image_name:tag2 ...}}` diff --git a/pages/common/docker-stats.md b/pages/common/docker-stats.md index 1faa84b27f..e884cdc107 100644 --- a/pages/common/docker-stats.md +++ b/pages/common/docker-stats.md @@ -17,7 +17,7 @@ - Display statistics for all containers (both running and stopped): -`docker stats --all` +`docker stats {{[-a|--all]}}` - Disable streaming stats and only pull the current stats: diff --git a/pages/common/docker-system.md b/pages/common/docker-system.md index 0ed6ad81af..fe4f79b608 100644 --- a/pages/common/docker-system.md +++ b/pages/common/docker-system.md @@ -13,7 +13,7 @@ - Show detailed information on disk usage: -`docker system df --verbose` +`docker system df {{[-v|--verbose]}}` - Remove unused data (append `--volumes` to remove unused volumes as well): @@ -29,7 +29,7 @@ - Display real-time events from containers streamed as valid JSON Lines: -`docker system events --filter 'type=container' --format '{{json .}}'` +`docker system events {{[-f|--filter]}} 'type=container' --format '{{json .}}'` - Display system-wide information: diff --git a/pages/common/docker-volume.md b/pages/common/docker-volume.md index b681c17f42..2f2662295b 100644 --- a/pages/common/docker-volume.md +++ b/pages/common/docker-volume.md @@ -13,7 +13,7 @@ - Create a `tmpfs` volume a size of 100 MiB and an uid of 1000: -`docker volume create --opt {{type}}={{tmpfs}} --opt {{device}}={{tmpfs}} --opt {{o}}={{size=100m,uid=1000}} {{volume_name}}` +`docker volume create {{[-o|--opt]}} {{type}}={{tmpfs}} {{[-o|--opt]}} {{device}}={{tmpfs}} {{[-o|--opt]}} {{o}}={{size=100m,uid=1000}} {{volume_name}}` - List all volumes: diff --git a/pages/common/dokku.md b/pages/common/dokku.md index eac2bc44b0..caf23ed076 100644 --- a/pages/common/dokku.md +++ b/pages/common/dokku.md @@ -2,7 +2,7 @@ > Docker powered mini-Heroku (PaaS). > Easily deploy multiple apps to your server in different languages using a single `git-push` command. -> More information: . +> More information: . - List running apps: diff --git a/pages/common/dolt-add.md b/pages/common/dolt-add.md index 2dc98071f3..4759f62ea8 100644 --- a/pages/common/dolt-add.md +++ b/pages/common/dolt-add.md @@ -9,4 +9,4 @@ - Stage all tables: -`dolt add --all` +`dolt add {{[-A|--all]}}` diff --git a/pages/common/dolt-branch.md b/pages/common/dolt-branch.md index 222f062f3b..932efd7e74 100644 --- a/pages/common/dolt-branch.md +++ b/pages/common/dolt-branch.md @@ -9,7 +9,7 @@ - List all local and remote branches: -`dolt branch --all` +`dolt branch {{[-A|--all]}}` - Create a new branch based on the current branch: @@ -21,15 +21,15 @@ - Rename a branch: -`dolt branch --move {{branch_name1}} {{branch_name2}}` +`dolt branch {{[-m|--move]}} {{branch_name1}} {{branch_name2}}` - Duplicate a branch: -`dolt branch --copy {{branch_name1}} {{branch_name2}}` +`dolt branch {{[-c|--copy]}} {{branch_name1}} {{branch_name2}}` - Delete a branch: -`dolt branch --delete {{branch_name}}` +`dolt branch {{[-d|--delete]}} {{branch_name}}` - Display the name of the current branch: diff --git a/pages/common/dolt-clone.md b/pages/common/dolt-clone.md index 948b5177c1..f05c9e986e 100644 --- a/pages/common/dolt-clone.md +++ b/pages/common/dolt-clone.md @@ -1,7 +1,7 @@ # dolt clone > Clone a repository into a new directory. -> More information: . +> More information: . - Clone an existing repository into a specific directory (defaults to the repository name): @@ -13,7 +13,7 @@ - Clone an existing repository only fetching a specific branch (defaults to all branches): -`dolt clone --branch {{branch_name}} {{repository_url}}` +`dolt clone {{[-b|--branch]}} {{branch_name}} {{repository_url}}` - Clone a repository, using an AWS region (uses the profile's default region if none is provided): diff --git a/pages/common/dolt-commit.md b/pages/common/dolt-commit.md index 0b82626de2..82de5354de 100644 --- a/pages/common/dolt-commit.md +++ b/pages/common/dolt-commit.md @@ -9,11 +9,11 @@ - Commit all staged changes with the specified message: -`dolt commit --message "{{commit_message}}"` +`dolt commit {{[-m|--message]}} "{{commit_message}}"` - Stage all unstaged changes to tables before committing: -`dolt commit --all` +`dolt commit {{[-a|--all]}}` - Use the specified ISO 8601 commit date (defaults to current date and time): @@ -29,4 +29,4 @@ - Ignore foreign key warnings: -`dolt commit --force` +`dolt commit {{[-f|--force]}}` diff --git a/pages/common/dolt-gc.md b/pages/common/dolt-gc.md index fa95f7705f..2835863c2c 100644 --- a/pages/common/dolt-gc.md +++ b/pages/common/dolt-gc.md @@ -9,4 +9,4 @@ - Initiate a faster but less thorough garbage collection process: -`dolt gc --shallow` +`dolt gc {{[-s|--shallow]}}` diff --git a/pages/common/dolt-init.md b/pages/common/dolt-init.md index 74480ec440..8a53a0c580 100644 --- a/pages/common/dolt-init.md +++ b/pages/common/dolt-init.md @@ -9,4 +9,4 @@ - Initialize a new Dolt data repository creating a commit with the specified metadata: -`dolt init --name "{{name}}" --email "{{email}}" --date "{{2021-12-31T00:00:00}}" -b "{{branch_name}}"` +`dolt init --name "{{name}}" --email "{{email}}" --date "{{2021-12-31T00:00:00}}" {{[-b|--initial-branch]}} "{{branch_name}}"` diff --git a/pages/common/dolt-merge.md b/pages/common/dolt-merge.md index 8e93435d9b..cd1e6f3c9a 100644 --- a/pages/common/dolt-merge.md +++ b/pages/common/dolt-merge.md @@ -17,7 +17,7 @@ - Merge a branch and create a merge commit with a specific commit message: -`dolt merge --no-ff -m "{{message}}" {{branch_name}}` +`dolt merge --no-ff {{[-m|--message]}} "{{message}}" {{branch_name}}` - Abort the current conflict resolution process: diff --git a/pages/common/dolt-sql.md b/pages/common/dolt-sql.md index 941be86170..1f7891371a 100644 --- a/pages/common/dolt-sql.md +++ b/pages/common/dolt-sql.md @@ -5,8 +5,8 @@ - Run a single query: -`dolt sql --query "{{INSERT INTO t values (1, 3);}}"` +`dolt sql {{[-q|--query]}} "{{INSERT INTO t values (1, 3);}}"` - List all saved queries: -`dolt sql --list-saved` +`dolt sql {{[-l|--list-saved]}}` diff --git a/pages/common/dotnet-add-package.md b/pages/common/dotnet-add-package.md index bd6a18a316..309f1a9eba 100644 --- a/pages/common/dotnet-add-package.md +++ b/pages/common/dotnet-add-package.md @@ -13,15 +13,15 @@ - Add a specific version of a package to the project: -`dotnet add package {{package}} --version {{1.0.0}}` +`dotnet add package {{package}} {{[-v|--version]}} {{1.0.0}}` - Add a package using a specific NuGet source: -`dotnet add package {{package}} --source {{https://api.nuget.org/v3/index.json}}` +`dotnet add package {{package}} {{[-s|--source]}} {{https://api.nuget.org/v3/index.json}}` - Add a package only when targeting a specific framework: -`dotnet add package {{package}} --framework {{net7.0}}` +`dotnet add package {{package}} {{[-f|--framework]}} {{net7.0}}` - Add and specify the directory where to restore packages (`~/.nuget/packages` by default): diff --git a/pages/common/dotnet-build.md b/pages/common/dotnet-build.md index e8d6f732f3..a7df227238 100644 --- a/pages/common/dotnet-build.md +++ b/pages/common/dotnet-build.md @@ -13,7 +13,7 @@ - Compile in release mode: -`dotnet build --configuration {{Release}}` +`dotnet build {{[-c|--configuration]}} {{Release}}` - Compile without restoring dependencies: @@ -21,12 +21,12 @@ - Compile with a specific verbosity level: -`dotnet build --verbosity {{quiet|minimal|normal|detailed|diagnostic}}` +`dotnet build {{[-v|--verbosity]}} {{quiet|minimal|normal|detailed|diagnostic}}` - Compile for a specific runtime: -`dotnet build --runtime {{runtime_identifier}}` +`dotnet build {{[-r|--runtime]}} {{runtime_identifier}}` - Specify the output directory: -`dotnet build --output {{path/to/directory}}` +`dotnet build {{[-o|--output]}} {{path/to/directory}}` diff --git a/pages/common/dotnet-publish.md b/pages/common/dotnet-publish.md index 19772f03b0..3236ec28d2 100644 --- a/pages/common/dotnet-publish.md +++ b/pages/common/dotnet-publish.md @@ -5,19 +5,19 @@ - Compile a .NET project in release mode: -`dotnet publish --configuration Release {{path/to/project_file}}` +`dotnet publish {{[-c|--configuration]}} Release {{path/to/project_file}}` - Publish the .NET Core runtime with your application for the specified runtime: -`dotnet publish --self-contained true --runtime {{runtime_identifier}} {{path/to/project_file}}` +`dotnet publish {{[-sc|--self-contained]}} true {{[-r|--runtime]}} {{runtime_identifier}} {{path/to/project_file}}` - Package the application into a platform-specific single-file executable: -`dotnet publish --runtime {{runtime_identifier}} -p:PublishSingleFile=true {{path/to/project_file}}` +`dotnet publish {{[-r|--runtime]}} {{runtime_identifier}} -p:PublishSingleFile=true {{path/to/project_file}}` - Trim unused libraries to reduce the deployment size of an application: -`dotnet publish --self-contained true --runtime {{runtime_identifier}} -p:PublishTrimmed=true {{path/to/project_file}}` +`dotnet publish {{[-sc|--self-contained]}} true {{[-r|--runtime]}} {{runtime_identifier}} -p:PublishTrimmed=true {{path/to/project_file}}` - Compile a .NET project without restoring dependencies: @@ -25,4 +25,4 @@ - Specify the output directory: -`dotnet publish --output {{path/to/directory}} {{path/to/project_file}}` +`dotnet publish {{[-o|--output]}} {{path/to/directory}} {{path/to/project_file}}` diff --git a/pages/common/dotnet-restore.md b/pages/common/dotnet-restore.md index e82aad9bc4..08be0a3b0f 100644 --- a/pages/common/dotnet-restore.md +++ b/pages/common/dotnet-restore.md @@ -25,4 +25,4 @@ - Restore dependencies with a specific verbosity level: -`dotnet restore --verbosity {{quiet|minimal|normal|detailed|diagnostic}}` +`dotnet restore {{[-v|--verbosity]}} {{quiet|minimal|normal|detailed|diagnostic}}` diff --git a/pages/common/dotnet-run.md b/pages/common/dotnet-run.md index a2e32018d9..439b3ccce8 100644 --- a/pages/common/dotnet-run.md +++ b/pages/common/dotnet-run.md @@ -17,8 +17,8 @@ - Run the project using a target framework moniker: -`dotnet run --framework {{net7.0}}` +`dotnet run {{[-f|--framework]}} {{net7.0}}` - Specify architecture and OS, available since .NET 6 (Don't use `--runtime` with these options): -`dotnet run --arch {{x86|x64|arm|arm64}} --os {{win|win7|osx|linux|ios|android}}` +`dotnet run {{[-a|--arch]}} {{x86|x64|arm|arm64}} --os {{win|win7|osx|linux|ios|android}}` diff --git a/pages/common/dotnet-tool.md b/pages/common/dotnet-tool.md index 7478105778..fed2108c11 100644 --- a/pages/common/dotnet-tool.md +++ b/pages/common/dotnet-tool.md @@ -5,7 +5,7 @@ - Install a global tool (don't use `--global` for local tools): -`dotnet tool install --global {{dotnetsay}}` +`dotnet tool install {{[-g|--global]}} {{dotnetsay}}` - Install tools defined in the local tool manifest: @@ -13,15 +13,15 @@ - Update a specific global tool (don't use `--global` for local tools): -`dotnet tool update --global {{tool_name}}` +`dotnet tool update {{[-g|--global]}} {{tool_name}}` - Uninstall a global tool (don't use `--global` for local tools): -`dotnet tool uninstall --global {{tool_name}}` +`dotnet tool uninstall {{[-g|--global]}} {{tool_name}}` - List installed global tools (don't use `--global` for local tools): -`dotnet tool list --global` +`dotnet tool list {{[-g|--global]}}` - Search tools in NuGet: @@ -29,4 +29,4 @@ - Display help: -`dotnet tool --help` +`dotnet tool {{[-h|--help]}}` diff --git a/pages/common/drupal-check.md b/pages/common/drupal-check.md index 9cc1dde9e5..2a964460eb 100644 --- a/pages/common/drupal-check.md +++ b/pages/common/drupal-check.md @@ -1,7 +1,7 @@ # drupal-check > Check Drupal PHP code for deprecations. -> More information: . +> More information: . - Check the code in a specific directory for deprecations: @@ -9,7 +9,7 @@ - Check the code excluding a comma-separated list of directories: -`drupal-check --exclude-dir {{path/to/excluded_directory}},{{path/to/excluded_files/*.php}} {{path/to/directory}}` +`drupal-check {{[-e|--exclude-dir]}} {{path/to/excluded_directory}},{{path/to/excluded_files/*.php}} {{path/to/directory}}` - Don't show a progress bar: @@ -17,4 +17,4 @@ - Perform static analysis to detect bad coding practices: -`drupal-check --analysis {{path/to/directory}}` +`drupal-check {{[-a|--analysis]}} {{path/to/directory}}` diff --git a/pages/common/drush.md b/pages/common/drush.md index 2365444f37..567c39a9f5 100644 --- a/pages/common/drush.md +++ b/pages/common/drush.md @@ -1,7 +1,7 @@ # drush > A command-line shell and scripting interface for Drupal. -> More information: . +> More information: . - Enable module "foo": diff --git a/pages/common/dub.md b/pages/common/dub.md index ba8d11df54..2a95d14c0b 100644 --- a/pages/common/dub.md +++ b/pages/common/dub.md @@ -9,7 +9,7 @@ - Non-interactively create a new D project: -`dub init {{project_name}} -n` +`dub init {{project_name}} {{[-n|--non-interactive]}}` - Build and run a D project: @@ -25,4 +25,4 @@ - Display help: -`dub --help` +`dub {{[-h|--help]}}` diff --git a/pages/common/duckdb.md b/pages/common/duckdb.md index 180df9af27..93bdcc7ade 100644 --- a/pages/common/duckdb.md +++ b/pages/common/duckdb.md @@ -31,6 +31,6 @@ `cat {{path/to/source.csv}} | duckdb -c "{{COPY (FROM read_csv('/dev/stdin')) TO '/dev/stdout' WITH (FORMAT CSV, HEADER)}}"` -- Display help: +- Start the DuckDB UI, a web interface with notebooks: -`duckdb -help` +`duckdb -ui` diff --git a/pages/common/dumpcap.md b/pages/common/dumpcap.md index dc12074b3e..99be5c825e 100644 --- a/pages/common/dumpcap.md +++ b/pages/common/dumpcap.md @@ -5,16 +5,16 @@ - Display available interfaces: -`dumpcap --list-interfaces` +`dumpcap {{[-D|--list-interfaces]}}` - Capture packets on a specific interface: -`dumpcap --interface {{1}}` +`dumpcap {{[-i|--interface]}} {{1}}` - Capture packets to a specific location: -`dumpcap --interface {{1}} -w {{path/to/output_file.pcapng}}` +`dumpcap {{[-i|--interface]}} {{1}} -w {{path/to/output_file.pcapng}}` - Write to a ring buffer with a specific max file limit of a specific size: -`dumpcap --interface {{1}} -w {{path/to/output_file.pcapng}} --ring-buffer filesize:{{500000}} --ring-buffer files:{{10}}` +`dumpcap {{[-i|--interface]}} {{1}} -w {{path/to/output_file.pcapng}} {{[-b|--ring-buffer]}} filesize:{{500000}} {{[-b|--ring-buffer]}} files:{{10}}` diff --git a/pages/common/duplicacy.md b/pages/common/duplicacy.md index ae91aeb79f..97fc811633 100644 --- a/pages/common/duplicacy.md +++ b/pages/common/duplicacy.md @@ -5,7 +5,7 @@ - Use current directory as the repository, initialize a SFTP storage and encrypt the storage with a password: -`duplicacy init -e {{snapshot_id}} {{sftp://user@192.168.2.100/path/to/storage/}}` +`duplicacy init {{[-e|-encrypt]}} {{snapshot_id}} {{sftp://user@192.168.2.100/path/to/storage/}}` - Save a snapshot of the repository to the default storage: diff --git a/pages/common/dvc-commit.md b/pages/common/dvc-commit.md index c96d55b305..8fbe9e6aa1 100644 --- a/pages/common/dvc-commit.md +++ b/pages/common/dvc-commit.md @@ -13,4 +13,4 @@ - Recursively commit all DVC-tracked files in a directory: -`dvc commit --recursive {{path/to/directory}}` +`dvc commit {{[-R|--recursive]}} {{path/to/directory}}` diff --git a/pages/common/dvc-config.md b/pages/common/dvc-config.md index 324db251a2..03937650c4 100644 --- a/pages/common/dvc-config.md +++ b/pages/common/dvc-config.md @@ -14,7 +14,7 @@ - Unset the project's default remote: -`dvc config --unset core.remote` +`dvc config {{[-u|--unset]}} core.remote` - Get the configuration value for a specified key for the current project: @@ -26,7 +26,7 @@ - Unset a project level configuration value for a given key: -`dvc config --unset {{key}}` +`dvc config {{[-u|--unset]}} {{key}}` - Set a local, global, or system level configuration value: diff --git a/pages/common/dvc-destroy.md b/pages/common/dvc-destroy.md index f098c01f75..1615dc776b 100644 --- a/pages/common/dvc-destroy.md +++ b/pages/common/dvc-destroy.md @@ -9,4 +9,4 @@ - Force destroy the current project: -`dvc destroy --force` +`dvc destroy {{[-f|--force]}}` diff --git a/pages/common/dvc-fetch.md b/pages/common/dvc-fetch.md index bdf74ac604..524c544bb2 100644 --- a/pages/common/dvc-fetch.md +++ b/pages/common/dvc-fetch.md @@ -9,7 +9,7 @@ - Fetch changes from a specific remote upstream repository: -`dvc fetch --remote {{remote_name}}` +`dvc fetch {{[-r|--remote]}} {{remote_name}}` - Fetch the latest changes for a specific target/s: @@ -17,8 +17,8 @@ - Fetch changes for all branch and tags: -`dvc fetch --all-branches --all-tags` +`dvc fetch {{[-a|--all-branches]}} {{[-T|--all-tags]}}` - Fetch changes for all commits: -`dvc fetch --all-commits` +`dvc fetch {{[-A|--all-commits]}}` diff --git a/pages/common/dvc-gc.md b/pages/common/dvc-gc.md index e520842ce9..f388642971 100644 --- a/pages/common/dvc-gc.md +++ b/pages/common/dvc-gc.md @@ -5,16 +5,16 @@ - Garbage collect from the cache, keeping only versions referenced by the current workspace: -`dvc gc --workspace` +`dvc gc {{[-w|--workspace]}}` - Garbage collect from the cache, keeping only versions referenced by branch, tags, and commits: -`dvc gc --all-branches --all-tags --all-commits` +`dvc gc {{[-a|--all-branches]}} {{[-T|--all-tags]}} {{[-a|--all-commits]}}` - Garbage collect from the cache, including the default cloud remote storage (if set): -`dvc gc --all-commits --cloud` +`dvc gc {{[-a|--all-commits]}} {{[-c|--cloud]}}` - Garbage collect from the cache, including a specific cloud remote storage: -`dvc gc --all-commits --cloud --remote {{remote_name}}` +`dvc gc {{[-a|--all-commits]}} {{[-c|--cloud]}} {{[-r|--remote]}} {{remote_name}}` diff --git a/pages/common/dvc.md b/pages/common/dvc.md index c93b035b2a..f0145df5de 100644 --- a/pages/common/dvc.md +++ b/pages/common/dvc.md @@ -2,7 +2,7 @@ > Data Version Control: like `git` for data. > Some subcommands such as `commit` have their own usage documentation. -> More information: . +> More information: . - Execute a DVC subcommand: @@ -10,11 +10,11 @@ - Display general help: -`dvc --help` +`dvc {{[-h|--help]}}` - Display help about a specific subcommand: -`dvc {{subcommand}} --help` +`dvc {{subcommand}} {{[-h|--help]}}` - Display version: diff --git a/pages/common/egrep.md b/pages/common/egrep.md index 762c20445a..2e0e4d1a65 100644 --- a/pages/common/egrep.md +++ b/pages/common/egrep.md @@ -17,12 +17,12 @@ - Print file name and line number for each match: -`egrep --with-filename --line-number "{{search_pattern}}" {{path/to/file}}` +`egrep {{[-H|--with-filename]}} {{[-n|--line-number]}} "{{search_pattern}}" {{path/to/file}}` - Search for a pattern in all files recursively in a directory, ignoring binary files: -`egrep --recursive --binary-files={{without-match}} "{{search_pattern}}" {{path/to/directory}}` +`egrep {{[-r|--recursive]}} --binary-files={{without-match}} "{{search_pattern}}" {{path/to/directory}}` - Search for lines that do not match a pattern: -`egrep --invert-match "{{search_pattern}}" {{path/to/file}}` +`egrep {{[-v|--invert-match]}} "{{search_pattern}}" {{path/to/file}}` diff --git a/pages/common/electrum.md b/pages/common/electrum.md index 0803a90d1f..be5adf1758 100644 --- a/pages/common/electrum.md +++ b/pages/common/electrum.md @@ -5,15 +5,15 @@ - Create a new wallet: -`electrum -w {{new_wallet.dat}} create` +`electrum {{[-w|--wallet]}} {{path/to/new_wallet.dat}} create` - Restore an existing wallet from seed offline: -`electrum -w {{recovery_wallet.dat}} restore -o` +`electrum {{[-w|--wallet]}} {{path/to/recovery_wallet.dat}} restore {{[-o|--offline]}}` - Create a signed transaction offline: -`electrum mktx {{recipient}} {{amount}} -f 0.0000001 -F {{from}} -o` +`electrum mktx {{recipient}} {{amount}} {{[-f|--fee]}} 0.0000001 {{[-F|--from-addr]}} {{from}} {{[-o|--offline]}}` - Display all wallet receiving addresses: @@ -29,4 +29,4 @@ - Connect only to a specific electrum-server instance: -`electrum -p socks5:{{127.0.0.1}}:9050 -s {{56ckl5obj37gypcu.onion}}:50001:t -1` +`electrum {{[-p|--proxy]}} socks5:{{127.0.0.1}}:9050 {{[-s|--server]}} {{56ckl5obj37gypcu.onion}}:50001:t {{[-1|--oneserver]}}` diff --git a/pages/common/elixir.md b/pages/common/elixir.md index 354a7579ce..2bb68fd732 100644 --- a/pages/common/elixir.md +++ b/pages/common/elixir.md @@ -9,4 +9,4 @@ - Evaluate Elixir code by passing it as an argument: -`elixir -e "{{code}}"` +`elixir {{[-e|--eval]}} "{{code}}"` diff --git a/pages/common/enca.md b/pages/common/enca.md index 0a9d3f2d7f..05b3108cf2 100644 --- a/pages/common/enca.md +++ b/pages/common/enca.md @@ -9,12 +9,12 @@ - Detect file(s) encoding specifying a language in the POSIX/C locale format (e.g. zh_CN, en_US): -`enca -L {{language}} {{path/to/file1 path/to/file2 ...}}` +`enca {{[-L|--language]}} {{language}} {{path/to/file1 path/to/file2 ...}}` - Convert file(s) to a specific encoding: -`enca -L {{language}} -x {{to_encoding}} {{path/to/file1 path/to/file2 ...}}` +`enca {{[-L|--language]}} {{language}} {{[-x|--convert-to]}} {{to_encoding}} {{path/to/file1 path/to/file2 ...}}` - Create a copy of an existing file using a different encoding: -`enca -L {{language}} -x {{to_encoding}} < {{original_file}} > {{new_file}}` +`enca {{[-L|--language]}} {{language}} {{[-x|--convert-to]}} {{to_encoding}} < {{original_file}} > {{new_file}}` diff --git a/pages/common/entr.md b/pages/common/entr.md index 2cee876b7f..56ee9ab09b 100644 --- a/pages/common/entr.md +++ b/pages/common/entr.md @@ -5,7 +5,7 @@ - Rebuild with `make` if any file in any subdirectory changes: -`{{ag -l}} | entr {{make}}` +`{{ag --files-with-matches}} | entr {{make}}` - Rebuild and test with `make` if any `.c` source files in the current directory change: diff --git a/pages/common/env.md b/pages/common/env.md index c5faecf31c..0d04a47e5a 100644 --- a/pages/common/env.md +++ b/pages/common/env.md @@ -25,4 +25,4 @@ - Set one or more variables and run a program: -`env {{variable1}}={{value}} {{variable2}}={{value}} {{variable3}}={{value}} {{program}}` +`env {{variable1=value variable2=value variable3=value ...}} {{program}}` diff --git a/pages/common/eslint.md b/pages/common/eslint.md index 9626f46d55..e9149e8b0a 100644 --- a/pages/common/eslint.md +++ b/pages/common/eslint.md @@ -17,4 +17,4 @@ - Lint using the specified configuration file: -`eslint -c {{path/to/config_file}} {{path/to/file1.js path/to/file2.js}}` +`eslint {{[-c|--config]}} {{path/to/config_file}} {{path/to/file1.js path/to/file2.js}}` diff --git a/pages/common/exiftool.md b/pages/common/exiftool.md index d86fef7767..75f9a1a894 100644 --- a/pages/common/exiftool.md +++ b/pages/common/exiftool.md @@ -25,7 +25,7 @@ - Move the date at which all JPEG photos in the current directory were taken 1 day and 2 hours backward: -`exiftool "-AllDates-=0:0:1 2:0:0" -ext jpg` +`exiftool "-AllDates-=0:0:1 2:0:0" {{[-ext|-extension]}} jpg` - Only change the `DateTimeOriginal` field subtracting 1.5 hours, without keeping backups: @@ -33,4 +33,4 @@ - Recursively rename all JPEG photos in a directory based on the `DateTimeOriginal` field: -`exiftool '-filename Display information about your operating system, software and hardware. -> More information: . +> More information: . - Display system information: `fastfetch` -- Fetch a specific structure: +- Display full system information with all the modules enabled: -`fastfetch --structure {{structure}}` +`fastfetch {{[-c|--config]}} all` - Load a custom configuration file: -`fastfetch --load-config {{path/to/config_file}}` +`fastfetch {{[-c|--config]}} {{path/to/config_file}}` + +- Fetch a specific structure: + +`fastfetch {{[-s|--structure]}} {{structure}}` - Use a specific logo: -`fastfetch --logo {{logo}}` +`fastfetch {{[-l|--logo]}} {{logo}}` - Display system information without a logo: -`fastfetch --logo none` +`fastfetch {{[-l|--logo]}} none` - Use a specific color for the keys and title: diff --git a/pages/common/fc-cache.md b/pages/common/fc-cache.md index 0889d3cb92..e4940617e4 100644 --- a/pages/common/fc-cache.md +++ b/pages/common/fc-cache.md @@ -9,8 +9,8 @@ - Force a rebuild of all font cache files, without checking if cache is up-to-date: -`fc-cache -f` +`fc-cache {{[-f|--force]}}` - Erase font cache files, then generate new font cache files: -`fc-cache -r` +`fc-cache {{[-r|--really-force]}}` diff --git a/pages/common/fc-list.md b/pages/common/fc-list.md index 2e42a2819f..569607699d 100644 --- a/pages/common/fc-list.md +++ b/pages/common/fc-list.md @@ -13,7 +13,7 @@ - Return the number of installed fonts in your system: -`fc-list | wc -l` +`fc-list | wc {{[-l|--lines]}}` - Return a list of installed fonts that support the language based on its locale code: diff --git a/pages/common/fc-match.md b/pages/common/fc-match.md index 632ec63677..e637eaf9e6 100644 --- a/pages/common/fc-match.md +++ b/pages/common/fc-match.md @@ -5,4 +5,4 @@ - Return a sorted list of best matching fonts: -`fc-match -s '{{DejaVu Serif}}'` +`fc-match {{[-s|--sort]}} '{{DejaVu Serif}}'` diff --git a/pages/common/fc-pattern.md b/pages/common/fc-pattern.md index 4c7c484939..3327da24c8 100644 --- a/pages/common/fc-pattern.md +++ b/pages/common/fc-pattern.md @@ -5,8 +5,8 @@ - Display default information about a font: -`fc-pattern --default '{{DejaVu Serif}}'` +`fc-pattern {{[-d|--default]}} '{{DejaVu Serif}}'` - Display configuration information about a font: -`fc-pattern --config '{{DejaVu Serif}}'` +`fc-pattern {{[-c|--config]}} '{{DejaVu Serif}}'` diff --git a/pages/common/fdupes.md b/pages/common/fdupes.md index de4bf317a4..c989af0c49 100644 --- a/pages/common/fdupes.md +++ b/pages/common/fdupes.md @@ -13,20 +13,20 @@ - Search a directory recursively: -`fdupes -r {{path/to/directory}}` +`fdupes {{[-r|--recurse]}} {{path/to/directory}}` - Search multiple directories, one recursively: -`fdupes {{directory1}} -R {{directory2}}` +`fdupes {{path/to/irectory1}} {{[-R|--recurse:]}} {{path/to/directory2}}` - Search recursively, considering hardlinks as duplicates: -`fdupes -rH {{path/to/directory}}` +`fdupes {{[-rH|--recurse --hardlinks]}} {{path/to/directory}}` - Search recursively for duplicates and display interactive prompt to pick which ones to keep, deleting the others: -`fdupes -rd {{path/to/directory}}` +`fdupes {{[-rd|--recurse --delete]}} {{path/to/directory}}` - Search recursively and delete duplicates without prompting: -`fdupes -rdN {{path/to/directory}}` +`fdupes {{[-rdN|--recurse --delete --noprompt]}} {{path/to/directory}}` diff --git a/pages/common/ffe.md b/pages/common/ffe.md index 17206805a6..b9acc1bbe8 100644 --- a/pages/common/ffe.md +++ b/pages/common/ffe.md @@ -6,24 +6,24 @@ - Display all input data using the specified data configuration: -`ffe --configuration={{path/to/config.ffe}} {{path/to/input}}` +`ffe {{[-c|--configuration]}} {{path/to/config.ffe}} {{path/to/input}}` - Convert an input file to an output file in a new format: -`ffe --output={{path/to/output}} -c {{path/to/config.ffe}} {{path/to/input}}` +`ffe --output={{path/to/output}} {{[-c|--configuration]}} {{path/to/config.ffe}} {{path/to/input}}` - Select input structure and print format from definitions in `~/.fferc` configuration file: -`ffe --structure={{structure}} --print={{format}} {{path/to/input}}` +`ffe {{[-s|--structure]}} {{structure}} {{[-p|--print]}} {{format}} {{path/to/input}}` - Write only the selected fields: -`ffe --field-list="{{FirstName,LastName,Age}}" -c {{path/to/config.ffe}} {{path/to/input}}` +`ffe {{[-f|--field-list]}} "{{FirstName,LastName,Age}}" {{[-c|--configuration]}} {{path/to/config.ffe}} {{path/to/input}}` - Write only the records that match an expression: -`ffe -e "{{LastName=Smith}}" -c {{path/to/config.ffe}} {{path/to/input}}` +`ffe {{[-e|--expression]}} "{{LastName=Smith}}" {{[-c|--configuration]}} {{path/to/config.ffe}} {{path/to/input}}` - Display help: -`ffe --help` +`ffe {{[-?|--help]}}` diff --git a/pages/common/ffprobe.md b/pages/common/ffprobe.md index 6841023251..464398d1f9 100644 --- a/pages/common/ffprobe.md +++ b/pages/common/ffprobe.md @@ -5,20 +5,20 @@ - Display all available stream info for a media file: -`ffprobe -v error -show_streams {{input.mp4}}` +`ffprobe {{[-v|-loglevel]}} error -show_streams {{input.mp4}}` - Display media duration: -`ffprobe -v error -show_entries format=duration -of default=noprint_wrappers=1:nokey=1 {{input.mp4}}` +`ffprobe {{[-v|-loglevel]}} error -show_entries format=duration {{[-of|-output_format]}} default=noprint_wrappers=1:nokey=1 {{input.mp4}}` - Display the frame rate of a video: -`ffprobe -v error -select_streams v:0 -show_entries stream=avg_frame_rate -of default=noprint_wrappers=1:nokey=1 {{input.mp4}}` +`ffprobe {{[-v|-loglevel]}} error -select_streams v:0 -show_entries stream=avg_frame_rate {{[-of|-output_format]}} default=noprint_wrappers=1:nokey=1 {{input.mp4}}` - Display the width or height of a video: -`ffprobe -v error -select_streams v:0 -show_entries stream={{width|height}} -of default=noprint_wrappers=1:nokey=1 {{input.mp4}}` +`ffprobe {{[-v|-loglevel]}} error -select_streams v:0 -show_entries stream={{width|height}} {{[-of|-output_format]}} default=noprint_wrappers=1:nokey=1 {{input.mp4}}` - Display the average bit rate of a video: -`ffprobe -v error -select_streams v:0 -show_entries stream=bit_rate -of default=noprint_wrappers=1:nokey=1 {{input.mp4}}` +`ffprobe {{[-v|-loglevel]}} error -select_streams v:0 -show_entries stream=bit_rate {{[-of|-output_format]}} default=noprint_wrappers=1:nokey=1 {{input.mp4}}` diff --git a/pages/common/fiascotopnm.md b/pages/common/fiascotopnm.md index b71dbd516c..f3739791bd 100644 --- a/pages/common/fiascotopnm.md +++ b/pages/common/fiascotopnm.md @@ -5,20 +5,20 @@ - Convert a compressed FIASCO file to a PNM file or in the case of video streams multiple PNM files: -`fiascotopnm {{path/to/file.fiasco}} -o {{output_file_basename}}` +`fiascotopnm {{path/to/file.fiasco}} {{[-o|--output]}} {{output_file_basename}}` - Use fast decompression, resulting in a slightly decreased quality of the output file(s): -`fiascotopnm --fast {{path/to/file.fiasco}} -o {{output_file_basename}}` +`fiascotopnm {{[-z|--fast]}} {{path/to/file.fiasco}} {{[-o|--output]}} {{output_file_basename}}` - Load the options to be used from the specified configuration file: -`fiascotopnm --config {{path/to/fiascorc}} {{path/to/file.fiasco}} -o {{output_file_basename}}` +`fiascotopnm {{[-f|--config]}} {{path/to/fiascorc}} {{path/to/file.fiasco}} {{[-o|--output]}} {{output_file_basename}}` - Magnify the decompressed image(s) by a factor of 2^n: -`fiascotopnm --magnify {{n}} {{path/to/file.fiasco}} -o {{output_file_basename}}` +`fiascotopnm {{[-m|--magnify]}} {{n}} {{path/to/file.fiasco}} {{[-o|--output]}} {{output_file_basename}}` - Smooth the decompressed image by the specified amount: -`fiascotopnm --smooth {{n}} {{path/to/file.fiasco}} -o {{output_file_basename}}` +`fiascotopnm {{[-s|--smoothing]}} {{n}} {{path/to/file.fiasco}} {{[-o|--output]}} {{output_file_basename}}` diff --git a/pages/common/figlist.md b/pages/common/figlist.md new file mode 100644 index 0000000000..216e61ae58 --- /dev/null +++ b/pages/common/figlist.md @@ -0,0 +1,21 @@ +# figlist + +> Lists the figlet fonts and control files. +> See also: `figlet`, `showfigfonts`, `chkfont`. +> More information: . + +- List all available fonts using the default font directory: + +`figlist` + +- List fonts from a custom directory: + +`figlist -d {{path/to/directory}}` + +- Search for a font by keyword: + +`figlist -d {{path/to/directory}} | grep {{keyword}}` + +- Count the total number of available fonts in a specified directory: + +`figlist -d {{path/to/directory}} | wc {{[-l|--lines]}}` diff --git a/pages/common/fin.md b/pages/common/fin.md index 51e9fb02c9..46747e1300 100644 --- a/pages/common/fin.md +++ b/pages/common/fin.md @@ -21,4 +21,4 @@ - Display logs of a specific container and follow the log: -`fin logs -f {{container_name}}` +`fin logs {{[-f|--follow]}} {{container_name}}` diff --git a/pages/common/flac.md b/pages/common/flac.md index 6bdde769ec..75ba1249d3 100644 --- a/pages/common/flac.md +++ b/pages/common/flac.md @@ -9,12 +9,12 @@ - Encode a WAV file to FLAC, specifying the output file: -`flac -o {{path/to/output.flac}} {{path/to/file.wav}}` +`flac {{[-o|--output-name]}} {{path/to/output.flac}} {{path/to/file.wav}}` - Decode a FLAC file to WAV, specifying the output file: -`flac -d -o {{path/to/output.wav}} {{path/to/file.flac}}` +`flac {{[-d|--decode]}} {{[-o|--output-name]}} {{path/to/output.wav}} {{path/to/file.flac}}` - Test a FLAC file for the correct encoding: -`flac -t {{path/to/file.flac}}` +`flac {{[-t|--test]}} {{path/to/file.flac}}` diff --git a/pages/common/flask.md b/pages/common/flask.md index e6e60f24a1..21e1e4b07b 100644 --- a/pages/common/flask.md +++ b/pages/common/flask.md @@ -1,7 +1,7 @@ # flask > A general utility script for Flask applications. Loads the application defined in the `FLASK_APP` environment variable. -> More information: . +> More information: . - Run a development server: diff --git a/pages/common/flow.md b/pages/common/flow.md index 3c4caf41f5..1ec8ce783b 100644 --- a/pages/common/flow.md +++ b/pages/common/flow.md @@ -1,7 +1,7 @@ # flow > A static type checker for JavaScript. -> More information: . +> More information: . - Run a flow check: diff --git a/pages/common/fly.md b/pages/common/fly.md index d8df5d3ba2..9e9e041fbf 100644 --- a/pages/common/fly.md +++ b/pages/common/fly.md @@ -5,7 +5,7 @@ - Authenticate with and save concourse target: -`fly --target {{target_name}} login --team-name {{team_name}} -c {{https://ci.example.com}}` +`fly {{[-t|--target]}} {{target_name}} login {{[-n|--team-name]}} {{team_name}} {{[-c|--concourse-url]}} {{https://ci.example.com}}` - List targets: @@ -13,24 +13,24 @@ - List pipelines: -`fly -t {{target_name}} pipelines` +`fly {{[-t|--target]}} {{target_name}} pipelines` - Upload or update a pipeline: -`fly -t {{target_name}} set-pipeline --config {{pipeline.yml}} --pipeline {{pipeline_name}}` +`fly {{[-t|--target]}} {{target_name}} set-pipeline {{[-c|--config]}} {{pipeline.yml}} {{[-p|--pipeline]}} {{pipeline_name}}` - Unpause pipeline: -`fly -t {{target_name}} unpause-pipeline --pipeline {{pipeline_name}}` +`fly {{[-t|--target]}} {{target_name}} unpause-pipeline {{[-p|--pipeline]}} {{pipeline_name}}` - Show pipeline configuration: -`fly -t {{target_name}} get-pipeline --pipeline {{pipeline_name}}` +`fly {{[-t|--target]}} {{target_name}} get-pipeline {{[-p|--pipeline]}} {{pipeline_name}}` - Update local copy of fly: -`fly -t {{target_name}} sync` +`fly {{[-t|--target]}} {{target_name}} sync` - Destroy pipeline: -`fly -t {{target_name}} destroy-pipeline --pipeline {{pipeline_name}}` +`fly {{[-t|--target]}} {{target_name}} destroy-pipeline {{[-p|--pipeline]}} {{pipeline_name}}` diff --git a/pages/common/forever.md b/pages/common/forever.md index e85d6c2ed6..afe68ff119 100644 --- a/pages/common/forever.md +++ b/pages/common/forever.md @@ -1,7 +1,7 @@ # forever > Server-side JavaScript application that makes sure Node.js applications run indefinitely (restarts after exit). -> More information: . +> More information: . - Start running a file forever (as a daemon): diff --git a/pages/common/fossa.md b/pages/common/fossa.md index fbb8d5962a..0aec8b5429 100644 --- a/pages/common/fossa.md +++ b/pages/common/fossa.md @@ -1,7 +1,7 @@ # fossa > CLI for the Fossa service - Generate realtime license audits, vulnerability scans and reports about dependencies licenses. -> More information: . +> More information: . - Initialize a `.fossa.yml` configuration file: diff --git a/pages/common/fswatch.md b/pages/common/fswatch.md index 07e5c9fa98..2f5749d532 100644 --- a/pages/common/fswatch.md +++ b/pages/common/fswatch.md @@ -5,16 +5,16 @@ - Run a Bash command on file creation, update or deletion: -`fswatch {{path/to/file}} | xargs -n 1 {{bash_command}}` +`fswatch {{path/to/file}} | xargs {{[-n|--max-args]}} 1 {{bash_command}}` - Watch one or more files and/or directories: -`fswatch {{path/to/file}} {{path/to/directory}} {{path/to/another_directory/**/*.js}} | xargs -n 1 {{bash_command}}` +`fswatch {{path/to/file}} {{path/to/directory}} {{path/to/another_directory/**/*.js}} | xargs {{[-n|--max-args]}} 1 {{bash_command}}` - Print the absolute paths of the changed files: -`fswatch {{path/to/directory}} | xargs -n 1 -I {} echo {}` +`fswatch {{path/to/directory}} | xargs {{[-n|--max-args]}} 1 -I _ echo _` - Filter by event type: -`fswatch --event {{Updated|Removed|Created|...}} {{path/to/directory}} | xargs -n 1 {{bash_command}}` +`fswatch --event {{Updated|Removed|Created|...}} {{path/to/directory}} | xargs {{[-n|--max-args]}} 1 {{bash_command}}` diff --git a/pages/common/fswebcam.md b/pages/common/fswebcam.md index 5838d1691b..0f3d6542f4 100644 --- a/pages/common/fswebcam.md +++ b/pages/common/fswebcam.md @@ -9,11 +9,11 @@ - Take a picture with custom resolution: -`fswebcam -r {{width}}x{{height}} {{filename}}` +`fswebcam {{[-r|--resolution]}} {{width}}x{{height}} {{filename}}` - Take a picture from selected device(Default is `/dev/video0`): -`fswebcam -d {{device}} {{filename}}` +`fswebcam {{[-d|--device]}} {{device}} {{filename}}` - Take a picture with timestamp(timestamp string is formatted by strftime): diff --git a/pages/common/gdrive.md b/pages/common/gdrive.md index 50b7b60974..c58e6d3074 100644 --- a/pages/common/gdrive.md +++ b/pages/common/gdrive.md @@ -6,7 +6,7 @@ - Upload a local path to the parent folder with the specified ID: -`gdrive upload -p {{id}} {{path/to/file_or_folder}}` +`gdrive upload {{[-p|--parent]}} {{id}} {{path/to/file_or_folder}}` - Download file or directory by ID to current directory: diff --git a/pages/common/gendesk.md b/pages/common/gendesk.md index 4daa54160a..05a19f179f 100644 --- a/pages/common/gendesk.md +++ b/pages/common/gendesk.md @@ -1,7 +1,7 @@ # gendesk > Specifies the command to generate a `.desktop` file and a download icon with minimal information. -> More information: . +> More information: . - Create a `.desktop` file named `app`: @@ -13,4 +13,4 @@ - Display help: -`gendesk -h` +`gendesk {{[-h|--help]}}` diff --git a/pages/common/getadusers.py.md b/pages/common/getadusers.py.md index d068fce077..01c3533890 100644 --- a/pages/common/getadusers.py.md +++ b/pages/common/getadusers.py.md @@ -18,4 +18,4 @@ - Save output to a file: -`GetADUsers.py -all -dc-ip {{domain_controller_ip}} {{domain}}/{{username}}:{{password}} > output.txt` +`GetADUsers.py -all -dc-ip {{domain_controller_ip}} {{domain}}/{{username}}:{{password}} > {{path/to/output.txt}}` diff --git a/pages/common/getnpusers.py.md b/pages/common/getnpusers.py.md index c9a6234211..bd95177261 100644 --- a/pages/common/getnpusers.py.md +++ b/pages/common/getnpusers.py.md @@ -22,4 +22,4 @@ - Save the output to a file for further analysis: -`GetNPUsers.py {{domain}}/ -usersfile {{path/to/userslist}} -dc-ip {{domain_controller_ip}} -request > {{output.txt}}` +`GetNPUsers.py {{domain}}/ -usersfile {{path/to/userslist}} -dc-ip {{domain_controller_ip}} -request > {{path/to/output.txt}}` diff --git a/pages/common/git-checkout.md b/pages/common/git-checkout.md index ca1bacc1c9..35f6a8147d 100644 --- a/pages/common/git-checkout.md +++ b/pages/common/git-checkout.md @@ -21,7 +21,7 @@ - Switch to an existing remote branch: -`git checkout --track {{remote_name}}/{{branch_name}}` +`git checkout {{[-t|--track]}} {{remote_name}}/{{branch_name}}` - Discard all unstaged changes in the current directory (see `git reset` for more undo-like commands): diff --git a/pages/common/git-clone.md b/pages/common/git-clone.md index 84d5088d7c..3e9f70e778 100644 --- a/pages/common/git-clone.md +++ b/pages/common/git-clone.md @@ -17,7 +17,7 @@ - Clone a local repository: -`git clone {{[-l|--local]]} {{path/to/local/repository}}` +`git clone {{[-l|--local]}} {{path/to/local/repository}}` - Clone quietly: diff --git a/pages/common/git-fetch.md b/pages/common/git-fetch.md index 1ec53eb0a1..4d28031b75 100644 --- a/pages/common/git-fetch.md +++ b/pages/common/git-fetch.md @@ -17,8 +17,8 @@ - Also fetch tags from the remote upstream repository: -`git fetch --tags` +`git fetch {{[-t|--tags]}}` - Delete local references to remote branches that have been deleted upstream: -`git fetch --prune` +`git fetch {{[-p|--prune]}}` diff --git a/pages/common/git-force-clone.md b/pages/common/git-force-clone.md index 61d22f55ad..39aeea319a 100644 --- a/pages/common/git-force-clone.md +++ b/pages/common/git-force-clone.md @@ -10,8 +10,8 @@ - Clone a Git repository into a new directory, checking out an specific branch: -`git force-clone -b {{branch_name}} {{remote_repository_location}} {{path/to/directory}}` +`git force-clone {{[-b|--branch]}} {{branch_name}} {{remote_repository_location}} {{path/to/directory}}` - Clone a Git repository into an existing directory of a Git repository, performing a force-reset to resemble it to the remote and checking out an specific branch: -`git force-clone -b {{branch_name}} {{remote_repository_location}} {{path/to/directory}}` +`git force-clone {{[-b|--branch]}} {{branch_name}} {{remote_repository_location}} {{path/to/directory}}` diff --git a/pages/common/git-guilt.md b/pages/common/git-guilt.md index 0b006e72ba..9d4a94f93e 100644 --- a/pages/common/git-guilt.md +++ b/pages/common/git-guilt.md @@ -14,15 +14,15 @@ - Show author emails instead of names: -`git guilt --email` +`git guilt {{[-e|--email]}}` - Ignore whitespace only changes when attributing blame: -`git guilt --ignore-whitespace` +`git guilt {{[-w|--ignore-whitespace]}}` - Find blame delta over the last three weeks: -`git guilt 'git log --until="3 weeks ago" --format="%H" -n 1'` +`git guilt 'git log --until="3 weeks ago" --format="%H" {{[-n|--max-count]}} 1'` - Find blame delta over the last three weeks (git 1.8.5+): diff --git a/pages/common/git-replace.md b/pages/common/git-replace.md index 34749127e6..ccb909c20a 100644 --- a/pages/common/git-replace.md +++ b/pages/common/git-replace.md @@ -9,7 +9,7 @@ - Delete existing replace refs for the given objects: -`git replace --delete {{object}}` +`git replace {{[-d|--delete]}} {{object}}` - Edit an object’s content interactively: diff --git a/pages/common/git-sed.md b/pages/common/git-sed.md index ab14d9b50d..f0f6f04c1f 100644 --- a/pages/common/git-sed.md +++ b/pages/common/git-sed.md @@ -2,7 +2,7 @@ > Replace patterns in git-controlled files using sed. > Part of `git-extras`. -> More information: . +> More information: . - Replace the specified text in the current repository: diff --git a/pages/common/git-show-ref.md b/pages/common/git-show-ref.md index a50bda49f8..88c6877453 100644 --- a/pages/common/git-show-ref.md +++ b/pages/common/git-show-ref.md @@ -9,7 +9,7 @@ - Show only heads references: -`git show-ref --heads` +`git show-ref --branches` - Show only tags references: diff --git a/pages/common/git-show.md b/pages/common/git-show.md index 4282e5a314..43a2ab3d6b 100644 --- a/pages/common/git-show.md +++ b/pages/common/git-show.md @@ -21,7 +21,7 @@ - Show a commit's message in a single line, suppressing the diff output: -`git show --oneline -s {{commit}}` +`git show --oneline {{[-s|--no-patch]}} {{commit}}` - Show only statistics (added/removed characters) about the changed files: diff --git a/pages/common/git-sizer.md b/pages/common/git-sizer.md index eb3c704679..6ca8a90cef 100644 --- a/pages/common/git-sizer.md +++ b/pages/common/git-sizer.md @@ -1,16 +1,16 @@ -# git sizer +# git-sizer > Computes various Git repository size metrics and alerts you to any that might cause problems or inconvenience. > More information: . - Report only statistics that have a level of concern greater than 0: -`git sizer` +`git-sizer` - Report all statistics: -`git sizer -v` +`git-sizer -v` - See additional options: -`git sizer -h` +`git-sizer -h` diff --git a/pages/common/git-standup.md b/pages/common/git-standup.md index 7a33870f45..02f8829084 100644 --- a/pages/common/git-standup.md +++ b/pages/common/git-standup.md @@ -2,7 +2,7 @@ > See commits from a specified user. > Part of `git-extras`. -> More information: . +> More information: . - Show a given author's commits from the last 10 days: diff --git a/pages/common/git-subtree.md b/pages/common/git-subtree.md index b4fbe56949..f7f76e2110 100644 --- a/pages/common/git-subtree.md +++ b/pages/common/git-subtree.md @@ -1,24 +1,24 @@ # git subtree > Manage project dependencies as subprojects. -> More information: . +> More information: . - Add a Git repository as a subtree: -`git subtree add --prefix={{path/to/directory/}} --squash {{repository_url}} {{branch_name}}` +`git subtree add {{[-P|--prefix]}} {{path/to/directory/}} --squash {{repository_url}} {{branch_name}}` - Update subtree repository to its latest commit: -`git subtree pull --prefix={{path/to/directory/}} {{repository_url}} {{branch_name}}` +`git subtree pull {{[-P|--prefix]}} {{path/to/directory/}} {{repository_url}} {{branch_name}}` - Merge recent changes up to the latest subtree commit into the subtree: -`git subtree merge --prefix={{path/to/directory/}} --squash {{repository_url}} {{branch_name}}` +`git subtree merge {{[-P|--prefix]}} {{path/to/directory/}} --squash {{repository_url}} {{branch_name}}` - Push commits to a subtree repository: -`git subtree push --prefix={{path/to/directory/}} {{repository_url}} {{branch_name}}` +`git subtree push {{[-P|--prefix]}} {{path/to/directory/}} {{repository_url}} {{branch_name}}` - Extract a new project history from the history of a subtree: -`git subtree split --prefix={{path/to/directory/}} {{repository_url}} -b {{branch_name}}` +`git subtree split {{[-P|--prefix]}} {{path/to/directory/}} {{repository_url}} {{[-b|--branch]}} {{branch_name}}` diff --git a/pages/common/git-symbolic-ref.md b/pages/common/git-symbolic-ref.md index d4854a1b55..10b778c0df 100644 --- a/pages/common/git-symbolic-ref.md +++ b/pages/common/git-symbolic-ref.md @@ -17,8 +17,8 @@ - Delete a reference by name: -`git symbolic-ref --delete refs/{{name}}` +`git symbolic-ref {{[-d|--delete]}} refs/{{name}}` - For scripting, hide errors with `--quiet` and use `--short` to simplify ("refs/heads/X" prints as "X"): -`git symbolic-ref --quiet --short refs/{{name}}` +`git symbolic-ref {{[-q|--quiet]}} --short refs/{{name}}` diff --git a/pages/common/git-sync.md b/pages/common/git-sync.md index fad003ed37..46600d194a 100644 --- a/pages/common/git-sync.md +++ b/pages/common/git-sync.md @@ -2,7 +2,7 @@ > Sync local branches with remote branches. > Part of `git-extras`. -> More information: . +> More information: . - Sync the current local branch with its remote branch: @@ -14,4 +14,4 @@ - Sync without cleaning untracked files: -`git sync -s {{remote_name}} {{branch_name}}` +`git sync {{[-s|--soft]}} {{remote_name}} {{branch_name}}` diff --git a/pages/common/git.md b/pages/common/git.md index a8adb83be0..2dd3e8a99d 100644 --- a/pages/common/git.md +++ b/pages/common/git.md @@ -18,7 +18,7 @@ - Display help: -`git --help` +`git {{[-h|--help]}}` - Display help for a specific subcommand (like `clone`, `add`, `push`, `log`, etc.): @@ -26,4 +26,4 @@ - Display version: -`git --version` +`git {{[-v|--version]}}` diff --git a/pages/common/glab-repo.md b/pages/common/glab-repo.md index 726e35d61e..e98221d8fe 100644 --- a/pages/common/glab-repo.md +++ b/pages/common/glab-repo.md @@ -13,12 +13,12 @@ - Fork and clone a repository: -`glab repo fork {{owner}}/{{repository}} --clone` +`glab repo fork {{owner}}/{{repository}} {{[-c|--clone]}}` - View a repository in the default web browser: -`glab repo view {{owner}}/{{repository}} --web` +`glab repo view {{owner}}/{{repository}} {{[-w|--web]}}` - Search some repositories in the GitLab instance: -`glab repo search -s {{search_string}}` +`glab repo search {{[-s|--search]}} {{search_string}}` diff --git a/pages/common/glow.md b/pages/common/glow.md index b488f6f6be..8648dc30a7 100644 --- a/pages/common/glow.md +++ b/pages/common/glow.md @@ -13,7 +13,7 @@ - View a Markdown file using a paginator: -`glow -p {{path/to/file}}` +`glow {{[-p|--pager]}} {{path/to/file}}` - View a file from a URL: diff --git a/pages/common/gnmic-get.md b/pages/common/gnmic-get.md index 583050fafa..f9a1927190 100644 --- a/pages/common/gnmic-get.md +++ b/pages/common/gnmic-get.md @@ -5,16 +5,16 @@ - Get a snapshot of the device state at a specific path: -`gnmic --address {{ip:port}} get --path {{path}}` +`gnmic {{[-a|--address]}} {{ip:port}} get --path {{path}}` - Query the device state at multiple paths: -`gnmic -a {{ip:port}} get --path {{path/to/file_or_directory1}} --path {{path/to/file_or_directory2}}` +`gnmic {{[-a|--address]}} {{ip:port}} get --path {{path/to/file_or_directory1}} --path {{path/to/file_or_directory2}}` - Query the device state at multiple paths with a common prefix: -`gnmic -a {{ip:port}} get --prefix {{prefix}} --path {{path/to/file_or_directory1}} --path {{path/to/file_or_directory2}}` +`gnmic {{[-a|--address]}} {{ip:port}} get --prefix {{prefix}} --path {{path/to/file_or_directory1}} --path {{path/to/file_or_directory2}}` - Query the device state and specify response encoding (json_ietf): -`gnmic -a {{ip:port}} get --path {{path}} --encoding json_ietf` +`gnmic {{[-a|--address]}} {{ip:port}} get --path {{path}} {{[-e|--encoding]}} json_ietf` diff --git a/pages/common/gnmic-set.md b/pages/common/gnmic-set.md index 6ac6b2f33f..05694e250a 100644 --- a/pages/common/gnmic-set.md +++ b/pages/common/gnmic-set.md @@ -5,16 +5,16 @@ - Update the value of a path: -`gnmic --address {{ip:port}} set --update-path {{path}} --update-value {{value}}` +`gnmic {{[-a|--address]}} {{ip:port}} set --update-path {{path}} --update-value {{value}}` - Update the value of a path to match the contents of a JSON file: -`gnmic -a {{ip:port}} set --update-path {{path}} --update-file {{filepath}}` +`gnmic {{[-a|--address]}} {{ip:port}} set --update-path {{path}} --update-file {{filepath}}` - Replace the value of a path to match the contents of a JSON file: -`gnmic -a {{ip:port}} set --replace-path {{path}} --replace-file {{filepath}}` +`gnmic {{[-a|--address]}} {{ip:port}} set --replace-path {{path}} --replace-file {{filepath}}` - Delete the node at a given path: -`gnmic -a {{ip:port}} set --delete {{path}}` +`gnmic {{[-a|--address]}} {{ip:port}} set --delete {{path}}` diff --git a/pages/common/gnmic-subscribe.md b/pages/common/gnmic-subscribe.md index a2079a015e..fecdef5470 100644 --- a/pages/common/gnmic-subscribe.md +++ b/pages/common/gnmic-subscribe.md @@ -5,20 +5,20 @@ - Subscribe to target state updates under the subtree of a specific path: -`gnmic --address {{ip:port}} subscribe --path {{path}}` +`gnmic {{[-a|--address]}} {{ip:port}} subscribe --path {{path}}` - Subscribe to a target with a sample interval of 30s (default is 10s): -`gnmic -a {{ip:port}} subscribe --path {{path}} --sample-interval 30s` +`gnmic {{[-a|--address]}} {{ip:port}} subscribe --path {{path}} --sample-interval 30s` - Subscribe to a target with sample interval and updates only on change: -`gnmic -a {{ip:port}} subscribe --path {{path}} --stream-mode on-change --heartbeat-interval 1m` +`gnmic {{[-a|--address]}} {{ip:port}} subscribe --path {{path}} --stream-mode on-change --heartbeat-interval 1m` - Subscribe to a target for only one update: -`gnmic -a {{ip:port}} subscribe --path {{path}} --mode once` +`gnmic {{[-a|--address]}} {{ip:port}} subscribe --path {{path}} --mode once` - Subscribe to a target and specify response encoding (json_ietf): -`gnmic -a {{ip:port}} subscribe --path {{path}} --encoding json_ietf` +`gnmic {{[-a|--address]}} {{ip:port}} subscribe --path {{path}} {{[-e|--encoding]}} json_ietf` diff --git a/pages/common/gnmic.md b/pages/common/gnmic.md index d0a06a6587..622d7c1ace 100644 --- a/pages/common/gnmic.md +++ b/pages/common/gnmic.md @@ -6,20 +6,20 @@ - Request device capabilities: -`gnmic --address {{ip:port}} capabilities` +`gnmic {{[-a|--address]}} {{ip:port}} capabilities` - Provide a username and password to fetch device capabilities: -`gnmic --address {{ip:port}} --username {{username}} --password {{password}} capabilities` +`gnmic {{[-a|--address]}} {{ip:port}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} capabilities` - Get a snapshot of the device state at a specific path: -`gnmic -a {{ip:port}} get --path {{path}}` +`gnmic {{[-a|--address]}} {{ip:port}} get --path {{path}}` - Update device state at a specific path: -`gnmic -a {{ip:port}} set --update-path {{path}} --update-value {{value}}` +`gnmic {{[-a|--address]}} {{ip:port}} set --update-path {{path}} --update-value {{value}}` - Subscribe to target state updates under the subtree at a specific path: -`gnmic -a {{ip:port}} subscribe --path {{path}}` +`gnmic {{[-a|--address]}} {{ip:port}} subscribe --path {{path}}` diff --git a/pages/common/gocryptfs.md b/pages/common/gocryptfs.md index 6d3a81c1a1..81c0b01f32 100644 --- a/pages/common/gocryptfs.md +++ b/pages/common/gocryptfs.md @@ -1,7 +1,7 @@ # gocryptfs > Encrypted overlay filesystem written in Go. -> More information: . +> More information: . - Initialize an encrypted filesystem: diff --git a/pages/common/godot.md b/pages/common/godot.md index 85d918cb80..4e6be8fd77 100644 --- a/pages/common/godot.md +++ b/pages/common/godot.md @@ -9,11 +9,11 @@ - Edit a project (the current directory must contain a `project.godot` file): -`godot -e` +`godot {{[-e|--editor]}}` - Open the project manager even if the current directory contains a `project.godot` file: -`godot -p` +`godot {{[-p|--project-manager]}}` - Export a project for a given export preset (the preset must be defined in the project): @@ -21,4 +21,4 @@ - Execute a standalone GDScript file (the script must inherit from `SceneTree` or `MainLoop`): -`godot -s {{script.gd}}` +`godot {{[-s|--script]}} {{script.gd}}` diff --git a/pages/common/gomi.md b/pages/common/gomi.md new file mode 100644 index 0000000000..3f4efa7936 --- /dev/null +++ b/pages/common/gomi.md @@ -0,0 +1,21 @@ +# gomi + +> Manage the trashcan. +> See also: `trash`, `rm`. +> More information: . + +- Safely delete specific files or folders: + +`gomi {{path/to/file1 path/to/file2 path/to/folder1 path/to/folder2 ...}}` + +- Open an interactive menu to restore one or more files: + +`gomi {{[-b|--restore]}}` + +- Remove files that have been in the trashcan longer than the specified time ([d]ay, [w]eek, [m]onth, [y]ear): + +`gomi --prune {{1d|1w|1m|1y|...}}` + +- Remove orphaned `.trashinfo` files: + +`gomi --prune {{orphans}}` diff --git a/pages/common/googler.md b/pages/common/googler.md index 7cb8e68a62..0c64baaaa7 100644 --- a/pages/common/googler.md +++ b/pages/common/googler.md @@ -9,19 +9,19 @@ - Search Google and open the first result in web browser: -`googler -j {{keyword}}` +`googler {{[-j|--first]}} {{keyword}}` - Show `n` search results (default: 10): -`googler -n {{n}} {{keyword}}` +`googler {{[-n|--count]}} {{n}} {{keyword}}` - Disable automatic spelling correction: -`googler -x {{keyword}}` +`googler {{[-x|--exact]}} {{keyword}}` - Search one site for a keyword: -`googler -w {{site}} {{keyword}}` +`googler {{[-w|--site]}} {{site}} {{keyword}}` - Show Google search result in JSON format: @@ -29,7 +29,7 @@ - Perform in-place self-upgrade: -`googler -u` +`googler {{[-u|--upgrade]}}` - Display help in interactive mode: diff --git a/pages/common/goreload.md b/pages/common/goreload.md index ce86da106b..ff5e453603 100644 --- a/pages/common/goreload.md +++ b/pages/common/goreload.md @@ -5,7 +5,7 @@ - Watch a binary file (defaults to `.goreload`): -`goreload -b {{path/to/binary}} {{path/to/file.go}}` +`goreload {{[-b|--bin]}} {{path/to/binary}} {{path/to/file.go}}` - Set a custom log prefix (defaults to `goreload`): diff --git a/pages/common/gotty.md b/pages/common/gotty.md index 9c686865ad..92a93cff8e 100644 --- a/pages/common/gotty.md +++ b/pages/common/gotty.md @@ -9,8 +9,8 @@ - Share with write permission: -`gotty -w {{shell}}` +`gotty {{[-w|--permit-write]}} {{shell}}` - Share with credential (Basic Auth): -`gotty -w -c {{username}}:{{password}} {{shell}}` +`gotty {{[-w|--permit-write]}} {{[-c|--credential]}} {{username}}:{{password}} {{shell}}` diff --git a/pages/common/gource.md b/pages/common/gource.md index 35d776d31a..cd8f09bdf2 100644 --- a/pages/common/gource.md +++ b/pages/common/gource.md @@ -12,18 +12,26 @@ `gource -{{width}}x{{height}}` -- Specify the timescale for the animation: - -`gource -c {{time_scale_multiplier}}` - - Specify how long each day should be in the animation (this combines with -c, if provided): -`gource -s {{seconds}}` +`gource {{[-s|--seconds-per-day]}} {{seconds}}` - Use fullscreen mode and a custom background color: -`gource -f -b {{hex_color_code}}` +`gource {{[-f|--fullscreen ]}} {{[-b|--background-colour]}} {{hex_color_code}}` - Specify the animation title: `gource --title {{title}}` + +- Pause the animation: + +`` + +- Adjust simulation speed: + +`<{{+|-}}>` + +- Display help: + +`gource {{[-h|--help]}}` diff --git a/pages/common/gprbuild.md b/pages/common/gprbuild.md index dc23438124..007baad518 100644 --- a/pages/common/gprbuild.md +++ b/pages/common/gprbuild.md @@ -9,7 +9,7 @@ - Build a specific [P]roject file: -`gprbuild -P{{project_name}}` +`gprbuild -P {{project_name}}` - Clean up the build workspace: diff --git a/pages/common/gprof.md b/pages/common/gprof.md index 3e1ae78963..96e82cc0c0 100644 --- a/pages/common/gprof.md +++ b/pages/common/gprof.md @@ -2,7 +2,7 @@ > Performance analysis tool for many programming languages. > It profiles the function executions of a program. -> More information: . +> More information: . - Compile binary to default `a.out` with gprof information and run it to get `gmon.out`: diff --git a/pages/common/gradle.md b/pages/common/gradle.md index e676ebd882..d4fa12b10b 100644 --- a/pages/common/gradle.md +++ b/pages/common/gradle.md @@ -9,7 +9,7 @@ - Exclude test task: -`gradle build -x {{test}}` +`gradle build {{[-x|--exclude-task]}} {{test}}` - Run in offline mode to prevent Gradle from accessing the network during builds: diff --git a/pages/common/grex.md b/pages/common/grex.md index 2df58dc9b5..e90347438d 100644 --- a/pages/common/grex.md +++ b/pages/common/grex.md @@ -9,20 +9,20 @@ - Generate a case-insensitive regular expression: -`grex -i {{space_separated_strings}}` +`grex {{[-i|--ignore-case]}} {{space_separated_strings}}` - Replace digits with '\d': -`grex -d {{space_separated_strings}}` +`grex {{[-d|--digits]}} {{space_separated_strings}}` - Replace Unicode word character with '\w': -`grex -w {{space_separated_strings}}` +`grex {{[-w|--words]}} {{space_separated_strings}}` - Replace spaces with '\s': -`grex -s {{space_separated_strings}}` +`grex {{[-s|--spaces]}} {{space_separated_strings}}` - Add {min, max} quantifier representation for repeating sub-strings: -`grex -r {{space_separated_strings}}` +`grex {{[-r|--repetitions]}} {{space_separated_strings}}` diff --git a/pages/common/grumphp.md b/pages/common/grumphp.md index 1bf720575e..cdd9d4bb34 100644 --- a/pages/common/grumphp.md +++ b/pages/common/grumphp.md @@ -1,7 +1,7 @@ # grumphp > A PHP Composer plugin that enables source code quality checks. -> More information: . +> More information: . - Register the Git hooks: diff --git a/pages/common/gst-inspect-1.0.md b/pages/common/gst-inspect-1.0.md index 4f74e45dd7..c1cea4c299 100644 --- a/pages/common/gst-inspect-1.0.md +++ b/pages/common/gst-inspect-1.0.md @@ -1,7 +1,7 @@ # gst-inspect-1.0 > Print information on GStreamer plugins. -> More information: . +> More information: . - Print information on a plugin: diff --git a/pages/common/gst-launch-1.0.md b/pages/common/gst-launch-1.0.md index 6c7b0e5c15..471aa8a540 100644 --- a/pages/common/gst-launch-1.0.md +++ b/pages/common/gst-launch-1.0.md @@ -1,7 +1,7 @@ # gst-launch-1.0 > Build and run a GStreamer pipeline. -> More information: . +> More information: . - Play test video in a window: diff --git a/pages/common/guacd.md b/pages/common/guacd.md index 2d0ed6090c..d7fd9bc94b 100644 --- a/pages/common/guacd.md +++ b/pages/common/guacd.md @@ -2,7 +2,7 @@ > Apache Guacamole proxy daemon. > Support loader for client plugins to interface between the Guacamole protocol and any arbitrary remote desktop protocol (e.g. RDP, VNC, Other). -> More information: . +> More information: . - Bind to a specific port on localhost: diff --git a/pages/common/gunicorn.md b/pages/common/gunicorn.md index 443f9d9171..2e1566fd5e 100644 --- a/pages/common/gunicorn.md +++ b/pages/common/gunicorn.md @@ -1,7 +1,7 @@ # gunicorn > Python WSGI HTTP Server. -> More information: . +> More information: . - Run Python web app: @@ -9,7 +9,7 @@ - Listen on port 8080 on localhost: -`gunicorn --bind {{localhost}}:{{8080}} {{import.path:app_object}}` +`gunicorn {{[-b|--bind]}} {{localhost}}:{{8080}} {{import.path:app_object}}` - Turn on live reload: @@ -17,7 +17,7 @@ - Use 4 worker processes for handling requests: -`gunicorn --workers {{4}} {{import.path:app_object}}` +`gunicorn {{[-w|--workers]}} {{4}} {{import.path:app_object}}` - Use 4 worker threads for handling requests: diff --git a/pages/common/hexyl.md b/pages/common/hexyl.md index 6fe0f83208..06f71816a5 100644 --- a/pages/common/hexyl.md +++ b/pages/common/hexyl.md @@ -9,7 +9,7 @@ - Print the hexadecimal representation of the first n bytes of a file: -`hexyl -n {{n}} {{path/to/file}}` +`hexyl {{[-n|--length]}} {{n}} {{path/to/file}}` - Print bytes 512 through 1024 of a file: diff --git a/pages/common/hg-add.md b/pages/common/hg-add.md index 9de6377b34..86c8d4b62b 100644 --- a/pages/common/hg-add.md +++ b/pages/common/hg-add.md @@ -9,16 +9,16 @@ - Add all unstaged files matching a specified pattern: -`hg add --include {{pattern}}` +`hg add {{[-I|--include]}} {{pattern}}` - Add all unstaged files, excluding those that match a specified pattern: -`hg add --exclude {{pattern}}` +`hg add {{[-X|--exclude]}} {{pattern}}` - Recursively add sub-repositories: -`hg add --subrepos` +`hg add {{[-S|--subrepos]}}` - Perform a test-run without performing any actions: -`hg add --dry-run` +`hg add {{[-n|--dry-run]}}` diff --git a/pages/common/hg-commit.md b/pages/common/hg-commit.md index 9b727e8d35..067ca2382a 100644 --- a/pages/common/hg-commit.md +++ b/pages/common/hg-commit.md @@ -13,16 +13,16 @@ - Commit with a specific message: -`hg commit --message {{message}}` +`hg commit {{[-m|--message]}} {{message}}` - Commit all files matching a specified pattern: -`hg commit --include {{pattern}}` +`hg commit {{[-I|--include]}} {{pattern}}` - Commit all files, excluding those that match a specified pattern: -`hg commit --exclude {{pattern}}` +`hg commit {{[-X|--exclude]}} {{pattern}}` - Commit using the interactive mode: -`hg commit --interactive` +`hg commit {{[-i|--interactive]}}` diff --git a/pages/common/hg-log.md b/pages/common/hg-log.md index 9e3875ecb2..2eef4e4790 100644 --- a/pages/common/hg-log.md +++ b/pages/common/hg-log.md @@ -9,28 +9,28 @@ - Display the revision history with an ASCII graph: -`hg log --graph` +`hg log {{[-G|--graph]}}` - Display the revision history with file names matching a specified pattern: -`hg log --include {{pattern}}` +`hg log {{[-I|--include]}} {{pattern}}` - Display the revision history, excluding file names that match a specified pattern: -`hg log --exclude {{pattern}}` +`hg log {{[-X|--exclude]}} {{pattern}}` - Display the log information for a specific revision: -`hg log --rev {{revision}}` +`hg log {{[-r|--rev]}} {{revision}}` - Display the revision history for a specific branch: -`hg log --branch {{branch}}` +`hg log {{[-b|--branch]}} {{branch}}` - Display the revision history for a specific date: -`hg log --date {{date}}` +`hg log {{[-d|--date]}} {{date}}` - Display revisions committed by a specific user: -`hg log --user {{user}}` +`hg log {{[-u|--user]}} {{user}}` diff --git a/pages/common/hg-pull.md b/pages/common/hg-pull.md index 762c482694..1b87b189aa 100644 --- a/pages/common/hg-pull.md +++ b/pages/common/hg-pull.md @@ -13,20 +13,20 @@ - Update the local repository to the head of the remote: -`hg pull --update` +`hg pull {{[-u|--update]}}` - Pull changes even when the remote repository is unrelated: -`hg pull --force` +`hg pull {{[-f|--force]}}` - Specify a specific revision changeset to pull up to: -`hg pull --rev {{revision}}` +`hg pull {{[-r|--rev]}} {{revision}}` - Specify a specific branch to pull: -`hg pull --branch {{branch}}` +`hg pull {{[-b|--branch]}} {{branch}}` - Specify a specific bookmark to pull: -`hg pull --bookmark {{bookmark}}` +`hg pull {{[-B|--bookmark]}} {{bookmark}}` diff --git a/pages/common/hg-push.md b/pages/common/hg-push.md index 4296da65ef..b26b393771 100644 --- a/pages/common/hg-push.md +++ b/pages/common/hg-push.md @@ -17,12 +17,12 @@ - Specify a specific revision changeset to push: -`hg push --rev {{revision}}` +`hg push {{[-r|--rev]}} {{revision}}` - Specify a specific branch to push: -`hg push --branch {{branch}}` +`hg push {{[-b|--branch]}} {{branch}}` - Specify a specific bookmark to push: -`hg push --bookmark {{bookmark}}` +`hg push {{[-B|--bookmark]}} {{bookmark}}` diff --git a/pages/common/hg-remove.md b/pages/common/hg-remove.md index 032f233612..2c937f52bb 100644 --- a/pages/common/hg-remove.md +++ b/pages/common/hg-remove.md @@ -9,16 +9,16 @@ - Remove all staged files matching a specified pattern: -`hg remove --include {{pattern}}` +`hg remove {{[-I|--include]}} {{pattern}}` - Remove all staged files, excluding those that match a specified pattern: -`hg remove --exclude {{pattern}}` +`hg remove {{[-X|--exclude]}} {{pattern}}` - Recursively remove sub-repositories: -`hg remove --subrepos` +`hg remove {{[-S|--subrepos]}}` - Remove files from the repository that have been physically removed: -`hg remove --after` +`hg remove {{[-A|--after]}}` diff --git a/pages/common/hg-serve.md b/pages/common/hg-serve.md index 40020c52f9..508fc0dc66 100644 --- a/pages/common/hg-serve.md +++ b/pages/common/hg-serve.md @@ -9,15 +9,15 @@ - Start a web server instance on the specified port: -`hg serve --port {{port}}` +`hg serve {{[-p|--port]}} {{port}}` - Start a web server instance on the specified listening address: -`hg serve --address {{address}}` +`hg serve {{[-a|--address]}} {{address}}` - Start a web server instance with a specific identifier: -`hg serve --name {{name}}` +`hg serve {{[-n|--name]}} {{name}}` - Start a web server instance using the specified theme (see the templates directory): diff --git a/pages/common/hg-status.md b/pages/common/hg-status.md index a5e6373c7f..8f29d401da 100644 --- a/pages/common/hg-status.md +++ b/pages/common/hg-status.md @@ -9,19 +9,19 @@ - Display only modified files: -`hg status --modified` +`hg status {{[-m|--modified]}}` - Display only added files: -`hg status --added` +`hg status {{[-a|--added]}}` - Display only removed files: -`hg status --removed` +`hg status {{[-r|--removed]}}` - Display only deleted (but tracked) files: -`hg status --deleted` +`hg status {{[-d|--deleted]}}` - Display changes in the working directory compared to a specified changeset: @@ -29,8 +29,8 @@ - Display only files matching a specified glob pattern: -`hg status --include {{pattern}}` +`hg status {{[-I|--include]}} {{pattern}}` - Display files, excluding those that match a specified glob pattern: -`hg status --exclude {{pattern}}` +`hg status {{[-X|--exclude]}} {{pattern}}` diff --git a/pages/common/hg-update.md b/pages/common/hg-update.md index e0a4e9823c..723d351ed1 100644 --- a/pages/common/hg-update.md +++ b/pages/common/hg-update.md @@ -9,12 +9,12 @@ - Update to the specified revision: -`hg update --rev {{revision}}` +`hg update {{[-r|--rev]}} {{revision}}` - Update and discard uncommitted changes: -`hg update --clean` +`hg update {{[-C|--clean]}}` - Update to the last commit matching a specified date: -`hg update --date {{dd-mm-yyyy}}` +`hg update {{[-d|--date]}} {{dd-mm-yyyy}}` diff --git a/pages/common/hive.md b/pages/common/hive.md index 805edcbab6..7d180f5481 100644 --- a/pages/common/hive.md +++ b/pages/common/hive.md @@ -13,7 +13,7 @@ - Run a HiveQL file with a variable substitution: -`hive --define {{key}}={{value}} -f {{path/to/file.sql}}` +`hive {{[-d|--define]}} {{key}}={{value}} -f {{path/to/file.sql}}` - Run a HiveQL with HiveConfig (e.g. `mapred.reduce.tasks=32`): diff --git a/pages/common/hledger-accounts.md b/pages/common/hledger-accounts.md index 82cf3498bc..d86ffc8293 100644 --- a/pages/common/hledger-accounts.md +++ b/pages/common/hledger-accounts.md @@ -5,31 +5,31 @@ - Show all accounts used or declared in the default journal file: -`hledger accounts` +`hledger {{[acc|accounts]}}` - Show accounts used by transactions: -`hledger accounts --used` +`hledger {{[acc|accounts]}} {{[-u|--used]}}` - Show accounts declared with account directives: -`hledger accounts --declared` +`hledger {{[acc|accounts]}} {{[-d|--declared]}}` - Add new account directives, for accounts used but not declared, to the journal: -`hledger accounts --undeclared --directives >> {{2024-accounts.journal}}` +`hledger {{[acc|accounts]}} --undeclared --directives >> {{2024-accounts.journal}}` - Show accounts with `asset` in their name, and their declared/inferred types: -`hledger accounts asset --types` +`hledger {{[acc|accounts]}} asset --types` - Show accounts of the `Asset` type: -`hledger accounts type:A` +`hledger {{[acc|accounts]}} type:A` - Show the first two levels of the accounts hierarchy: -`hledger accounts --tree --depth 2` +`hledger {{[acc|accounts]}} {{[-t|--tree]}} --depth 2` - Short form of the above: diff --git a/pages/common/hledger-add.md b/pages/common/hledger-add.md index 8e61e09c6d..afb9bd7142 100644 --- a/pages/common/hledger-add.md +++ b/pages/common/hledger-add.md @@ -9,7 +9,7 @@ - Add transactions to `2024.journal`, but also load `2023.journal` for completions: -`hledger add --file {{path/to/2024.journal}} --file {{path/to/2023.journal}}` +`hledger add {{[-f|--file]}} {{path/to/2024.journal}} {{[-f|--file]}} {{path/to/2023.journal}}` - Provide answers for the first four prompts: @@ -17,7 +17,7 @@ - Show `add`'s options and documentation with `$PAGER`: -`hledger add --help` +`hledger add {{[-h|--help]}}` - Show `add`'s documentation with `info` or `man` if available: diff --git a/pages/common/hledger-aregister.md b/pages/common/hledger-aregister.md index 5d793532c6..72dd88c662 100644 --- a/pages/common/hledger-aregister.md +++ b/pages/common/hledger-aregister.md @@ -5,16 +5,16 @@ - Show transactions and running balance in the `assets:bank:checking` account: -`hledger aregister assets:bank:checking` +`hledger {{[areg|aregister]}} assets:bank:checking` - Show transactions and running balance in the first account named `*savings*`: -`hledger aregister savings` +`hledger {{[areg|aregister]}} savings` - Show the checking account's cleared transactions, with a specified width: -`hledger aregister checking --cleared --width {{120}}` +`hledger {{[areg|aregister]}} checking {{[-C|--cleared]}} {{[-w|--width]}} {{120}}` - Show the checking register, including transactions from forecast rules: -`hledger aregister checking --forecast` +`hledger {{[areg|aregister]}} checking --forecast` diff --git a/pages/common/hledger-balance.md b/pages/common/hledger-balance.md index 6dcd62889b..56be809eb8 100644 --- a/pages/common/hledger-balance.md +++ b/pages/common/hledger-balance.md @@ -6,15 +6,15 @@ - Show the balance change in all accounts from all postings over all time: -`hledger balance` +`hledger {{[bal|balance]}}` - Show the balance change in accounts named `*expenses*`, as a tree, summarising the top two levels only: -`hledger balance {{expenses}} --tree --depth {{2}}` +`hledger {{[bal|balance]}} {{expenses}} {{[-t|--tree]}} --depth {{2}}` - Show expenses each month, and their totals and averages, sorted by total; and their monthly budget goals: -`hledger balance {{expenses}} --monthly --row-total --average --sort-amount --budget` +`hledger {{[bal|balance]}} {{expenses}} {{[-M|--monthly]}} {{[-T|--row-total]}} {{[-A|--average]}} {{[-S|--sort-amount]}} --budget` - Similar to the above, shorter form, matching accounts by `Expense` type, as a two level tree without squashing boring accounts: @@ -22,7 +22,7 @@ - Show end balances (including from postings before the start date), quarterly in 2024, in accounts named `*assets*` or `*liabilities*`: -`hledger balance --historical --period '{{quarterly in 2024}}' {{assets}} {{liabilities}}` +`hledger {{[bal|balance]}} {{[-H|--historical]}} {{[-p|--period]}} '{{quarterly in 2024}}' {{assets}} {{liabilities}}` - Similar to the above, shorter form; also show zero balances, sort by total and summarise to three levels: diff --git a/pages/common/hledger-balancesheet.md b/pages/common/hledger-balancesheet.md index 2d20a634b2..e5c1dfdb33 100644 --- a/pages/common/hledger-balancesheet.md +++ b/pages/common/hledger-balancesheet.md @@ -6,27 +6,27 @@ - Show the current balances in `Asset` and `Liability` accounts, excluding zeros: -`hledger balancesheet` +`hledger {{[bs|balancesheet]}}` - Show just the liquid assets (`Cash` account type): -`hledger balancesheet type:C` +`hledger {{[bs|balancesheet]}} type:C` - Include accounts with zero balances, and show the account hierarchy: -`hledger balancesheet --empty --tree` +`hledger {{[bs|balancesheet]}} {{[-E|--empty]}} {{[-t|--tree]}}` - Show the balances at the end of each month: -`hledger balancesheet --monthly` +`hledger {{[bs|balancesheet]}} {{[-M|--monthly]}}` - Show the balances' market value in home currency at the end of each month: -`hledger balancesheet --monthly -V` +`hledger {{[bs|balancesheet]}} {{[-M|--monthly]}} {{[-V|--market]}}` - Show quarterly balances, with just the top two levels of account hierarchy: -`hledger balancesheet --quarterly --tree --depth 2` +`hledger {{[bs|balancesheet]}} {{[-Qt|--quarterly --tree]}} {{[-2|--depth 2]}}` - Short form of the above, and generate HTML output in `bs.html`: diff --git a/pages/common/hledger-import.md b/pages/common/hledger-import.md index d1d7a82ce4..ab161d963e 100644 --- a/pages/common/hledger-import.md +++ b/pages/common/hledger-import.md @@ -17,7 +17,7 @@ - Show conversion errors or results while editing `bank.csv.rules`: -`watchexec -- hledger -f {{path/to/bank.csv}} print` +`watchexec -- hledger {{[-f|--file]}} {{path/to/bank.csv}} print` - Mark `bank.csv`'s current data as seen, as if already imported: @@ -25,4 +25,4 @@ - Mark `bank.csv` as all new, as if not yet imported: -`rm -f .latest.bank.csv` +`rm {{[-f|--force]}} .latest.bank.csv` diff --git a/pages/common/hledger-incomestatement.md b/pages/common/hledger-incomestatement.md index e1d159b354..1ea54c0bbc 100644 --- a/pages/common/hledger-incomestatement.md +++ b/pages/common/hledger-incomestatement.md @@ -6,15 +6,15 @@ - Show revenues and expenses (changes in `Revenue` and `Expense` accounts): -`hledger incomestatement` +`hledger {{[is|incomestatement]}}` - Show revenues and expenses each month: -`hledger incomestatement --monthly` +`hledger {{[is|incomestatement]}} {{[-M|--monthly]}}` - Show monthly revenues/expenses/totals, largest first, summarised to 2 levels: -`hledger incomestatement --monthly --row-total --average --sort --depth 2` +`hledger {{[is|incomestatement]}} {{[-MTAS|--monthly --row-total --average --sort-amount]}} {{[-2|--depth 2]}}` - Short form of the above, and generate HTML output in `is.html`: diff --git a/pages/common/hledger-print.md b/pages/common/hledger-print.md index af3f0e5b88..c16d11421d 100644 --- a/pages/common/hledger-print.md +++ b/pages/common/hledger-print.md @@ -9,11 +9,11 @@ - Show transactions, with any implied amounts or costs made explicit: -`hledger print --explicit --infer-costs` +`hledger print {{[-x|--explicit]}} --infer-costs` - Show transactions from two specified files, with amounts converted to cost: -`hledger print --file {{path/to/2023.journal}} --file {{path/to/2024.journal}} --cost` +`hledger print {{[-f|--file]}} {{path/to/2023.journal}} {{[-f|--file]}} {{path/to/2024.journal}} {{[-B|--cost]}}` - Show `$` transactions in `*food*` but not `*groceries*` accounts this month: @@ -25,8 +25,8 @@ - Show cleared transactions, with `EUR` amounts rounded and with decimal commas: -`hledger print --cleared --commodity '1000, EUR' --round hard` +`hledger print {{[-C|--cleared]}} --commodity '1000, EUR' --round hard` - Write transactions from `foo.journal` as a CSV file: -`hledger print --file {{path/to/foo.journal}} --output-file {{path/to/output_file.csv}}` +`hledger print {{[-f|--file]}} {{path/to/foo.journal}} {{[-o|--output-file]}} {{path/to/output_file.csv}}` diff --git a/pages/common/hledger-ui.md b/pages/common/hledger-ui.md index 23bdce3de9..673fe4ad89 100644 --- a/pages/common/hledger-ui.md +++ b/pages/common/hledger-ui.md @@ -13,15 +13,15 @@ - Start in the balance sheet accounts screen, showing hierarchy down to level 3: -`hledger-ui --bs --tree --depth 3` +`hledger-ui --bs {{[-t|--tree]}} --depth 3` - Start in this account's screen, showing cleared transactions, and reload on change: -`hledger-ui --register {{assets:bank:checking}} --cleared --watch` +`hledger-ui --register {{assets:bank:checking}} {{[-C|--cleared]}} {{[-w|--watch]}}` - Read two journal files, and show amounts as current value when known: -`hledger-ui --file {{path/to/2024.journal}} --file {{path/to/2024-prices.journal}} --value now` +`hledger-ui {{[-f|--file]}} {{path/to/2024.journal}} {{[-f|--file]}} {{path/to/2024-prices.journal}} --value now` - Show the manual in Info format, if possible: @@ -29,4 +29,4 @@ - Display help: -`hledger-ui --help` +`hledger-ui {{[-h|--help]}}` diff --git a/pages/common/hledger-web.md b/pages/common/hledger-web.md index eb20e04256..9b0e349b8c 100644 --- a/pages/common/hledger-web.md +++ b/pages/common/hledger-web.md @@ -9,7 +9,7 @@ - As above but with a specified file, and allow editing of existing data: -`hledger-web --file {{path/to/file.journal}} --allow edit` +`hledger-web {{[-f|--file]}} {{path/to/file.journal}} --allow edit` - Start just the web app, and accept incoming connections to the specified host and port: @@ -29,4 +29,4 @@ - Display help: -`hledger-web --help` +`hledger-web {{[-h|--help]}}` diff --git a/pages/common/hledger.md b/pages/common/hledger.md index 585c84f19b..09d7544aa9 100644 --- a/pages/common/hledger.md +++ b/pages/common/hledger.md @@ -14,24 +14,24 @@ - Print all transactions, reading from multiple specified journal files: -`hledger print --file {{path/to/prices-2024.journal}} --file {{path/to/prices-2023.journal}}` +`hledger print {{[-f|--file]}} {{path/to/prices-2024.journal}} {{[-f|--file]}} {{path/to/prices-2023.journal}}` - Show all accounts, as a hierarchy, and their types: -`hledger accounts --tree --types` +`hledger accounts {{[-t|--tree]}} --types` - Show asset and liability account balances, including zeros, hierarchically: -`hledger balancesheet --empty --tree --no-elide` +`hledger {{[bs|balancesheet]}} {{[-E|--empty]}} {{[-t|--tree]}} --no-elide` - Show monthly incomes/expenses/totals, largest first, summarised to 2 levels: -`hledger incomestatement --monthly --row-total --average --sort --depth 2` +`hledger {{[is|incomestatement]}} {{[-M|--monthly]}} {{[-T|--row-total]}} {{[-A|--average]}} --sort --depth 2` - Show the `assets:bank:checking` account's transactions and running balance: -`hledger aregister assets:bank:checking` +`hledger {{[areg|aregister]}} assets:bank:checking` - Show the amount spent on food from the `assets:cash` account: -`hledger print assets:cash | hledger -f- -I aregister expenses:food` +`hledger print assets:cash | hledger {{-f|--file}} - {{[-I|--ignore-assertions]}} aregister expenses:food` diff --git a/pages/common/hn.md b/pages/common/hn.md index ec59d86f71..cab995ab60 100644 --- a/pages/common/hn.md +++ b/pages/common/hn.md @@ -1,7 +1,7 @@ # hn > Command-line interface for Hacker News. -> More information: . +> More information: . - View stories on Hacker News: @@ -9,11 +9,11 @@ - View _number_ of stories on Hacker News: -`hn --limit {{number}}` +`hn {{[-l|--limit]}} {{number}}` - View stories on Hacker News, and keep the list open after selecting a link: -`hn --keep-open` +`hn {{[-k|--keep-open]}}` - View stories on Hacker News sorted by submission date: diff --git a/pages/common/hostapd.md b/pages/common/hostapd.md index f7c3d4fbe6..a3bbe7113a 100644 --- a/pages/common/hostapd.md +++ b/pages/common/hostapd.md @@ -1,7 +1,7 @@ # hostapd > Start an access point using a wireless interface. -> More information: . +> More information: . - Start an access point: diff --git a/pages/common/http-server.md b/pages/common/http-server.md index dad191726c..d486e931ef 100644 --- a/pages/common/http-server.md +++ b/pages/common/http-server.md @@ -9,7 +9,7 @@ - Start an HTTP server on a specific port to serve a specific directory: -`http-server {{path/to/directory}} --port {{port}}` +`http-server {{path/to/directory}} {{[-p|--port]}} {{port}}` - Start an HTTP server using basic authentication: @@ -21,7 +21,7 @@ - Start an HTTPS server on the default port using the specified certificate: -`http-server --ssl --cert {{path/to/cert.pem}} --key {{path/to/key.pem}}` +`http-server {{[-S|--ssl]}} {{[-C|--cert]}} {{path/to/cert.pem}} {{[-K|--key]}} {{path/to/key.pem}}` - Start an HTTP server and include the client's IP address in the output logging: @@ -33,4 +33,4 @@ - Start an HTTP server with logging disabled: -`http-server --silent` +`http-server {{[-s|--silent]}}` diff --git a/pages/common/hyperfine.md b/pages/common/hyperfine.md index 50e14eb03e..5894cd5d9c 100644 --- a/pages/common/hyperfine.md +++ b/pages/common/hyperfine.md @@ -13,16 +13,16 @@ - Change minimum number of benchmarking runs: -`hyperfine --min-runs {{7}} '{{make}}'` +`hyperfine {{[-m|--min-runs]}} {{7}} '{{make}}'` - Perform benchmark with warmup: -`hyperfine --warmup {{5}} '{{make}}'` +`hyperfine {{[-w|--warmup]}} {{5}} '{{make}}'` - Run a command before each benchmark run (to clear caches, etc.): -`hyperfine --prepare '{{make clean}}' '{{make}}'` +`hyperfine {{[-p|--prepare]}} '{{make clean}}' '{{make}}'` - Run a benchmark where a single parameter changes for each run: -`hyperfine --prepare '{{make clean}}' --parameter-scan {{num_threads}} {{1}} {{10}} '{{make -j {num_threads}}}'` +`hyperfine {{[-p|--prepare]}} '{{make clean}}' {{[-P|--parameter-scan]}} {{num_threads}} {{1}} {{10}} '{{make {{[-j|--jobs]}} {num_threads}}}'` diff --git a/pages/common/iconv.md b/pages/common/iconv.md index f8c484ff65..565463ef39 100644 --- a/pages/common/iconv.md +++ b/pages/common/iconv.md @@ -5,12 +5,12 @@ - Convert file to a specific encoding, and print to `stdout`: -`iconv -f {{from_encoding}} -t {{to_encoding}} {{input_file}}` +`iconv {{[-f|--from-code]}} {{from_encoding}} {{[-t|--to-code]}} {{to_encoding}} {{input_file}}` - Convert file to the current locale's encoding, and output to a file: -`iconv -f {{from_encoding}} {{input_file}} > {{output_file}}` +`iconv {{[-f|--from-code]}} {{from_encoding}} {{input_file}} > {{output_file}}` - List supported encodings: -`iconv -l` +`iconv {{[-l|--list]}}` diff --git a/pages/common/impacket-getadusers.md b/pages/common/impacket-getadusers.md index 481deaae5a..afe1efc9fe 100644 --- a/pages/common/impacket-getadusers.md +++ b/pages/common/impacket-getadusers.md @@ -1,8 +1,6 @@ # impacket-GetADUsers > This command is an alias of `GetADUsers.py`. -> Part of the Impacket suite. -> More information: . - View documentation for the original command: diff --git a/pages/common/impacket-getarch.md b/pages/common/impacket-getarch.md index 5b0115f0a1..c8ebd9f154 100644 --- a/pages/common/impacket-getarch.md +++ b/pages/common/impacket-getarch.md @@ -1,8 +1,6 @@ # impacket-getArch > This command is an alias of `getArch.py`. -> Part of the Impacket suite. -> More information: . - View documentation for the original command: diff --git a/pages/common/impacket-getnpusers.md b/pages/common/impacket-getnpusers.md index f7137e09d0..1ea96eb6ff 100644 --- a/pages/common/impacket-getnpusers.md +++ b/pages/common/impacket-getnpusers.md @@ -1,8 +1,6 @@ # impacket-GetNPUsers > This command is an alias of `GetNPUsers.py`. -> Part of the Impacket suite. -> More information: . - View documentation for the original command: diff --git a/pages/common/impacket-getuserspns.md b/pages/common/impacket-getuserspns.md index a373b39c2b..af95e2dc8b 100644 --- a/pages/common/impacket-getuserspns.md +++ b/pages/common/impacket-getuserspns.md @@ -1,8 +1,6 @@ # impacket-GetUserSPNs > This command is an alias of `GetUserSPNs.py`. -> Part of the Impacket suite. -> More information: . - View documentation for the original command: diff --git a/pages/common/impacket-mssqlclient.md b/pages/common/impacket-mssqlclient.md index 68d1a881c6..b66a65440c 100644 --- a/pages/common/impacket-mssqlclient.md +++ b/pages/common/impacket-mssqlclient.md @@ -1,8 +1,6 @@ # impacket-mssqlclient > This command is an alias of `mssqlclient.py`. -> Part of the Impacket suite. -> More information: . - View documentation for the original command: diff --git a/pages/common/impacket-ping.md b/pages/common/impacket-ping.md new file mode 100644 index 0000000000..eb2a487bb2 --- /dev/null +++ b/pages/common/impacket-ping.md @@ -0,0 +1,7 @@ +# impacket-ping + +> This command is an alias of `ping.py`. + +- View documentation for the original command: + +`tldr ping.py` diff --git a/pages/common/impacket-ping6.md b/pages/common/impacket-ping6.md new file mode 100644 index 0000000000..352d9a2763 --- /dev/null +++ b/pages/common/impacket-ping6.md @@ -0,0 +1,7 @@ +# impacket-ping6 + +> This command is an alias of `ping6.py`. + +- View documentation for the original command: + +`tldr ping6.py` diff --git a/pages/common/impacket-rpcdump.md b/pages/common/impacket-rpcdump.md new file mode 100644 index 0000000000..1a57561568 --- /dev/null +++ b/pages/common/impacket-rpcdump.md @@ -0,0 +1,7 @@ +# impacket-rpcdump + +> This command is an alias of `rpcdump.py`. + +- View documentation for the original command: + +`tldr rpcdump.py` diff --git a/pages/common/impacket-rpcmap.md b/pages/common/impacket-rpcmap.md new file mode 100644 index 0000000000..17e23023b0 --- /dev/null +++ b/pages/common/impacket-rpcmap.md @@ -0,0 +1,7 @@ +# impacket-rpcmap + +> This command is an alias of `rpcmap.py`. + +- View documentation for the original command: + +`tldr rpcmap.py` diff --git a/pages/common/impacket-secretsdump.md b/pages/common/impacket-secretsdump.md index b67d00ec28..c784a3e767 100644 --- a/pages/common/impacket-secretsdump.md +++ b/pages/common/impacket-secretsdump.md @@ -1,7 +1,6 @@ # impacket-secretsdump > This command is an alias of `secretsdump.py`. -> More information: . - View documentation for the original command: diff --git a/pages/common/impacket-sniff.md b/pages/common/impacket-sniff.md index 3d5de380fd..9c0e16386b 100644 --- a/pages/common/impacket-sniff.md +++ b/pages/common/impacket-sniff.md @@ -1,8 +1,6 @@ # impacket-sniff > This command is an alias of `sniff.py`. -> Part of the Impacket suite. -> More information: . - View documentation for the original command: diff --git a/pages/common/impacket-sniffer.md b/pages/common/impacket-sniffer.md index 27dfa5368c..5cea3c561a 100644 --- a/pages/common/impacket-sniffer.md +++ b/pages/common/impacket-sniffer.md @@ -1,8 +1,6 @@ # impacket-sniffer > This command is an alias of `sniffer.py`. -> Part of the Impacket suite. -> More information: . - View documentation for the original command: diff --git a/pages/common/in-toto-record.md b/pages/common/in-toto-record.md index 176697e505..00631fae1e 100644 --- a/pages/common/in-toto-record.md +++ b/pages/common/in-toto-record.md @@ -5,8 +5,8 @@ - Start the record (creates a preliminary link file): -`in-toto-record start -n {{path/to/edit_file1 path/to/edit_file2 ...}} -k {{path/to/key_file}} -m {{.}}` +`in-toto-record start {{[-n|--step-name]}} {{path/to/edit_file1 path/to/edit_file2 ...}} -k {{path/to/key_file}} {{[-m|--materials]}} {{.}}` - Stop the record (expects a preliminary link file): -`in-toto-record stop -n {{path/to/edit_file1 path/to/edit_file2 ...}} -k {{path/to/key_file}} -p {{.}}` +`in-toto-record stop {{[-n|--step-name]}} {{path/to/edit_file1 path/to/edit_file2 ...}} -k {{path/to/key_file}} {{[-p|--products]}} {{.}}` diff --git a/pages/common/in-toto-run.md b/pages/common/in-toto-run.md index 21a19bdff2..680aef706e 100644 --- a/pages/common/in-toto-run.md +++ b/pages/common/in-toto-run.md @@ -5,16 +5,16 @@ - Tag a Git repo and signing the resulting link file: -`in-toto-run -n {{tag}} --products {{.}} -k {{key_file}} -- {{git tag v1.0}}` +`in-toto-run {{[-n|--step-name]}} {{tag}} {{[-p|--products]}} {{.}} -k {{key_file}} -- {{git tag v1.0}}` - Create a tarball, storing files as materials and the tarball as product: -`in-toto-run -n {{package}} -m {{project}} -p {{project.tar.gz}} -- {{tar czf project.tar.gz project}}` +`in-toto-run {{[-n|--step-name]}} {{package}} {{[-m|--materials]}} {{project}} {{[-p|--products]}} {{project.tar.gz}} -- {{tar czf project.tar.gz project}}` - Generate signed attestations for review work: -`in-toto-run -n {{review}} -k {{key_file}} -m {{document.pdf}} -x` +`in-toto-run {{[-n|--step-name]}} {{review}} -k {{key_file}} {{[-m|--materials]}} {{document.pdf}} {{[-x|--no-command]}}` - Scan the image using Trivy and generate link file: -`in-toto-run -n {{scan}} -k {{key_file}} -p {{report.json}} -- {{/bin/sh -c "trivy -o report.json -f json "}}` +`in-toto-run {{[-n|--step-name]}} {{scan}} -k {{key_file}} {{[-p|--products]}} {{report.json}} -- {{/bin/sh -c "trivy {{[-o|--output]}} report.json {{[-f|--format]}} json "}}` diff --git a/pages/common/in-toto-sign.md b/pages/common/in-toto-sign.md index f4f1a40892..f8dc860aab 100644 --- a/pages/common/in-toto-sign.md +++ b/pages/common/in-toto-sign.md @@ -5,20 +5,20 @@ - Sign 'unsigned.layout' with two keys and write it to 'root.layout': -`in-toto-sign -f {{unsigned.layout}} -k {{priv_key1}} {{priv_key2}} -o {{root.layout}}` +`in-toto-sign {{[-f|--file]}} {{unsigned.layout}} {{[-k|--keep]}} {{priv_key1}} {{priv_key2}} {{[-o|--output]}} {{root.layout}}` - Replace signature in link file and write to default filename: -`in-toto-sign -f {{package.2f89b927.link}} -k {{priv_key}}` +`in-toto-sign {{[-f|--file]}} {{package.2f89b927.link}} {{[-k|--keep]}} {{priv_key}}` - Verify a layout signed with 3 keys: -`in-toto-sign -f {{root.layout}} -k {{pub_key0}} {{pub_key1}} {{pub_key2}} --verify` +`in-toto-sign {{[-f|--file]}} {{root.layout}} {{[-k|--keep]}} {{pub_key0}} {{pub_key1}} {{pub_key2}} --verify` - Sign a layout with the default GPG key in default GPG keyring: -`in-toto-sign -f {{root.layout}} --gpg` +`in-toto-sign {{[-f|--file]}} {{root.layout}} {{[-g|--gpg]}}` - Verify a layout with a GPG key identified by keyid '...439F3C2': -`in-toto-sign -f {{root.layout}} --verify --gpg {{...439F3C2}}` +`in-toto-sign {{[-f|--file]}} {{root.layout}} --verify {{[-g|--gpg]}} {{...439F3C2}}` diff --git a/pages/common/in2csv.md b/pages/common/in2csv.md index 71cc3609ba..f4ec0eb67c 100644 --- a/pages/common/in2csv.md +++ b/pages/common/in2csv.md @@ -18,4 +18,4 @@ - Pipe a JSON file to in2csv: -`cat {{data.json}} | in2csv -f json > {{data.csv}}` +`cat {{data.json}} | in2csv {{[-f|--format]}} json > {{data.csv}}` diff --git a/pages/common/influx.md b/pages/common/influx.md index d7309038ca..732222a1c3 100644 --- a/pages/common/influx.md +++ b/pages/common/influx.md @@ -1,7 +1,7 @@ # influx -> InfluxDB command-line client. -> More information: . +> InfluxDB v1 command-line client. +> More information: . - Connect to an InfluxDB running on localhost with no credentials: diff --git a/pages/common/info.md b/pages/common/info.md index 7770b49e21..0b43c2bb1b 100644 --- a/pages/common/info.md +++ b/pages/common/info.md @@ -1,7 +1,7 @@ # info -> Reads documentation stored in the info format. -> More information: . +> Read documentation stored in the info format. +> More information: . - Start reading top-level directory menu: diff --git a/pages/common/initdb.md b/pages/common/initdb.md index 7f08435d48..d95ad1e9bc 100644 --- a/pages/common/initdb.md +++ b/pages/common/initdb.md @@ -1,7 +1,7 @@ # initdb > Create a PostgreSQL database on disk. -> More information: . +> More information: . - Create a database at `/usr/local/var/postgres`: diff --git a/pages/common/inkscape.md b/pages/common/inkscape.md index a6e9ff9c44..9293ee37ac 100644 --- a/pages/common/inkscape.md +++ b/pages/common/inkscape.md @@ -6,28 +6,28 @@ - Open an SVG file in the Inkscape GUI: -`inkscape {{path/to/filename.svg}}` +`inkscape {{path/to/file.svg}}` - Export an SVG file into a bitmap with the default format (PNG) and the default resolution (96 DPI): -`inkscape {{path/to/filename.svg}} -o {{path/to/filename.png}}` +`inkscape {{path/to/file.svg}} {{[-o|--export-filename]}} {{path/to/filename.png}}` - Export an SVG file into a bitmap of 600x400 pixels (aspect ratio distortion may occur): -`inkscape {{path/to/filename.svg}} -o {{path/to/filename.png}} -w {{600}} -h {{400}}` +`inkscape {{path/to/file.svg}} {{[-o|--export-filename]}} {{path/to/filename.png}} {{[-w|--export-width]}} {{600}} {{[-h|--export-height]}} {{400}}` - Export the drawing (bounding box of all objects) of an SVG file into a bitmap: -`inkscape {{path/to/filename.svg}} -o {{path/to/filename.png}} -D` +`inkscape {{path/to/file.svg}} {{[-o|--export-filename]}} {{path/to/filename.png}} {{[-D|--export-area-drawing]}}` - Export a single object, given its ID, into a bitmap: -`inkscape {{path/to/filename.svg}} -i {{id}} -o {{object.png}}` +`inkscape {{path/to/file.svg}} {{[-i|--export-id]}} {{id}} {{[-o|--export-filename]}} {{object.png}}` - Export an SVG document to PDF, converting all texts to paths: -`inkscape {{path/to/filename.svg}} -o {{path/to/filename.pdf}} --export-text-to-path` +`inkscape {{path/to/file.svg}} {{[-o|--export-filename]}} {{path/to/filename.pdf}} {{[-T|--export-text-to-path]}}` - Duplicate the object with id="path123", rotate the duplicate 90 degrees, save the file, and quit Inkscape: -`inkscape {{path/to/filename.svg}} --select=path123 --verb="{{EditDuplicate;ObjectRotate90;FileSave;FileQuit}}"` +`inkscape {{path/to/file.svg}} --select=path123 --verb="{{EditDuplicate;ObjectRotate90;FileSave;FileQuit}}"` diff --git a/pages/common/interdiff.md b/pages/common/interdiff.md index 33ae9183b3..f812cf1d85 100644 --- a/pages/common/interdiff.md +++ b/pages/common/interdiff.md @@ -9,4 +9,4 @@ - Compare diff files, ignoring whitespace: -`interdiff -w {{old_file}} {{new_file}}` +`interdiff {{[-w|--ignore-all-space]}} {{old_file}} {{new_file}}` diff --git a/pages/common/ioping.md b/pages/common/ioping.md index 50799fe0f1..2ddda8095d 100644 --- a/pages/common/ioping.md +++ b/pages/common/ioping.md @@ -9,12 +9,12 @@ - Measure latency on /tmp using 10 requests of 1 megabyte each: -`ioping -c 10 -s 1M /tmp` +`ioping {{[-c|-count]}} 10 {{[-s|-size]}} 1M /tmp` - Measure disk seek rate on `/dev/sdX`: -`ioping -R {{/dev/sdX}}` +`ioping {{[-R|-rapid]}} {{/dev/sdX}}` - Measure disk sequential speed on `/dev/sdX`: -`ioping -RL {{/dev/sdX}}` +`ioping {{[-RL|-rapid -linear]}} {{/dev/sdX}}` diff --git a/pages/common/ipcalc.md b/pages/common/ipcalc.md new file mode 100644 index 0000000000..9c6159e0cd --- /dev/null +++ b/pages/common/ipcalc.md @@ -0,0 +1,28 @@ +# ipcalc + +> Calculate IP information (subnet, broadcast, host range) from an IP address and netmask. +> More information: . + +- Display network info for an IP address: + +`ipcalc {{192.168.0.1}}` + +- Display network info using CIDR notation: + +`ipcalc {{192.168.0.1}}/{{24}}` + +- Display network info using a dotted decimal netmask: + +`ipcalc {{192.168.0.1}} {{255.255.255.0}}` + +- Suppress bitwise output: + +`ipcalc {{[-b|--nobinary]}} {{192.168.0.1}}` + +- Split a network into specified sized blocks: + +`ipcalc {{[-s|--split]}} {{size1 size2 size3 ...}} {{192.168.0.1}}` + +- Show version information: + +`ipcalc {{[-v|--version]}}` diff --git a/pages/common/ippfind.md b/pages/common/ippfind.md index 08d204b61b..20714e8e5b 100644 --- a/pages/common/ippfind.md +++ b/pages/common/ippfind.md @@ -6,16 +6,16 @@ - List IPP printers registered on the network with their status: -`ippfind --ls` +`ippfind {{[-l|--ls]}}` - Send a specific PostScript document to every PostScript printer on the network: -`ippfind --txt-pdl application/postscript --exec ipptool -f {{path/to/document.ps}} '{}' print-job.test \;` +`ippfind --txt-pdl application/postscript {{[-x|--exec]}} ipptool -f {{path/to/document.ps}} '{}' print-job.test \;` - Send a PostScript test document to every PostScript printer on the network: -`ippfind --txt-pdl application/postscript --exec ipptool -f onepage-letter.ps '{}' print-job.test \;` +`ippfind --txt-pdl application/postscript {{[-x|--exec]}} ipptool -f onepage-letter.ps '{}' print-job.test \;` - Send a PostScript test document to every PostScript printer on the network, whose name matches a regular expression: -`ippfind --txt-pdl application/postscript --host {{regex}} --exec ipptool -f onepage-letter.ps '{}' print-job.test \;` +`ippfind --txt-pdl application/postscript {{[-h|--host]}} {{regex}} {{[-x|--exec]}} ipptool -f onepage-letter.ps '{}' print-job.test \;` diff --git a/pages/common/irssi.md b/pages/common/irssi.md index f3bb8a1d7c..44696bc0a2 100644 --- a/pages/common/irssi.md +++ b/pages/common/irssi.md @@ -5,15 +5,15 @@ - Open Irssi and connect to a server with a nickname: -`irssi -n {{nickname}} -c {{irc.example.com}}` +`irssi {{[-n|--nick]}} {{nickname}} {{[-c|--connect]}} {{irc.example.com}}` - Open Irssi and connect with a specific server on a given port: -`irssi -c {{irc.example.com}} -p {{port}}` +`irssi {{[-c|--connect]}} {{irc.example.com}} {{[-p|--port]}} {{port}}` - Display help: -`irssi --help` +`irssi {{[-?|--help]}}` - Join a channel: diff --git a/pages/common/jc.md b/pages/common/jc.md index 4e516de4ef..92c9aca58e 100644 --- a/pages/common/jc.md +++ b/pages/common/jc.md @@ -13,8 +13,8 @@ - Output pretty JSON via pipe: -`{{ifconfig}} | jc {{--ifconfig}} -p` +`{{ifconfig}} | jc {{--ifconfig}} {{[-p|--pretty]}}` - Output pretty JSON via magic syntax: -`jc -p {{ifconfig}}` +`jc {{[-p|--pretty]}} {{ifconfig}}` diff --git a/pages/common/jdupes.md b/pages/common/jdupes.md index 0253f69863..5fad076e4b 100644 --- a/pages/common/jdupes.md +++ b/pages/common/jdupes.md @@ -1,7 +1,7 @@ # jdupes > A powerful duplicate file finder and an enhanced fork of fdupes. -> More information: . +> More information: . - Search a single directory: @@ -25,4 +25,4 @@ - Search multiple directories and keep the directory order in result: -`jdupes -O {{directory1}} {{directory2}} {{directory3}}` +`jdupes -O {{directory1 directory2 directory3 ...}}` diff --git a/pages/common/jhat.md b/pages/common/jhat.md index 31047653c0..872567b1dc 100644 --- a/pages/common/jhat.md +++ b/pages/common/jhat.md @@ -9,7 +9,7 @@ - Analyze a heap dump, specifying an alternate port for the HTTP server: -`jhat -p {{port}} {{dump_file.bin}}` +`jhat {{[-p|-port]}} {{port}} {{dump_file.bin}}` - Analyze a dump letting `jhat` use up to 8 GB RAM (2-4x dump size recommended): diff --git a/pages/common/jmtpfs.md b/pages/common/jmtpfs.md index f76052e969..5955779fbf 100644 --- a/pages/common/jmtpfs.md +++ b/pages/common/jmtpfs.md @@ -13,7 +13,7 @@ - List available MTP devices: -`jmtpfs --listDevices` +`jmtpfs {{[-l|--listDevices]}}` - If multiple devices are present, mount a specific device: diff --git a/pages/common/jp2a.md b/pages/common/jp2a.md index 76a037fd75..215c077ab9 100644 --- a/pages/common/jp2a.md +++ b/pages/common/jp2a.md @@ -1,7 +1,7 @@ # jp2a > Convert JPEG images to ASCII. -> More information: . +> More information: . - Read JPEG image from a file and print in ASCII: diff --git a/pages/common/jpegoptim.md b/pages/common/jpegoptim.md index 5673d327de..4ccc2796d0 100644 --- a/pages/common/jpegoptim.md +++ b/pages/common/jpegoptim.md @@ -1,20 +1,20 @@ # jpegoptim > Optimise JPEG images. -> More information: . +> More information: . - Optimise a set of JPEG images, retaining all associated data: -`jpegoptim {{image1.jpeg}} {{image2.jpeg}} {{imageN.jpeg}}` +`jpegoptim {{image1.jpeg image2.jpeg image3.jpeg ...}}` - Optimise JPEG images, stripping all non-essential data: -`jpegoptim --strip-all {{image1.jpeg}} {{image2.jpeg}} {{imageN.jpeg}}` +`jpegoptim {{[-s|--strip-all]}} {{image1.jpeg image2.jpeg image3.jpeg ...}}` - Force the output images to be progressive: -`jpegoptim --all-progressive {{image1.jpeg}} {{image2.jpeg}} {{imageN.jpeg}}` +`jpegoptim --all-progressive {{image1.jpeg image2.jpeg image3.jpeg ...}}` - Force the output images to have a fixed maximum filesize: -`jpegoptim --size={{250k}} {{image1.jpeg}} {{image2.jpeg}} {{imageN.jpeg}}` +`jpegoptim {{[-S|--size]}} {{250k}} {{image1.jpeg image2.jpeg image3.jpeg ...}}` diff --git a/pages/common/jq.md b/pages/common/jq.md index faea3efb6f..411886f3ef 100644 --- a/pages/common/jq.md +++ b/pages/common/jq.md @@ -9,7 +9,7 @@ - Execute a specific script: -`{{cat path/to/file.json}} | jq --from-file {{path/to/script.jq}}` +`{{cat path/to/file.json}} | jq {{[-f|--from-file]}} {{path/to/script.jq}}` - Pass specific arguments: diff --git a/pages/common/jtbl.md b/pages/common/jtbl.md index ea6b29e6f2..345f8514ad 100644 --- a/pages/common/jtbl.md +++ b/pages/common/jtbl.md @@ -13,8 +13,8 @@ - Print a table and truncate rows instead of wrapping: -`cat {{file.json}} | jtbl -t` +`cat {{file.json}} | jtbl {{[-t|--truncate]}}` - Print a table and don't wrap or truncate rows: -`cat {{file.json}} | jtbl -n` +`cat {{file.json}} | jtbl {{[-n|--no-wrap]}}` diff --git a/pages/common/julia.md b/pages/common/julia.md index 3b27f83791..35c4428fc4 100644 --- a/pages/common/julia.md +++ b/pages/common/julia.md @@ -17,16 +17,16 @@ - Evaluate a string containing Julia code: -`julia -e '{{julia_code}}'` +`julia {{[-e|--eval]}} '{{julia_code}}'` - Evaluate a string of Julia code, passing arguments to it: -`julia -e '{{for x in ARGS; println(x); end}}' {{arguments}}` +`julia {{[-e|--eval]}} '{{for x in ARGS; println(x); end}}' {{arguments}}` - Evaluate an expression and print the result: -`julia -E '{{(1 - cos(pi/4))/2}}'` +`julia {{[-E|--print]}} '{{(1 - cos(pi/4))/2}}'` - Start Julia in multithreaded mode, using `n` threads: -`julia -t {{n}}` +`julia {{[-t|--threads]}} {{n}}` diff --git a/pages/common/jupyter.md b/pages/common/jupyter.md index 917af51064..cd0e2a0362 100644 --- a/pages/common/jupyter.md +++ b/pages/common/jupyter.md @@ -2,7 +2,7 @@ > Web application to create and share documents that contain code, visualizations and notes. > Primarily used for data analysis, scientific computing and machine learning. -> More information: . +> More information: . - Start a Jupyter notebook server in the current directory: @@ -18,7 +18,7 @@ - Start a server on a specific port: -`jupyter notebook --port={{port}}` +`jupyter notebook --port {{port}}` - List currently running notebook servers: diff --git a/pages/common/just.1.md b/pages/common/just.1.md index 1a776107cc..85bbc3e977 100644 --- a/pages/common/just.1.md +++ b/pages/common/just.1.md @@ -13,11 +13,11 @@ - Edit justfile in the default editor: -`just -e` +`just {{[-e|--edit]}}` - List available recipes in the justfile: -`just -l` +`just {{[-l|--list]}}` - Print justfile: diff --git a/pages/common/jwt.md b/pages/common/jwt.md index 768e1d71a6..f6db21ce73 100644 --- a/pages/common/jwt.md +++ b/pages/common/jwt.md @@ -10,12 +10,12 @@ - Decode a JWT as a JSON string: -`jwt decode -j {{jwt_string}}` +`jwt decode {{[-j|--json]}} {{jwt_string}}` - Encode a JSON string to a JWT: -`jwt encode --alg {{HS256}} --secret {{1234567890}} '{{json_string}}'` +`jwt encode {{[-A|--alg]}} {{HS256}} {{[-S|--secret]}} {{1234567890}} '{{json_string}}'` - Encode key pair payload to JWT: -`jwt encode --alg {{HS256}} --secret {{1234567890}} -P {{key=value}}` +`jwt encode {{[-A|--alg]}} {{HS256}} {{[-S|--secret]}} {{1234567890}} {{[-P|--payload]}} {{key=value}}` diff --git a/pages/common/k6.md b/pages/common/k6.md index 62208e63c3..0d5c4a5cc5 100644 --- a/pages/common/k6.md +++ b/pages/common/k6.md @@ -9,15 +9,15 @@ - Run load test locally with a given number of virtual users and duration: -`k6 run --vus {{10}} --duration {{30s}} {{script.js}}` +`k6 run {{[-u|--vus]}} {{10}} {{[-d|--duration]}} {{30s}} {{script.js}}` - Run load test locally with a given environment variable: -`k6 run -e {{HOSTNAME=example.com}} {{script.js}}` +`k6 run {{[-e|--env]}} {{HOSTNAME=example.com}} {{script.js}}` - Run load test locally using InfluxDB to store results: -`k6 run --out influxdb={{http://localhost:8086/k6db}} {{script.js}}` +`k6 run {{[-o|--out]}} influxdb={{http://localhost:8086/k6db}} {{script.js}}` - Run load test locally and discard response bodies (significantly faster): diff --git a/pages/common/k8s-unused-secret-detector.md b/pages/common/k8s-unused-secret-detector.md index 2a8b98c9ae..6ad2a5194b 100644 --- a/pages/common/k8s-unused-secret-detector.md +++ b/pages/common/k8s-unused-secret-detector.md @@ -9,8 +9,8 @@ - Detect unused secrets in a specific namespace: -`k8s-unused-secret-detector -n {{namespace}}` +`k8s-unused-secret-detector {{[-n|--namespace]}} {{namespace}}` - Delete unused secrets in a specific namespace: -`k8s-unused-secret-detector -n {{namespace}} | kubectl delete secret -n {{namespace}}` +`k8s-unused-secret-detector {{[-n|--namespace]}} {{namespace}} | kubectl delete secret {{[-n|--namespace]}} {{namespace}}` diff --git a/pages/common/k8sec.md b/pages/common/k8sec.md index ee40541fbc..860ddea6b8 100644 --- a/pages/common/k8sec.md +++ b/pages/common/k8sec.md @@ -25,8 +25,8 @@ - Load secrets from a file: -`k8sec load -f {{path/to/file}} {{secret_name}}` +`k8sec load {{[-f|--filename]}} {{path/to/file}} {{secret_name}}` - Dump secrets to a file: -`k8sec dump -f {{path/to/file}} {{secret_name}}` +`k8sec dump {{[-f|--filename]}} {{path/to/file}} {{secret_name}}` diff --git a/pages/common/kaggle.md b/pages/common/kaggle.md index 17707e96b5..2fd184f125 100644 --- a/pages/common/kaggle.md +++ b/pages/common/kaggle.md @@ -9,4 +9,4 @@ - Download a specific file from a competition dataset: -`kaggle competitions download {{competition}} -f {{filename}}` +`kaggle competitions download {{competition}} {{[-f|--file]}} {{filename}}` diff --git a/pages/common/kahlan.md b/pages/common/kahlan.md index 237e78d32f..97b30a185f 100644 --- a/pages/common/kahlan.md +++ b/pages/common/kahlan.md @@ -1,7 +1,7 @@ # kahlan > A unit and Behaviour Driven Development test framework for PHP. -> More information: . +> More information: . - Run all specifications in the "spec" directory: diff --git a/pages/common/keybase.md b/pages/common/keybase.md index e4bf4cab5f..091905a104 100644 --- a/pages/common/keybase.md +++ b/pages/common/keybase.md @@ -1,7 +1,7 @@ # keybase > Key directory that maps social media identities to encryption keys in a publicly auditable manner. -> More information: . +> More information: . - Follow another user: @@ -13,19 +13,19 @@ - Sign a file: -`keybase sign --infile {{input_file}} --outfile {{output_file}}` +`keybase sign {{[-i|--infile]}} {{input_file}} {{[-o|--outfile]}} {{output_file}}` - Verify a signed file: -`keybase verify --infile {{input_file}} --outfile {{output_file}}` +`keybase verify {{[-i|--infile]}} {{input_file}} {{[-o|--outfile]}} {{output_file}}` - Encrypt a file: -`keybase encrypt --infile {{input_file}} --outfile {{output_file}} {{receiver}}` +`keybase encrypt {{[-i|--infile]}} {{input_file}} {{[-o|--outfile]}} {{output_file}} {{receiver}}` - Decrypt a file: -`keybase decrypt --infile {{input_file}} --outfile {{output_file}}` +`keybase decrypt {{[-i|--infile]}} {{input_file}} {{[-o|--outfile]}} {{output_file}}` - Revoke current device, log out, and delete local data: diff --git a/pages/common/kinit.md b/pages/common/kinit.md index 0c16759af6..f9d73564a4 100644 --- a/pages/common/kinit.md +++ b/pages/common/kinit.md @@ -2,7 +2,7 @@ > Authenticate a principal with a Kerberos server to gain and cache a ticket. > Note: A Kerberos principal can be either a user, service, or application. -> More information: . +> More information: . - Authenticate a user and obtain a ticket-granting ticket: diff --git a/pages/common/kismet.md b/pages/common/kismet.md index cc788fdd15..9546c481aa 100644 --- a/pages/common/kismet.md +++ b/pages/common/kismet.md @@ -17,7 +17,7 @@ - Start Kismet with a specific configuration file: -`sudo kismet -c {{wlan0}} -f {{path/to/config.conf}}` +`sudo kismet -c {{wlan0}} {{[-f|--config-file]}} {{path/to/config.conf}}` - Monitor and log data to an SQLite database: diff --git a/pages/common/kompose.md b/pages/common/kompose.md index fd54ba9710..7e5cd685d7 100644 --- a/pages/common/kompose.md +++ b/pages/common/kompose.md @@ -5,12 +5,12 @@ - Deploy a dockerized application to Kubernetes: -`kompose up -f {{docker-compose.yml}}` +`kompose up {{[-f|--file]}} {{docker-compose.yml}}` - Delete instantiated services/deployments from Kubernetes: -`kompose down -f {{docker-compose.yml}}` +`kompose down {{[-f|--file]}} {{docker-compose.yml}}` - Convert a docker-compose file into Kubernetes resources file: -`kompose convert -f {{docker-compose.yml}}` +`kompose convert {{[-f|--file]}} {{docker-compose.yml}}` diff --git a/pages/common/kops.md b/pages/common/kops.md index 86209fc907..4e2aa978c6 100644 --- a/pages/common/kops.md +++ b/pages/common/kops.md @@ -5,11 +5,11 @@ - Create a cluster from the configuration specification: -`kops create cluster -f {{cluster_name.yaml}}` +`kops create cluster {{[-f|--filename]}} {{cluster_name.yaml}}` - Create a new SSH public key: -`kops create secret sshpublickey {{key_name}} -i {{~/.ssh/id_rsa.pub}}` +`kops create sshpublickey {{key_name}} {{[-i|--ssh-public-key]}} {{~/.ssh/id_rsa.pub}}` - Export the cluster configuration to the `~/.kube/config` file: @@ -17,11 +17,11 @@ - Get the cluster configuration as YAML: -`kops get cluster {{cluster_name}} -o yaml` +`kops get cluster {{cluster_name}} {{[-o|--output]}} yaml` - Delete a cluster: -`kops delete cluster {{cluster_name}} --yes` +`kops delete cluster {{cluster_name}} {{[-y|--yes]}}` - Validate a cluster: diff --git a/pages/common/kube-capacity.md b/pages/common/kube-capacity.md index adadb7c6c2..779732afb1 100644 --- a/pages/common/kube-capacity.md +++ b/pages/common/kube-capacity.md @@ -10,8 +10,8 @@ - Include pods: -`kube-capacity -p` +`kube-capacity {{[-p|--pods]}}` - Include utilization: -`kube-capacity -u` +`kube-capacity {{[-u|--util]}}` diff --git a/pages/common/kubectl-apply.md b/pages/common/kubectl-apply.md index 1d623957c5..53e235320a 100644 --- a/pages/common/kubectl-apply.md +++ b/pages/common/kubectl-apply.md @@ -6,16 +6,16 @@ - Apply a configuration to a resource by file name or `stdin`: -`kubectl apply -f {{resource_filename}}` +`kubectl apply {{[-f|--filename]}} {{resource_filename}}` - Edit the latest last-applied-configuration annotations of resources from the default editor: -`kubectl apply edit-last-applied -f {{resource_filename}}` +`kubectl apply edit-last-applied {{[-f|--filename]}} {{resource_filename}}` - Set the latest last-applied-configuration annotations by setting it to match the contents of a file: -`kubectl apply set-last-applied -f {{resource_filename}}` +`kubectl apply set-last-applied {{[-f|--filename]}} {{resource_filename}}` - View the latest last-applied-configuration annotations by type/name or file: -`kubectl apply view-last-applied -f {{resource_filename}}` +`kubectl apply view-last-applied {{[-f|--filename]}} {{resource_filename}}` diff --git a/pages/common/kubectl-create.md b/pages/common/kubectl-create.md index 10788387ac..50ef5e7418 100644 --- a/pages/common/kubectl-create.md +++ b/pages/common/kubectl-create.md @@ -5,11 +5,11 @@ - Create a resource using the resource definition file: -`kubectl create -f {{path/to/file.yml}}` +`kubectl create {{[-f|--filename]}} {{path/to/file.yml}}` - Create a resource from `stdin`: -`kubectl create -f -` +`kubectl create {{[-f|--filename]}} -` - Create a deployment: diff --git a/pages/common/kubectl-delete.md b/pages/common/kubectl-delete.md index 33bdb963e9..e5e2ab38d4 100644 --- a/pages/common/kubectl-delete.md +++ b/pages/common/kubectl-delete.md @@ -29,4 +29,4 @@ - Delete resources defined in a YAML manifest: -`kubectl delete --filename {{path/to/manifest.yaml}}` +`kubectl delete {{[-f|--filename]}} {{path/to/manifest.yaml}}` diff --git a/pages/common/kubectl-edit.md b/pages/common/kubectl-edit.md index c8a519240c..7f229e3303 100644 --- a/pages/common/kubectl-edit.md +++ b/pages/common/kubectl-edit.md @@ -21,4 +21,4 @@ - Edit a resource in JSON format: -`kubectl edit {{resource}}/{{resource_name}} --output json` +`kubectl edit {{resource}}/{{resource_name}} {{[-o|--output]}} json` diff --git a/pages/common/kubectl-expose.md b/pages/common/kubectl-expose.md index e1e355b036..896e277fd9 100644 --- a/pages/common/kubectl-expose.md +++ b/pages/common/kubectl-expose.md @@ -9,7 +9,7 @@ - Create a service for a resource identified by a file: -`kubectl expose -f {{path/to/file.yml}} --port={{node_port}} --target-port={{container_port}}` +`kubectl expose {{[-f|--filename]}} {{path/to/file.yml}} --port={{node_port}} --target-port={{container_port}}` - Create a service with a name, to serve to a node port which will be same for container port: diff --git a/pages/common/kubectl-label.md b/pages/common/kubectl-label.md index 7d87a71b41..a4be95ee71 100644 --- a/pages/common/kubectl-label.md +++ b/pages/common/kubectl-label.md @@ -17,7 +17,7 @@ - Label a pod identified by the pod definition file: -`kubectl label -f {{pod_definition_file}} {{key}}={{value}}` +`kubectl label {{[-f|--filename]}} {{pod_definition_file}} {{key}}={{value}}` - Remove the label from a pod: diff --git a/pages/common/kubectl-logs.md b/pages/common/kubectl-logs.md index 25e3b64586..286ae018c9 100644 --- a/pages/common/kubectl-logs.md +++ b/pages/common/kubectl-logs.md @@ -9,7 +9,7 @@ - Show logs for a specified container in a pod: -`kubectl logs --container {{container_name}} {{pod_name}}` +`kubectl logs {{[-c|--container]}} {{container_name}} {{pod_name}}` - Show logs for all containers in a pod: @@ -17,7 +17,7 @@ - Stream pod logs: -`kubectl logs --follow {{pod_name}}` +`kubectl logs {{[-f|--follow]}} {{pod_name}}` - Show pod logs newer than a relative time like `10s`, `5m`, or `1h`: diff --git a/pages/common/kubectl-replace.md b/pages/common/kubectl-replace.md index 211f3ac793..611d17de5f 100644 --- a/pages/common/kubectl-replace.md +++ b/pages/common/kubectl-replace.md @@ -5,12 +5,12 @@ - Replace the resource using the resource definition file: -`kubectl replace -f {{path/to/file.yml}}` +`kubectl replace {{[-f|--filename]}} {{path/to/file.yml}}` - Replace the resource using the input passed into `stdin`: -`kubectl replace -f -` +`kubectl replace {{[-f|--filename]}} -` - Force replace, delete and then re-create the resource: -`kubectl replace --force -f {{path/to/file.yml}}` +`kubectl replace --force {{[-f|--filename]}} {{path/to/file.yml}}` diff --git a/pages/common/kubectl-scale.md b/pages/common/kubectl-scale.md index 9271727ed8..03945a1a18 100644 --- a/pages/common/kubectl-scale.md +++ b/pages/common/kubectl-scale.md @@ -9,7 +9,7 @@ - Scale a resource identified by a file: -`kubectl scale --replicas={{number_of_replicas}} -f {{path/to/file.yml}}` +`kubectl scale --replicas={{number_of_replicas}} {{[-f|--filename]}} {{path/to/file.yml}}` - Scale a deployment based on current number of replicas: diff --git a/pages/common/kubectl.md b/pages/common/kubectl.md index 39b722813b..9426ad44cf 100644 --- a/pages/common/kubectl.md +++ b/pages/common/kubectl.md @@ -6,7 +6,7 @@ - List information about a resource with more details: -`kubectl get {{pod|service|deployment|ingress|...}} -o wide` +`kubectl get {{pod|service|deployment|ingress|...}} {{[-o|--output]}} wide` - Update specified pod with the label 'unhealthy' and the value 'true': diff --git a/pages/common/kubectx.md b/pages/common/kubectx.md index 1c11b25e49..1a77f3adb9 100644 --- a/pages/common/kubectx.md +++ b/pages/common/kubectx.md @@ -1,7 +1,7 @@ # kubectx > Utility to manage and switch between `kubectl` contexts. -> More information: . +> More information: . - List the contexts: @@ -21,7 +21,7 @@ - Show the current named context: -`kubectx -c` +`kubectx {{[-c|--current]}}` - Delete a named context: diff --git a/pages/common/kubens.md b/pages/common/kubens.md index 057a07b847..cefd7d74db 100644 --- a/pages/common/kubens.md +++ b/pages/common/kubens.md @@ -1,7 +1,7 @@ # kubens > Utility to switch between Kubernetes namespaces. -> More information: . +> More information: . - List the namespaces: diff --git a/pages/common/kubetail.md b/pages/common/kubetail.md index b163e6afa3..1444c30b81 100644 --- a/pages/common/kubetail.md +++ b/pages/common/kubetail.md @@ -9,11 +9,11 @@ - Tail only a specific container from multiple pods: -`kubetail {{my_app}} -c {{my_container}}` +`kubetail {{my_app}} {{[-c|--container]}} {{my_container}}` - To tail multiple containers from multiple pods: -`kubetail {{my_app}} -c {{my_container_1}} -c {{my_container_2}}` +`kubetail {{my_app}} {{[-c|--container]}} {my_container_1}} {{[-c|--container]}} {my_container_2}}` - To tail multiple applications at the same time separate them by comma: diff --git a/pages/common/kustomize.md b/pages/common/kustomize.md index 2e92b28ded..2b91f258bd 100644 --- a/pages/common/kustomize.md +++ b/pages/common/kustomize.md @@ -9,7 +9,7 @@ - Build a kustomization file and deploy it with `kubectl`: -`kustomize build . | kubectl apply -f -` +`kustomize build . | kubectl apply {{[-f|--filename]}} -` - Set an image in the kustomization file: diff --git a/pages/common/ld.md b/pages/common/ld.md index fee46172e1..1e3a3b639a 100644 --- a/pages/common/ld.md +++ b/pages/common/ld.md @@ -1,16 +1,16 @@ # ld > Link object files together. -> More information: . +> More information: . - Link a specific object file with no dependencies into an executable: -`ld {{path/to/file.o}} --output {{path/to/output_executable}}` +`ld {{path/to/file.o}} {{[-o|--output]}} {{path/to/output_executable}}` - Link two object files together: -`ld {{path/to/file1.o}} {{path/to/file2.o}} --output {{path/to/output_executable}}` +`ld {{path/to/file1.o}} {{path/to/file2.o}} {{[-o|--output]}} {{path/to/output_executable}}` - Dynamically link an x86_64 program to glibc (file paths change depending on the system): -`ld --output {{path/to/output_executable}} --dynamic-linker /lib/ld-linux-x86-64.so.2 /lib/crt1.o /lib/crti.o -lc {{path/to/file.o}} /lib/crtn.o` +`ld {{[-o|--output]}} {{path/to/output_executable}} {{[-I|--dynamic-linker]}} /lib/ld-linux-x86-64.so.2 /lib/crt1.o /lib/crti.o -lc {{path/to/file.o}} /lib/crtn.o` diff --git a/pages/common/ldapsearch.md b/pages/common/ldapsearch.md index 4e25be2714..dd81da1fb9 100644 --- a/pages/common/ldapsearch.md +++ b/pages/common/ldapsearch.md @@ -5,32 +5,32 @@ - Query an LDAP server for all items that are a member of the given group and return the object's displayName value: -`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} -b {{base_ou}} '{{memberOf=group1}}' displayName` +`ldapsearch {{[-D|--bindDN]}} '{{admin_DN}}' {{[-w|--bindPassword]}} '{{password}}' {{[-h|--hostname]}} {{ldap_host}} {{[-b|--baseDN]}} {{base_ou}} '{{memberOf=group1}}' displayName` - Query an LDAP server with a no-newline password file for all items that are a member of the given group and return the object's displayName value: -`ldapsearch -D '{{admin_DN}}' -y '{{password_file}}' -h {{ldap_host}} -b {{base_ou}} '{{memberOf=group1}}' displayName` +`ldapsearch {{[-D|--bindDN]}} '{{admin_DN}}' {{[-u|--keyStorePasswordFile]}} '{{password_file}}' {{[-h|--hostname]}} {{ldap_host}} {{[-b|--baseDN]}} {{base_ou}} '{{memberOf=group1}}' displayName` - Return 5 items that match the given filter: -`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} -b {{base_ou}} '{{memberOf=group1}}' -z 5 displayName` +`ldapsearch {{[-D|--bindDN]}} '{{admin_DN}}' {{[-w|--bindPassword]}} '{{password}}' {{[-h|--hostname]}} {{ldap_host}} {{[-b|--baseDN]}} {{base_ou}} '{{memberOf=group1}}' {{[-z|--sizeLimit]}} 5 displayName` - Wait up to 7 seconds for a response: -`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} -b {{base_ou}} '{{memberOf=group1}}' -l 7 displayName` +`ldapsearch {{[-D|--bindDN]}} '{{admin_DN}}' {{[-w|--bindPassword]}} '{{password}}' {{[-h|--hostname]}} {{ldap_host}} {{[-b|--baseDN]}} {{base_ou}} '{{memberOf=group1}}' {{[-l|--timeLimitSeconds]}} 7 displayName` - Invert the filter: -`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} -b {{base_ou}} '(!(memberOf={{group1}}))' displayName` +`ldapsearch {{[-D|--bindDN]}} '{{admin_DN}}' {{[-w|--bindPassword]}} '{{password}}' {{[-h|--hostname]}} {{ldap_host}} {{[-b|--baseDN]}} {{base_ou}} '(!(memberOf={{group1}}))' displayName` - Return all items that are part of multiple groups, returning the display name for each item: -`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} '(&({{memberOf=group1}})({{memberOf=group2}})({{memberOf=group3}}))' "displayName"` +`ldapsearch {{[-D|--bindDN]}} '{{admin_DN}}' {{[-w|--bindPassword]}} '{{password}}' {{[-h|--hostname]}} {{ldap_host}} '(&({{memberOf=group1}})({{memberOf=group2}})({{memberOf=group3}}))' "displayName"` - Return all items that are members of at least 1 of the specified groups: -`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} '(|({{memberOf=group1}})({{memberOf=group1}})({{memberOf=group3}}))' displayName` +`ldapsearch {{[-D|--bindDN]}} '{{admin_DN}}' {{[-w|--bindPassword]}} '{{password}}' {{[-h|--hostname]}} {{ldap_host}} '(|({{memberOf=group1}})({{memberOf=group1}})({{memberOf=group3}}))' displayName` - Combine multiple boolean logic filters: -`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} '(&({{memberOf=group1}})({{memberOf=group2}})(!({{memberOf=group3}})))' displayName` +`ldapsearch {{[-D|--bindDN]}} '{{admin_DN}}' {{[-w|--bindPassword]}} '{{password}}' {{[-h|--hostname]}} {{ldap_host}} '(&({{memberOf=group1}})({{memberOf=group2}})(!({{memberOf=group3}})))' displayName` diff --git a/pages/common/lilypond.md b/pages/common/lilypond.md index 62a1128dbf..f632d8112c 100644 --- a/pages/common/lilypond.md +++ b/pages/common/lilypond.md @@ -10,16 +10,16 @@ - Compile into the specified format: -`lilypond --formats={{format_dump}} {{path/to/file}}` +`lilypond {{[-f|--format]}} {{format_dump}} {{path/to/file}}` - Compile the specified file, suppressing progress updates: -`lilypond -s {{path/to/file}}` +`lilypond {{[-s|--silent]}} {{path/to/file}}` - Compile the specified file, and also specify the output filename: -`lilypond --output={{path/to/output_file}} {{path/to/input_file}}` +`lilypond {{[-o|--output]}} {{path/to/output_file}} {{path/to/input_file}}` - Show the current version of lilypond: -`lilypond --version` +`lilypond {{[-v|--version]}}` diff --git a/pages/common/loc.md b/pages/common/loc.md index 4231c95d26..654cf07502 100644 --- a/pages/common/loc.md +++ b/pages/common/loc.md @@ -17,4 +17,4 @@ - Print lines of code without .gitignore (etc.) files (e.g. two -u flags will additionally count hidden files and dirs): -`loc -u` +`loc {{[-u|--unrestricted]}}` diff --git a/pages/common/lolcat.md b/pages/common/lolcat.md index 9a858e41b1..b8cb30d86b 100644 --- a/pages/common/lolcat.md +++ b/pages/common/lolcat.md @@ -13,8 +13,8 @@ - Print a file to the console with animated rainbow colors: -`lolcat -a {{path/to/file}}` +`lolcat {{[-a|--animate]}} {{path/to/file}}` - Print a file to the console with 24-bit (truecolor) rainbow colors: -`lolcat -t {{path/to/file}}` +`lolcat {{[-t|--truecolor]}} {{path/to/file}}` diff --git a/pages/common/lsd.md b/pages/common/lsd.md index 9251f050a2..65f46e88e8 100644 --- a/pages/common/lsd.md +++ b/pages/common/lsd.md @@ -6,32 +6,32 @@ - List files and directories, one per line: -`lsd -1` +`lsd {{[-1|--oneline]}}` - List all files and directories, including hidden ones, in the current directory: -`lsd -a` +`lsd {{[-a|--all]}}` - List files and directories with trailing `/` added to directory names: -`lsd -F` +`lsd {{[-F|--classify]}}` - List all files and directories in long format (permissions, ownership, size in human-readable format, and modification date): -`lsd -lha` +`lsd {{[-lha|--long --human-readable --all]}}` - List files and directories in long format, sorted by size (descending): -`lsd -lS` +`lsd {{[-lS|--long --sizesort]}}` - List files and directories in long format, sorted by modification date (oldest first): -`lsd -ltr` +`lsd {{[-ltr|--long --timesort --reverse]}}` - Only list directories: -`lsd -d {{*/}}` +`lsd {{[-d|--directory-only]}} {{*/}}` - Recursively list all directories in a tree format: -`lsd --tree -d` +`lsd --tree {{[-d|--directory-only]}}` diff --git a/pages/common/lt.md b/pages/common/lt.md index c25b607c78..bfafc4299b 100644 --- a/pages/common/lt.md +++ b/pages/common/lt.md @@ -5,20 +5,20 @@ - Start tunnel from a specific port: -`lt --port {{8000}}` +`lt {{[-p|--port]}} {{8000}}` - Specify the upstream server doing the forwarding: -`lt --port {{8000}} --host {{host}}` +`lt {{[-p|--port]}} {{8000}} {{[-h|--host]}} {{host}}` - Request a specific subdomain: -`lt --port {{8000}} --subdomain {{subdomain}}` +`lt {{[-p|--port]}} {{8000}} {{[-s|--subdomain]}} {{subdomain}}` - Print basic request info: -`lt --port {{8000}} --print-requests` +`lt {{[-p|--port]}} {{8000}} --print-requests` - Open the tunnel URL in the default web browser: -`lt --port {{8000}} --open` +`lt {{[-p|--port]}} {{8000}} {{[-o|--open]}}` diff --git a/pages/common/lua.md b/pages/common/lua.md index 2975dd2651..cad39898d1 100644 --- a/pages/common/lua.md +++ b/pages/common/lua.md @@ -1,7 +1,7 @@ # lua > A powerful, light-weight embeddable programming language. -> More information: . +> More information: . - Start an interactive Lua shell: diff --git a/pages/common/luac.md b/pages/common/luac.md index 7772262f3c..14d5623841 100644 --- a/pages/common/luac.md +++ b/pages/common/luac.md @@ -1,7 +1,7 @@ # luac > Lua bytecode compiler. -> More information: . +> More information: . - Compile a Lua source file to Lua bytecode: diff --git a/pages/common/lychee.md b/pages/common/lychee.md index 494935477e..1b6b2da926 100644 --- a/pages/common/lychee.md +++ b/pages/common/lychee.md @@ -17,7 +17,7 @@ - Check files in a directory structure for any broken URLs: -`grep -r "{{pattern}}" | lychee -` +`grep {{[-r|--recursive]}} "{{pattern}}" | lychee -` - Display help: diff --git a/pages/common/lz4.md b/pages/common/lz4.md index 9d3dfea957..07164a098f 100644 --- a/pages/common/lz4.md +++ b/pages/common/lz4.md @@ -9,11 +9,11 @@ - Decompress a file: -`lz4 -d {{file.lz4}}` +`lz4 {{[-d|--decompress]}} {{file.lz4}}` - Decompress a file and write to `stdout`: -`lz4 -dc {{file.lz4}}` +`lz4 {{[-dc|--decompress --stdout]}} {{file.lz4}}` - Package and compress a directory and its contents: @@ -21,8 +21,8 @@ - Decompress and unpack a directory and its contents: -`lz4 -dc {{dir.tar.lz4}} | tar -xv` +`lz4 {{[-dc|--decompress --stdout]}} {{dir.tar.lz4}} | tar -xv` - Compress a file using the best compression: -`lz4 -9 {{path/to/file}}` +`lz4 {{[-12|--best]}} {{path/to/file}}` diff --git a/pages/common/lzop.md b/pages/common/lzop.md index 8fcdb7887a..9355950d9f 100644 --- a/pages/common/lzop.md +++ b/pages/common/lzop.md @@ -9,8 +9,16 @@ - Decompress a file: -`lzop -d {{path/to/file.lzo}}` +`lzop {{[-d|--decompress]}} {{path/to/file.lzo}}` - Compress a file, while specifying the compression level. 0 = Worst, 9 = Best (Default level is 3): `lzop -{{level}} {{path/to/file}}` + +- Compress a file with the best compression level: + +`lzop {{[-9|--best]}} {{[path/to/file]}}` + +- Compress a file with the fastest compression level: + +`lzop {{[-1|--fast]}} {{[path/to/file]}}` diff --git a/pages/common/mailx.md b/pages/common/mailx.md index f620515290..64060b6fbf 100644 --- a/pages/common/mailx.md +++ b/pages/common/mailx.md @@ -5,24 +5,24 @@ - Send mail (the content should be typed after the command, and ended with ``): -`mailx -s "{{subject}}" {{to_addr}}` +`mailx {{[-s|--subject]}} "{{subject}}" {{to_addr}}` - Send mail with content passed from another command: -`echo "{{content}}" | mailx -s "{{subject}}" {{to_addr}}` +`echo "{{content}}" | mailx {{[-s|--subject]}} "{{subject}}" {{to_addr}}` - Send mail with content read from a file: -`mailx -s "{{subject}}" {{to_addr}} < {{content.txt}}` +`mailx {{[-s|--subject]}} "{{subject}}" {{to_addr}} < {{content.txt}}` - Send mail to a recipient and CC to another address: -`mailx -s "{{subject}}" -c {{cc_addr}} {{to_addr}}` +`mailx {{[-s|--subject]}} "{{subject}}" {{[-c|--cc]}} {{cc_addr}} {{to_addr}}` - Send mail specifying the sender address: -`mailx -s "{{subject}}" -r {{from_addr}} {{to_addr}}` +`mailx {{[-s|--subject]}} "{{subject}}" {{[-r|--from-address]}} {{from_addr}} {{to_addr}}` - Send mail with an attachment: -`mailx -a {{path/to/file}} -s "{{subject}}" {{to_addr}}` +`mailx {{[-a|--attach]}} {{path/to/file}} {{[-s|--subject]}} "{{subject}}" {{to_addr}}` diff --git a/pages/common/makebuildserver.md b/pages/common/makebuildserver.md index 8b782656e4..024a12481e 100644 --- a/pages/common/makebuildserver.md +++ b/pages/common/makebuildserver.md @@ -9,4 +9,4 @@ - Force creating a fresh virtual machine: -`makebuildserver --clean` +`makebuildserver {{[-c|--clean]}}` diff --git a/pages/common/masscan.md b/pages/common/masscan.md index 7c7060f23d..ec461dbcf1 100644 --- a/pages/common/masscan.md +++ b/pages/common/masscan.md @@ -16,6 +16,10 @@ `masscan {{10.0.0.0/16}} --top-ports {{100}} --excludefile {{path/to/file}}` +- Scan a class B subnet with Nmap-like version detection (banner grabbing): + +`masscan {{10.0.0.0/16}} {{[-p|--ports]}} {{22,80}} --banners --rate {{100000}}` + - Scan the Internet for web servers running on port 80 and 443: `masscan {{0.0.0.0/0}} {{[-p|--ports]}} {{80,443}} --rate {{10000000}}` diff --git a/pages/common/matlab.md b/pages/common/matlab.md index 16e3db647a..8be0a1bc60 100644 --- a/pages/common/matlab.md +++ b/pages/common/matlab.md @@ -1,7 +1,7 @@ # matlab > Numerical computation environment by MathWorks. -> More information: . +> More information: . - Run without splash screen during startup: diff --git a/pages/common/mc.md b/pages/common/mc.md index f702a74db3..aea9de0157 100644 --- a/pages/common/mc.md +++ b/pages/common/mc.md @@ -11,4 +11,4 @@ - Start Midnight Commander in black and white: -`mc -b` +`mc {{[-b|--nocolor]}}` diff --git a/pages/common/mdp.md b/pages/common/mdp.md index 08826f0cb3..71996449a9 100644 --- a/pages/common/mdp.md +++ b/pages/common/mdp.md @@ -1,7 +1,7 @@ # mdp > A command-line based tool to make presentations from Markdown files. -> More information: . +> More information: . - Launch a presentation in the terminal from a Markdown file: @@ -9,12 +9,12 @@ - Disable fading transitions: -`mdp --nofade {{presentation.md}}` +`mdp {{[-f|--nofade]}} {{presentation.md}}` - Invert font colors to use in terminals with light background: -`mdp --invert {{presentation.md}}` +`mdp {{[-i|--invert]}} {{presentation.md}}` - Disable transparency in transparent terminals: -`mdp --notrans {{presentation.md}}` +`mdp {{[-t|--notrans]}} {{presentation.md}}` diff --git a/pages/common/middleman.md b/pages/common/middleman.md index 19d7572a0a..9da735ee8b 100644 --- a/pages/common/middleman.md +++ b/pages/common/middleman.md @@ -1,7 +1,7 @@ # middleman > Static site generator written in Ruby. -> More information: . +> More information: . - Create a new Middleman project: diff --git a/pages/common/minifab.md b/pages/common/minifab.md index 693c3f9c13..ae5c21b0ce 100644 --- a/pages/common/minifab.md +++ b/pages/common/minifab.md @@ -5,7 +5,7 @@ - Bring up the default Hyperledger Fabric network: -`minifab up -i {{minifab_version}}` +`minifab up {{[-i|--fabric-release]}} {{minifab_version}}` - Bring down the Hyperledger Fabric network: @@ -13,11 +13,11 @@ - Install chaincode onto a specified channel: -`minifab install -n {{chaincode_name}}` +`minifab install {{[-n|--chaincode-name]}} {{chaincode_name}}` - Install a specific chaincode version onto a channel: -`minifab install -n {{chaincode_name}} -v {{chaincode_version}}` +`minifab install {{[-n|--chaincode-name]}} {{chaincode_name}} {{[-v|--chaincode-version]}} {{chaincode_version}}` - Initialize the chaincode after installation/upgrade: @@ -25,7 +25,7 @@ - Invoke a chaincode method with the specified arguments: -`minifab invoke -n {{chaincode_name}} -p '"{{method_name}}", "{{argument1}}", "{{argument2}}", ...'` +`minifab invoke {{[-n|--chaincode-name]}} {{chaincode_name}} {{[-p|--chaincode-parameters]}} '"{{method_name}}", "{{argument1}}", "{{argument2}}", ...'` - Make a query on the ledger: @@ -33,4 +33,4 @@ - Quickly run an application: -`minifab apprun -l {{app_programming_language}}` +`minifab apprun {{[-l|--chaincode-language]}} {{app_programming_language}}` diff --git a/pages/common/mitmdump.md b/pages/common/mitmdump.md index a54568201d..99be676834 100644 --- a/pages/common/mitmdump.md +++ b/pages/common/mitmdump.md @@ -6,12 +6,12 @@ - Start a proxy and save all output to a file: -`mitmdump -w {{path/to/file}}` +`mitmdump {{[-w|--wfile]}} {{path/to/file}}` - Filter a saved traffic file to just POST requests: -`mitmdump -nr {{input_filename}} -w {{output_filename}} "{{~m post}}"` +`mitmdump {{[-nr|--no-server --read-flows]}} {{input_filename}} {{[-w|--wfile]}} {{output_filename}} "{{~m post}}"` - Replay a saved traffic file: -`mitmdump -nc {{path/to/file}}` +`mitmdump {{[-nc|--no-server --client-replay]}} {{path/to/file}}` diff --git a/pages/common/mktorrent.md b/pages/common/mktorrent.md index e909659564..2729b8efcc 100644 --- a/pages/common/mktorrent.md +++ b/pages/common/mktorrent.md @@ -5,20 +5,20 @@ - Create a torrent with 2^21 KB as the piece size: -`mktorrent -a {{tracker_announce_url}} -l {{21}} -o {{path/to/example.torrent}} {{path/to/file_or_directory}}` +`mktorrent {{[-a|--announce]}} {{tracker_announce_url}} {{[-l|--piece-length]}} {{21}} {{[-o|--output]}} {{path/to/example.torrent}} {{path/to/file_or_directory}}` - Create a private torrent with a 2^21 KB piece size: -`mktorrent -p -a {{tracker_announce_url}} -l {{21}} -o {{path/to/example.torrent}} {{path/to/file_or_directory}}` +`mktorrent {{[-p|--private]}} {{[-a|--announce]}} {{tracker_announce_url}} {{[-l|--piece-length]}} {{21}} {{[-o|--output]}} {{path/to/example.torrent}} {{path/to/file_or_directory}}` - Create a torrent with a comment: -`mktorrent -c "{{comment}}" -a {{tracker_announce_url}} -l {{21}} -o {{path/to/example.torrent}} {{path/to/file_or_directory}}` +`mktorrent {{[-c|--comment]}} "{{comment}}" {{[-a|--announce]}} {{tracker_announce_url}} {{[-l|--piece-length]}} {{21}} {{[-o|--output]}} {{path/to/example.torrent}} {{path/to/file_or_directory}}` - Create a torrent with multiple trackers: -`mktorrent -a {{tracker_announce_url,tracker_announce_url_2}} -l {{21}} -o {{path/to/example.torrent}} {{path/to/file_or_directory}}` +`mktorrent {{[-a|--announce]}} {{tracker_announce_url,tracker_announce_url_2}} {{[-l|--piece-length]}} {{21}} {{[-o|--output]}} {{path/to/example.torrent}} {{path/to/file_or_directory}}` - Create a torrent with web seed URLs: -`mktorrent -a {{tracker_announce_url}} -w {{web_seed_url}} -l {{21}} -o {{path/to/example.torrent}} {{path/to/file_or_directory}}` +`mktorrent {{[-a|--announce]}} {{tracker_announce_url}} -w {{web_seed_url}} {{[-l|--piece-length]}} {{21}} {{[-o|--output]}} {{path/to/example.torrent}} {{path/to/file_or_directory}}` diff --git a/pages/common/mlr.md b/pages/common/mlr.md index f7cb6b9986..cc20ddef39 100644 --- a/pages/common/mlr.md +++ b/pages/common/mlr.md @@ -27,6 +27,6 @@ `echo '{"hello":"world", "foo":"bar"}' | mlr --ijson --ojson --jvstack cat` -- Filter lines of a compressed CSV file treating numbers as strings: +- Filter lines of a compressed CSV file treating numbers as [S]trings: -`mlr --prepipe 'gunzip' --csv filter -S '${{fieldName}} =~ "{{regular_expression}}"' {{example.csv.gz}}` +`mlr --prepipe 'gunzip' {{[-c|--csv]}} filter {{[-S|--infer-none]}} '${{fieldName}} =~ "{{regular_expression}}"' {{example.csv.gz}}` diff --git a/pages/common/mmdc.md b/pages/common/mmdc.md index 2570629fb3..da9ef1de8f 100644 --- a/pages/common/mmdc.md +++ b/pages/common/mmdc.md @@ -6,12 +6,12 @@ - Convert a file to the specified format (automatically determined from the file extension): -`mmdc --input {{input.mmd}} --output {{output.svg}}` +`mmdc {{[-i|--input]}} {{input.mmd}} {{[-o|--output]}} {{output.svg}}` - Specify the theme of the chart: -`mmdc --input {{input.mmd}} --output {{output.svg}} --theme {{forest|dark|neutral|default}}` +`mmdc {{[-i|--input]}} {{input.mmd}} {{[-o|--output]}} {{output.svg}} {{[-t|--theme]}} {{forest|dark|neutral|default}}` - Specify the background color of the chart (e.g. `lime`, `"#D8064F"`, or `transparent`): -`mmdc --input {{input.mmd}} --output {{output.svg}} --backgroundColor {{color}}` +`mmdc {{[-i|--input]}} {{input.mmd}} {{[-o|--output]}} {{output.svg}} {{[-b|--backgroundColor]}} {{color}}` diff --git a/pages/common/mmv.md b/pages/common/mmv.md index fdf8f52951..624ca2cfb5 100644 --- a/pages/common/mmv.md +++ b/pages/common/mmv.md @@ -9,11 +9,11 @@ - Copy `report6part4.txt` to `./french/rapport6partie4.txt` along with all similarly named files: -`mmv -c "{{report*part*.txt}}" "{{./french/rapport#1partie#2.txt}}"` +`mmv {{[-c|--copy]}} "{{report*part*.txt}}" "{{./french/rapport#1partie#2.txt}}"` - Append all `.txt` files into one file: -`mmv -a "{{*.txt}}" "{{all.txt}}"` +`mmv {{[-a|--append]}} "{{*.txt}}" "{{all.txt}}"` - Convert dates in filenames from "M-D-Y" format to "D-M-Y" format: diff --git a/pages/common/monop.md b/pages/common/monop.md index 88c7a0d20c..eda23868d0 100644 --- a/pages/common/monop.md +++ b/pages/common/monop.md @@ -17,15 +17,15 @@ - Only show members defined in the specified Type: -`monop -r:{{path/to/assembly.dll}} --only-declared {{Namespace.Path.To.Type}}` +`monop -r:{{path/to/assembly.dll}} {{[-d|--declared-only]}} {{Namespace.Path.To.Type}}` - Show private members: -`monop -r:{{path/to/assembly.dll}} --private {{Namespace.Path.To.Type}}` +`monop -r:{{path/to/assembly.dll}} {{[-p|--private]}} {{Namespace.Path.To.Type}}` - Hide obsolete members: -`monop -r:{{path/to/assembly.dll}} --filter-obsolete {{Namespace.Path.To.Type}}` +`monop -r:{{path/to/assembly.dll}} {{[-f|--filter-obsolete]}} {{Namespace.Path.To.Type}}` - List the other assemblies that a specified assembly references: diff --git a/pages/common/mosquitto_pub.md b/pages/common/mosquitto_pub.md index cde30e4c3d..01dcfc806c 100644 --- a/pages/common/mosquitto_pub.md +++ b/pages/common/mosquitto_pub.md @@ -5,24 +5,24 @@ - Publish a temperature value of 32 on the topic `sensors/temperature` to 192.168.1.1 (defaults to `localhost`) with Quality of Service (`QoS`) set to 1: -`mosquitto_pub -h {{192.168.1.1}} -t {{sensors/temperature}} -m {{32}} -q {{1}}` +`mosquitto_pub {{[-h|--host]}} {{192.168.1.1}} {{[-t|--topic]}} {{sensors/temperature}} {{[-m|--message]}} {{32}} {{[-q|--qos]}} {{1}}` - Publish timestamp and temperature data on the topic `sensors/temperature` to a remote host on a non-standard port: -`mosquitto_pub -h {{192.168.1.1}} -p {{1885}} -t {{sensors/temperature}} -m "{{1266193804 32}}"` +`mosquitto_pub {{[-h|--host]}} {{192.168.1.1}} {{[-p|--port]}} {{1885}} {{[-t|--topic]}} {{sensors/temperature}} {{[-m|--message]}} "{{1266193804 32}}"` - Publish light switch status and retain the message on the topic `switches/kitchen_lights/status` to a remote host because there may be a long period of time between light switch events: -`mosquitto_pub -r -h "{{iot.eclipse.org}}" -t {{switches/kitchen_lights/status}} -m "{{on}}"` +`mosquitto_pub {{[-r|--retain]}} {{[-h|--host]}} "{{iot.eclipse.org}}" {{[-t|--topic]}} {{switches/kitchen_lights/status}} {{[-m|--message]}} "{{on}}"` - Send the contents of a file (`data.txt`) as a message and publish it to `sensors/temperature` topic: -`mosquitto_pub -t {{sensors/temperature}} -f {{data.txt}}` +`mosquitto_pub {{[-t|--topic]}} {{sensors/temperature}} {{[-f|--file]}} {{data.txt}}` - Send the contents of a file (`data.txt`), by reading from `stdin` and send the entire input as a message and publish it to `sensors/temperature` topic: -`mosquitto_pub -t {{sensors/temperature}} -s < {{data.txt}}` +`mosquitto_pub {{[-t|--topic]}} {{sensors/temperature}} {{[-s|--stdin-file]}} < {{data.txt}}` - Read newline delimited data from `stdin` as a message and publish it to `sensors/temperature` topic: -`{{echo data.txt}} | mosquitto_pub -t {{sensors/temperature}} -l` +`{{echo data.txt}} | mosquitto_pub {{[-t|--topic]}} {{sensors/temperature}} {{[-l|--stdin-line]}}` diff --git a/pages/common/mosquitto_sub.md b/pages/common/mosquitto_sub.md index 321ffa69ed..75e457e04f 100644 --- a/pages/common/mosquitto_sub.md +++ b/pages/common/mosquitto_sub.md @@ -5,12 +5,12 @@ - Subscribe to the topic `sensors/temperature` information with Quality of Service (`QoS`) set to 1. (The default hostname is `localhost` and port 1883): -`mosquitto_sub -t {{sensors/temperature}} -q {{1}}` +`mosquitto_sub {{[-t|--topic]}} {{sensors/temperature}} {{[-q|--qos]}} {{1}}` - Subscribe to all broker status messages publishing on `iot.eclipse.org` port 1885 and print published messages verbosely: -`mosquitto_sub -v -h "iot.eclipse.org" -p 1885 -t {{\$SYS/#}}` +`mosquitto_sub {{[-v|--verbose]}} {{[-h|--host]}} "iot.eclipse.org" {{[-p|--port]}} 1885 {{[-t|--topic]}} {{\$SYS/#}}` - Subscribe to multiple topics matching a given pattern. (+ takes any metric name): -`mosquitto_sub -t {{sensors/machines/+/temperature/+}}` +`mosquitto_sub {{[-t|--topic]}} {{sensors/machines/+/temperature/+}}` diff --git a/pages/common/mpg321.md b/pages/common/mpg321.md index 94b9249426..917b3e7930 100644 --- a/pages/common/mpg321.md +++ b/pages/common/mpg321.md @@ -2,11 +2,11 @@ > High Performance MPEG 1.0/2.0/2.5 Audio Player for Layer 1, 2, and 3. > Mpg321 was written (sometime in 1999) to be a drop-in replacement for the (previously) non-free mpg123 player. -> More information: . +> More information: . - Play an audio source exactly `n` times (0 means forever): -`mpg321 -l {{n}} {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` +`mpg321 {{[-l|--loop]}} {{n}} {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` - Play a directory recursively: @@ -18,12 +18,12 @@ - Play files randomly until interrupted: -`mpg321 -Z {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` +`mpg321 {{[-Z|--random]}} {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` - Shuffle the files before playing them once: -`mpg321 -z {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` +`mpg321 {{[-z|--shuffle]}} {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` - Play all files in the current directory and subdirectories, randomly (until interrupted), with Basic Keys enabled: -`mpg321 -B -Z -K .` +`mpg321 -B {{[-Z|--random]}} -K .` diff --git a/pages/common/mpv.md b/pages/common/mpv.md index c58c8b26d0..d93a1bead7 100644 --- a/pages/common/mpv.md +++ b/pages/common/mpv.md @@ -20,6 +20,10 @@ `{{<[>|<]>}}` +- Add subtitles from a file: + +`mpv --sub-file={{path/to/file}}` + - Take a screenshot of the current frame (saved to `./mpv-shotNNNN.jpg` by default): `` @@ -31,7 +35,3 @@ - Play a file using a profile defined in the `mpv.conf` file: `mpv --profile {{profile_name}} {{path/to/file}}` - -- Display the output of webcam or other video input device: - -`mpv {{/dev/video0}}` diff --git a/pages/common/mr.md b/pages/common/mr.md index 3873beffb0..679f224adc 100644 --- a/pages/common/mr.md +++ b/pages/common/mr.md @@ -9,7 +9,7 @@ - Update repositories in 5 concurrent jobs: -`mr -j{{5}} update` +`mr {{[-j|--jobs]}} {{5}} update` - Print the status of all repositories: diff --git a/pages/common/msedge.md b/pages/common/msedge.md index 69b5401608..64fb6e3b5a 100644 --- a/pages/common/msedge.md +++ b/pages/common/msedge.md @@ -5,8 +5,8 @@ - View the documentation for Microsoft Edge for Windows: -`tldr -p windows msedge` +`tldr {{[-p|--platform]}} windows msedge` - View the documentation for Microsoft Edge for other platforms: -`tldr -p common microsoft-edge` +`tldr {{[-p|--platform]}} common microsoft-edge` diff --git a/pages/common/msfvenom.md b/pages/common/msfvenom.md index 91b34ce379..50da838656 100644 --- a/pages/common/msfvenom.md +++ b/pages/common/msfvenom.md @@ -1,28 +1,28 @@ # msfvenom > Manually generate payloads for metasploit. -> More information: . +> More information: . - List payloads: -`msfvenom -l payloads` +`msfvenom {{[-l|--list]}} payloads` - List formats: -`msfvenom -l formats` +`msfvenom {{[-l|--list]}} formats` - Show payload options: -`msfvenom -p {{payload}} --list-options` +`msfvenom {{[-p|--payload]}} {{payload}} --list-options` - Create an ELF binary with a reverse TCP handler: -`msfvenom -p linux/x64/meterpreter/reverse_tcp LHOST={{local_ip}} LPORT={{local_port}} -f elf -o {{path/to/binary}}` +`msfvenom {{[-p|--payload]}} linux/x64/meterpreter/reverse_tcp LHOST={{local_ip}} LPORT={{local_port}} {{[-f|--format]}} elf {{[-o|--out]}} {{path/to/binary}}` - Create an EXE binary with a reverse TCP handler: -`msfvenom -p windows/x64/meterpreter/reverse_tcp LHOST={{local_ip}} LPORT={{local_port}} -f exe -o {{path/to/binary.exe}}` +`msfvenom {{[-p|--payload]}} windows/x64/meterpreter/reverse_tcp LHOST={{local_ip}} LPORT={{local_port}} {{[-f|--format]}} exe {{[-o|--out]}} {{path/to/binary.exe}}` - Create a raw Bash with a reverse TCP handler: -`msfvenom -p cmd/unix/reverse_bash LHOST={{local_ip}} LPORT={{local_port}} -f raw` +`msfvenom {{[-p|--payload]}} cmd/unix/reverse_bash LHOST={{local_ip}} LPORT={{local_port}} {{[-f|--format]}} raw` diff --git a/pages/common/multipass.md b/pages/common/multipass.md index 327c1126da..c876580686 100644 --- a/pages/common/multipass.md +++ b/pages/common/multipass.md @@ -9,7 +9,7 @@ - Launch a new instance, set its name and use a cloud-init configuration file: -`multipass launch -n {{instance_name}} --cloud-init {{configuration_file}}` +`multipass launch {{[-n|--name]}} {{instance_name}} --cloud-init {{configuration_file}}` - List all the created instances and some of their properties: diff --git a/pages/common/musescore.md b/pages/common/musescore.md index c55c7e96ec..eec48f2802 100644 --- a/pages/common/musescore.md +++ b/pages/common/musescore.md @@ -2,7 +2,7 @@ > MuseScore 3 sheet music editor. > See also: `lilypond`. -> More information: . +> More information: . - Use a specific audio driver: diff --git a/pages/common/mysql.md b/pages/common/mysql.md index d45418ca81..d83cb059af 100644 --- a/pages/common/mysql.md +++ b/pages/common/mysql.md @@ -9,24 +9,24 @@ - Connect to a database, user will be prompted for a password: -`mysql -u {{user}} --password {{database_name}}` +`mysql {{[-u|--user]}} {{user}} {{[-p|--password]}} {{database_name}}` - Connect to a database on another host: -`mysql -h {{database_host}} {{database_name}}` +`mysql {{[-h|--host]}} {{database_host}} {{database_name}}` - Connect to a database through a Unix socket: -`mysql --socket {{path/to/socket.sock}}` +`mysql {{[-S|--socket]}} {{path/to/socket.sock}}` - Execute SQL statements in a script file (batch file): -`mysql -e "source {{filename.sql}}" {{database_name}}` +`mysql {{[-e|--execute]}} "source {{filename.sql}}" {{database_name}}` - Restore a database from a backup created with `mysqldump` (user will be prompted for a password): -`mysql --user {{user}} --password {{database_name}} < {{path/to/backup.sql}}` +`mysql {{[-u|--user]}} {{user}} {{[-p|--password]}} {{database_name}} < {{path/to/backup.sql}}` - Restore all databases from a backup (user will be prompted for a password): -`mysql --user {{user}} --password < {{path/to/backup.sql}}` +`mysql {{[-u|--user]}} {{user}} {{[-p|--password]}} < {{path/to/backup.sql}}` diff --git a/pages/common/mysqlbinlog.md b/pages/common/mysqlbinlog.md index d6a72754c5..9715a98bc4 100644 --- a/pages/common/mysqlbinlog.md +++ b/pages/common/mysqlbinlog.md @@ -1,7 +1,7 @@ # mysqlbinlog > Utility for processing MySQL binary log files. -> More information: . +> More information: . - Show events from a specific binary log file: diff --git a/pages/common/mysqlcheck.md b/pages/common/mysqlcheck.md index 543d4b8933..8ef8037b98 100644 --- a/pages/common/mysqlcheck.md +++ b/pages/common/mysqlcheck.md @@ -1,7 +1,7 @@ # mysqlcheck > Check and repair MySQL tables. -> More information: . +> More information: . - Check a table: diff --git a/pages/common/mysqlsh.md b/pages/common/mysqlsh.md index 4b92e2278d..80cfe0bbce 100644 --- a/pages/common/mysqlsh.md +++ b/pages/common/mysqlsh.md @@ -2,7 +2,7 @@ > Advanced command-line client for MySQL, supporting SQL, JavaScript, and Python. > It offers features for managing InnoDB clusters and document store collections. -> More information: . +> More information: . - Start MySQL Shell in interactive mode: diff --git a/pages/common/mytop.md b/pages/common/mytop.md index 5efc070717..5be8a45302 100644 --- a/pages/common/mytop.md +++ b/pages/common/mytop.md @@ -9,12 +9,12 @@ - Connect with a specified username and password: -`mytop -u {{user}} -p {{password}}` +`mytop {{[-u|-user]}} {{user}} {{[-p|-password]}} {{password}}` - Connect with a specified username (the user will be prompted for a password): -`mytop -u {{user}} --prompt` +`mytop {{[-u|-user]}} {{user}} -prompt` - Do not show any idle (sleeping) threads: -`mytop -u {{user}} -p {{password}} --noidle` +`mytop {{[-u|-user]}} {{user}} {{[-p|-password]}} {{password}} --noidle` diff --git a/pages/common/naabu.md b/pages/common/naabu.md index dc97281a75..907a3c85b3 100644 --- a/pages/common/naabu.md +++ b/pages/common/naabu.md @@ -10,24 +10,24 @@ - Display available network interfaces and public IP address of the local host: -`naabu -interface-list` +`naabu {{[-il|-interface-list]}}` - Scan all ports of the remote host (CONNECT scan without `sudo`): -`naabu -p - -host {{host}}` +`naabu {{[-p|-port]}} - -host {{host}}` - Scan the top 1000 ports of the remote host: -`naabu -top-ports 1000 -host {{host}}` +`naabu {{[-tp|-top-ports]}} 1000 -host {{host}}` - Scan TCP ports 80, 443 and UDP port 53 of the remote host: -`naabu -p 80,443,u:53 -host {{host}}` +`naabu {{[-p|-port]}} 80,443,u:53 -host {{host}}` - Show CDN type the remote host is using, if any: -`naabu -p 80,443 -cdn -host {{host}}` +`naabu {{[-p|-port]}} 80,443 -cdn -host {{host}}` - Run `nmap` from `naabu` for additional functionalities (`nmap` must be installed): -`sudo naabu -v -host {{host}} -nmap-cli 'nmap {{-v -T5 -sC}}'` +`sudo naabu {{[-v|-verbose]}} -host {{host}} -nmap-cli 'nmap {{-v -T5 -sC}}'` diff --git a/pages/common/nasm.md b/pages/common/nasm.md index 479dfba23e..74ebc8dde0 100644 --- a/pages/common/nasm.md +++ b/pages/common/nasm.md @@ -1,7 +1,7 @@ # nasm > The Netwide Assembler, a portable 80x86 assembler. -> More information: . +> More information: . - Assemble `source.asm` into a binary file `source`, in the (default) raw binary format: diff --git a/pages/common/newsboat.md b/pages/common/newsboat.md index f5ab5eed3b..70a8103be1 100644 --- a/pages/common/newsboat.md +++ b/pages/common/newsboat.md @@ -5,7 +5,7 @@ - First import feed URLs from an OPML file: -`newsboat -i {{my-feeds.xml}}` +`newsboat {{[-i|--import-from-opml]}} {{my-feeds.xml}}` - Alternatively, add feeds manually: @@ -13,11 +13,11 @@ - Start Newsboat and refresh all feeds on startup: -`newsboat -r` +`newsboat {{[-r|--refresh-on-start]}}` - Execute one or more commands in non-interactive mode: -`newsboat -x {{reload print-unread ...}}` +`newsboat {{[-x|--execute]}} {{reload print-unread ...}}` - See keyboard shortcuts (the most relevant are visible in the status line): diff --git a/pages/common/ngrep.md b/pages/common/ngrep.md index 71f73828a8..79f3730389 100644 --- a/pages/common/ngrep.md +++ b/pages/common/ngrep.md @@ -1,7 +1,7 @@ # ngrep > Filter network traffic packets using regular expressions. -> More information: . +> More information: . - Capture traffic of all interfaces: diff --git a/pages/common/nikto.md b/pages/common/nikto.md index 4fd6582555..e9ed35be3a 100644 --- a/pages/common/nikto.md +++ b/pages/common/nikto.md @@ -5,20 +5,20 @@ - Perform a basic Nikto scan against a target host: -`perl nikto.pl -h {{192.168.0.1}}` +`perl nikto.pl {{[-h|-host]}} {{192.168.0.1}}` - Specify the port number when performing a basic scan: -`perl nikto.pl -h {{192.168.0.1}} -p {{443}}` +`perl nikto.pl {{[-h|-host]}} {{192.168.0.1}} {{[-p|-port]}} {{443}}` - Scan ports and protocols with full URL syntax: -`perl nikto.pl -h {{https://192.168.0.1:443/}}` +`perl nikto.pl {{[-h|-host]}} {{https://192.168.0.1:443/}}` - Scan multiple ports in the same scanning session: -`perl nikto.pl -h {{192.168.0.1}} -p {{80,88,443}}` +`perl nikto.pl {{[-h|-host]}} {{192.168.0.1}} {{[-p|-port]}} {{80,88,443}}` - Update to the latest plugins and databases: -`perl nikto.pl -update` +`perl nikto.pl {{[-u|-update]}}` diff --git a/pages/common/nim.md b/pages/common/nim.md index a838536fab..92d565248a 100644 --- a/pages/common/nim.md +++ b/pages/common/nim.md @@ -6,19 +6,19 @@ - Compile a source file: -`nim compile {{path/to/file.nim}}` +`nim {{[c|compile]}} {{path/to/file.nim}}` - Compile and run a source file: -`nim compile -r {{path/to/file.nim}}` +`nim {{[c|compile]}} {{[-r|--run]}} {{path/to/file.nim}}` - Compile a source file with release optimizations enabled: -`nim compile -d:release {{path/to/file.nim}}` +`nim {{[c|compile]}} {{[-d|--define]}}:release {{path/to/file.nim}}` - Build a release binary optimized for low file size: -`nim compile -d:release --opt:size {{path/to/file.nim}}` +`nim {{[c|compile]}} {{[-d|--define]}}:release --opt:size {{path/to/file.nim}}` - Generate HTML documentation for a module (output will be placed in the current directory): diff --git a/pages/common/nimble.md b/pages/common/nimble.md index b62b4b7fdc..0a86877ea6 100644 --- a/pages/common/nimble.md +++ b/pages/common/nimble.md @@ -14,7 +14,7 @@ - List installed packages: -`nimble list -i` +`nimble list {{[-i|--installed]}}` - Create a new Nimble package in the current directory: diff --git a/pages/common/nix-classic.md b/pages/common/nix-classic.md index 056c31bf6c..a82c751d18 100644 --- a/pages/common/nix-classic.md +++ b/pages/common/nix-classic.md @@ -6,19 +6,19 @@ - Search for a package in nixpkgs via its name: -`nix-env -qaP {{search_term_regexp}}` +`nix-env {{[-qaP|--query --available --attr-path]}} {{search_term_regexp}}` - Start a shell with the specified packages available: -`nix-shell -p {{pkg1 pkg2 pkg3...}}` +`nix-shell {{[-p|--packages]}} {{pkg1 pkg2 pkg3...}}` - Install some packages permanently: -`nix-env -iA {{nixpkgs.pkg1 nixpkgs.pkg2...}}` +`nix-env {{[-iA|--install --attr]}} {{nixpkgs.pkg1 nixpkgs.pkg2...}}` - Show all dependencies of a store path (package), in a tree format: -`nix-store --query --tree {{/nix/store/...}}` +`nix-store {{[-q|--query]}} --tree {{/nix/store/...}}` - Update the channels (repositories): diff --git a/pages/common/nix-env.md b/pages/common/nix-env.md index 7dfabf73f5..0a01465add 100644 --- a/pages/common/nix-env.md +++ b/pages/common/nix-env.md @@ -5,32 +5,32 @@ - List all installed packages: -`nix-env -q` +`nix-env {{[-q|--query]}}` - Query installed packages: -`nix-env -q {{search_term}}` +`nix-env {{[-q|--query]}} {{search_term}}` - Query available packages: -`nix-env -qa {{search_term}}` +`nix-env {{[-qa|--query --available]}} {{search_term}}` - Install package: -`nix-env -iA nixpkgs.{{pkg_name}}` +`nix-env {{[-iA|--install --attr]}} nixpkgs.{{pkg_name}}` - Install a package from a URL: -`nix-env -i {{pkg_name}} --file {{example.com}}` +`nix-env {{[-i|--install]}} {{pkg_name}} {{[-f|--file]}} {{example.com}}` - Uninstall package: -`nix-env -e {{pkg_name}}` +`nix-env {{[-e|--uninstall]}} {{pkg_name}}` - Upgrade one package: -`nix-env -u {{pkg_name}}` +`nix-env {{[-u|--upgrade]}} {{pkg_name}}` - Upgrade all packages: -`nix-env -u` +`nix-env {{[-u|--upgrade]}}` diff --git a/pages/common/nix-shell.md b/pages/common/nix-shell.md index f445c7e733..08ed62d190 100644 --- a/pages/common/nix-shell.md +++ b/pages/common/nix-shell.md @@ -18,12 +18,12 @@ - Start with packages loaded from nixpkgs: -`nix-shell --packages {{package1 package2 ...}}` +`nix-shell {{[-p|--packages]}} {{package1 package2 ...}}` - Start with packages loaded from specific nixpkgs revision: -`nix-shell --packages {{package1 package2 ...}} -I nixpkgs={{https://github.com/NixOS/nixpkgs/archive/nixpkgs_revision.tar.gz}}` +`nix-shell {{[-p|--packages]}} {{package1 package2 ...}} {{[-I|--include]}} nixpkgs={{https://github.com/NixOS/nixpkgs/archive/nixpkgs_revision.tar.gz}}` - Evaluate rest of file in specific interpreter, for use in `#!-scripts` (see ): -`nix-shell -i {{interpreter}} --packages {{package1 package2 ...}}` +`nix-shell -i {{interpreter}} {{[-p|--packages]}} {{package1 package2 ...}}` diff --git a/pages/common/nix-store.md b/pages/common/nix-store.md index 111319e993..5f5cdcdd6f 100644 --- a/pages/common/nix-store.md +++ b/pages/common/nix-store.md @@ -18,12 +18,12 @@ - Show all dependencies of a store path (package), in a tree format: -`nix-store --query --tree {{/nix/store/...}}` +`nix-store {{[-q|--query]}} --tree {{/nix/store/...}}` - Calculate the total size of a certain store path with all the dependencies: -`du -cLsh $(nix-store --query --references {{/nix/store/...}})` +`du {{[-cLsh|--total --dereference --summarize --human-readable]}} $(nix-store {{[-q|--query]}} --references {{/nix/store/...}})` - Show all dependents of a particular store path: -`nix-store --query --referrers {{/nix/store/...}}` +`nix-store {{[-q|--query]}} --referrers {{/nix/store/...}}` diff --git a/pages/common/nix.md b/pages/common/nix.md index b16e33f896..045eb87bfa 100644 --- a/pages/common/nix.md +++ b/pages/common/nix.md @@ -7,7 +7,7 @@ - Enable the `nix` command: -`mkdir -p ~/.config/nix; echo 'experimental-features = nix-command flakes' > ~/.config/nix/nix.conf` +`mkdir {{[-p|--parents]}} ~/.config/nix; echo 'experimental-features = nix-command flakes' > ~/.config/nix/nix.conf` - Search for a package in nixpkgs via its name or description: diff --git a/pages/common/nm.md b/pages/common/nm.md index b723010f7d..cd2ba14182 100644 --- a/pages/common/nm.md +++ b/pages/common/nm.md @@ -5,16 +5,16 @@ - List global (extern) functions in a file (prefixed with T): -`nm -g {{path/to/file.o}}` +`nm {{[-g|--extern-only]}} {{path/to/file.o}}` - List only undefined symbols in a file: -`nm -u {{path/to/file.o}}` +`nm {{[-u|--undefined-only]}} {{path/to/file.o}}` - List all symbols, even debugging symbols: -`nm -a {{path/to/file.o}}` +`nm {{[-a|--debug-syms]}} {{path/to/file.o}}` - Demangle C++ symbols (make them readable): -`nm --demangle {{path/to/file.o}}` +`nm {{[-C|--demangle]}} {{path/to/file.o}}` diff --git a/pages/common/node.md b/pages/common/node.md index b6c42d9a16..1b7d842913 100644 --- a/pages/common/node.md +++ b/pages/common/node.md @@ -17,11 +17,11 @@ - Evaluate JavaScript code by passing it as an argument: -`node -e "{{code}}"` +`node {{[-e|--eval]}} "{{code}}"` - Evaluate and print the result, useful to print node's dependencies versions: -`node -p "process.versions"` +`node {{[-p|--print]}} "process.versions"` - Activate inspector, pausing execution until a debugger is connected once source code is fully parsed: diff --git a/pages/common/noti.md b/pages/common/noti.md index 01fe859ad3..a686f4ecec 100644 --- a/pages/common/noti.md +++ b/pages/common/noti.md @@ -13,4 +13,4 @@ - Monitor a process by PID and trigger a notification when the PID disappears: -`noti -w {{process_id}}` +`noti {{[-w|--pwatch]}} {{process_id}}` diff --git a/pages/common/npm-access.md b/pages/common/npm-access.md index 9b5ffbaad2..1d2e0f0a90 100644 --- a/pages/common/npm-access.md +++ b/pages/common/npm-access.md @@ -17,7 +17,7 @@ - Set package status (public or private): -`npm access set status={{public|private}} {{package_name}}` +`npm access set status {{public|private}} {{package_name}}` - Grant access to a package: @@ -29,4 +29,4 @@ - Configure two-factor authentication requirement: -`npm access set mfa={{none|publish|automation}} {{package_name}}` +`npm access set mfa {{none|publish|automation}} {{package_name}}` diff --git a/pages/common/npm-adduser.md b/pages/common/npm-adduser.md index 347dd540f2..0c2ca68a98 100644 --- a/pages/common/npm-adduser.md +++ b/pages/common/npm-adduser.md @@ -5,16 +5,16 @@ - Create a new user in the specified registry and save credentials to `.npmrc`: -`npm adduser --registry={{registry_url}}` +`npm adduser --registry {{registry_url}}` - Log in to a private registry with a specific scope: -`npm login --scope={{@mycorp}} --registry={{https://registry.mycorp.com}}` +`npm login --scope {{@mycorp}} --registry {{https://registry.mycorp.com}}` - Log out from a specific scope and remove the auth token: -`npm logout --scope={{@mycorp}}` +`npm logout --scope {{@mycorp}}` - Create a scoped package during initialization: -`npm init --scope={{@foo}} {{--yes}}` +`npm init --scope {{@foo}} {{[-y|--yes]}}` diff --git a/pages/common/npm-audit.md b/pages/common/npm-audit.md index bc45d35737..f57fee4896 100644 --- a/pages/common/npm-audit.md +++ b/pages/common/npm-audit.md @@ -30,4 +30,4 @@ - Configure the audit to only fail on vulnerabilities above a specified severity: -`npm audit --audit-level={{info|low|moderate|high|critical}}` +`npm audit --audit-level {{info|low|moderate|high|critical}}` diff --git a/pages/common/npm-check.md b/pages/common/npm-check.md index 0ebb193a89..d30b484316 100644 --- a/pages/common/npm-check.md +++ b/pages/common/npm-check.md @@ -9,12 +9,12 @@ - Interactively update out-of-date packages: -`npm-check --update` +`npm-check {{[-u|--update]}}` - Update everything without prompting: -`npm-check --update-all` +`npm-check {{[-y|--update-all]}}` - Don't check for unused packages: -`npm-check --skip-unused` +`npm-check {{[-s|--skip-unused]}}` diff --git a/pages/common/npm-ci.md b/pages/common/npm-ci.md index a6d525f3ba..caf32ddc14 100644 --- a/pages/common/npm-ci.md +++ b/pages/common/npm-ci.md @@ -10,7 +10,7 @@ - Install project dependencies but skip the specified dependency type: -`npm ci --omit={{dev|optional|peer}}` +`npm ci --omit {{dev|optional|peer}}` - Install project dependencies without running any pre-/post-scripts defined in `package.json`: diff --git a/pages/common/npm-dedupe.md b/pages/common/npm-dedupe.md index 24e976d7f2..365f3c488f 100644 --- a/pages/common/npm-dedupe.md +++ b/pages/common/npm-dedupe.md @@ -17,11 +17,11 @@ - Skip optional/peer dependencies during deduplication: -`npm dedupe --omit={{optional|peer}}` +`npm dedupe --omit {{optional|peer}}` - Enable detailed logging for troubleshooting: -`npm dedupe --loglevel=verbose` +`npm dedupe --loglevel verbose` - Limit deduplication to a specific package: diff --git a/pages/common/npm-find-dupes.md b/pages/common/npm-find-dupes.md index 43fc6cbe8c..b08740e9a4 100644 --- a/pages/common/npm-find-dupes.md +++ b/pages/common/npm-find-dupes.md @@ -9,7 +9,7 @@ - Include `devDependencies` in duplicate detection: -`npm find-dupes --include=dev` +`npm find-dupes --include dev` - List all duplicate instances of a specific package in `node-modules`: @@ -17,11 +17,11 @@ - Exclude optional dependencies from duplicate detection: -`npm find-dupes --omit=optional` +`npm find-dupes --omit optional` - Set the logging level for output: -`npm find-dupes --loglevel={{silent|error|warn|info|verbose}}` +`npm find-dupes --loglevel {{silent|error|warn|info|verbose}}` - Output duplicate information in JSON format: @@ -29,8 +29,8 @@ - Limit duplicate search to specific scopes: -`npm find-dupes --scope={{@scope1,@scope2}}` +`npm find-dupes --scope {{@scope1,@scope2}}` - Exclude specific scopes from duplicate detection: -`npm find-dupes --omit-scope={{@scope1,@scope2}}` +`npm find-dupes --omit-scope {{@scope1,@scope2}}` diff --git a/pages/common/npm-fund.md b/pages/common/npm-fund.md index 6e2ff592b4..e3cd45f7ac 100644 --- a/pages/common/npm-fund.md +++ b/pages/common/npm-fund.md @@ -11,6 +11,6 @@ `npm fund {{package}}` -- List dependencies with a funding URL for a specific [w]orkspace for the project in the current directory: +- List dependencies with a funding URL for a specific workspace for the project in the current directory: -`npm fund -w {{workspace}}` +`npm fund {{[-w|--workspace]}} {{workspace}}` diff --git a/pages/common/npm-home.md b/pages/common/npm-home.md index 73b004f3ed..95940d1484 100644 --- a/pages/common/npm-home.md +++ b/pages/common/npm-home.md @@ -1,6 +1,6 @@ -# npm home +# npm-home -> Open the npm page, Yarn page, or GitHub repository of a package in the web browser. +> Open the `npm` page, Yarn page, or GitHub repository of a package in the web browser. > More information: . - Open the `npm` page of a specific package in the web browser: @@ -9,8 +9,8 @@ - Open the GitHub repository of a specific package in the web browser: -`npm-home -g {{package}}` +`npm-home {{[-g|--github]}} {{package}}` - Open the Yarn page of a specific package in the web browser: -`npm-home -y {{package}}` +`npm-home {{[-y|--yarn]}} {{package}}` diff --git a/pages/common/npm-init.md b/pages/common/npm-init.md index 82b273d511..a791570d03 100644 --- a/pages/common/npm-init.md +++ b/pages/common/npm-init.md @@ -9,7 +9,7 @@ - Initialize a new package with default values: -`npm init -y` +`npm init {{[-y|--yes]}}` - Initialize a new package using a specific initializer: diff --git a/pages/common/npm-login.md b/pages/common/npm-login.md index d4bf7ff0e3..7461967add 100644 --- a/pages/common/npm-login.md +++ b/pages/common/npm-login.md @@ -10,8 +10,8 @@ - Log in using a custom registry: -`npm login --registry={{registry_url}}` +`npm login --registry {{registry_url}}` - Log in using a specific authentication strategy: -`npm login --auth-type={{legacy|web}}` +`npm login --auth-type {{legacy|web}}` diff --git a/pages/common/npm-logout.md b/pages/common/npm-logout.md index 12b2f71e1f..10700af6b6 100644 --- a/pages/common/npm-logout.md +++ b/pages/common/npm-logout.md @@ -10,4 +10,4 @@ - Log out using a custom registry: -`npm logout --registry={{registry_url}}` +`npm logout --registry {{registry_url}}` diff --git a/pages/common/npm-ls.md b/pages/common/npm-ls.md index 57c7529fff..735d95f8f8 100644 --- a/pages/common/npm-ls.md +++ b/pages/common/npm-ls.md @@ -9,15 +9,15 @@ - Print all installed packages including peer dependencies: -`npm ls --all` +`npm ls {{[-a|--all]}}` - Print dependencies with extended information: -`npm ls --long` +`npm ls {{[-l|--long]}}` - Print dependencies in parseable format: -`npm ls --parseable` +`npm ls {{[-p|--parseable]}}` - Print dependencies in JSON format: diff --git a/pages/common/npm-outdated.md b/pages/common/npm-outdated.md index 50ec9800d1..391ca1b567 100644 --- a/pages/common/npm-outdated.md +++ b/pages/common/npm-outdated.md @@ -9,4 +9,4 @@ - Find packages that are outdated regardless of the current project: -`npm outdated --all` +`npm outdated {{[-a|--all]}}` diff --git a/pages/common/npm-query.md b/pages/common/npm-query.md index eb3cec460d..4c795f8236 100644 --- a/pages/common/npm-query.md +++ b/pages/common/npm-query.md @@ -25,8 +25,8 @@ - Find all dependencies with postinstall scripts and uninstall them: -`npm query ":attr(scripts, [postinstall])" | jq 'map(.name) | join("\n")' -r | xargs -I {} npm uninstall {}` +`npm query ":attr(scripts, [postinstall])" | jq 'map(.name) | join("\n")' {{[-r|--raw-output]}} | xargs -I _ npm uninstall _` - Find all Git dependencies and print which application requires them: -`npm query ":type(git)" | jq 'map(.name)' | xargs -I {} npm why {}` +`npm query ":type(git)" | jq 'map(.name)' | xargs -I _ npm why _` diff --git a/pages/common/npm-root.md b/pages/common/npm-root.md index 2932585d9e..4f2d9278e4 100644 --- a/pages/common/npm-root.md +++ b/pages/common/npm-root.md @@ -9,4 +9,4 @@ - Display path to the global `node_modules` directory: -`npm root --global` +`npm root {{[-g|--global]}}` diff --git a/pages/common/npm-uninstall.md b/pages/common/npm-uninstall.md index 1236ebcdb9..3cd36c2083 100644 --- a/pages/common/npm-uninstall.md +++ b/pages/common/npm-uninstall.md @@ -1,7 +1,7 @@ # npm uninstall > Remove a package. -> More information: . +> More information: . - Remove a package from the current project: @@ -9,7 +9,7 @@ - Remove a package globally: -`npm uninstall -g {{package_name}}` +`npm uninstall {{[-g|--global]}} {{package_name}}` - Remove multiple packages at once: diff --git a/pages/common/npm-unpublish.md b/pages/common/npm-unpublish.md index 9295f934e4..b83152e2f8 100644 --- a/pages/common/npm-unpublish.md +++ b/pages/common/npm-unpublish.md @@ -1,7 +1,7 @@ # npm unpublish > Remove a package from the npm registry. -> More information: . +> More information: . - Unpublish a specific package version: @@ -9,7 +9,7 @@ - Unpublish the entire package: -`npm unpublish {{package_name}} --force` +`npm unpublish {{package_name}} {{[-f|--force]}}` - Unpublish a package that is scoped: diff --git a/pages/common/npm-update.md b/pages/common/npm-update.md index 834d3eae9c..71601a0085 100644 --- a/pages/common/npm-update.md +++ b/pages/common/npm-update.md @@ -13,7 +13,7 @@ - Update a package globally: -`npm update -g {{package}}` +`npm update {{[-g|--global]}} {{package}}` - Update multiple packages at once: diff --git a/pages/common/npm-version.md b/pages/common/npm-version.md index a3c806686d..e12b67e215 100644 --- a/pages/common/npm-version.md +++ b/pages/common/npm-version.md @@ -21,4 +21,4 @@ - Bump the major version with a custom commit message: -`npm version major -m "{{Upgrade to %s for reasons}}"` +`npm version major {{[-m|--message]}} "{{Upgrade to %s for reasons}}"` diff --git a/pages/common/nth.md b/pages/common/nth.md index b18a2e807b..423d78f2a9 100644 --- a/pages/common/nth.md +++ b/pages/common/nth.md @@ -5,16 +5,16 @@ - Name a hash: -`nth -t {{5f4dcc3b5aa765d61d8327deb882cf99}}` +`nth {{[-t|--text]}} {{5f4dcc3b5aa765d61d8327deb882cf99}}` - Name hashes in a file: -`nth -f {{path/to/hashes}}` +`nth {{[-f|--file]}} {{path/to/hashes}}` - Print in JSON format: -`nth -t {{5f4dcc3b5aa765d61d8327deb882cf99}} -g` +`nth {{[-t|--text]}} {{5f4dcc3b5aa765d61d8327deb882cf99}} {{[-g|--greppable]}}` - Decode hash in Base64 before naming it: -`nth -t {{NWY0ZGNjM2I1YWE3NjVkNjFkODMyN2RlYjg4MmNmOTkK}} -b64` +`nth {{[-t|--text]}} {{NWY0ZGNjM2I1YWE3NjVkNjFkODMyN2RlYjg4MmNmOTkK}} {{[-b64|--base64]}}` diff --git a/pages/common/nvidia-smi.md b/pages/common/nvidia-smi.md index ba004d01a1..0ab116db8f 100644 --- a/pages/common/nvidia-smi.md +++ b/pages/common/nvidia-smi.md @@ -9,7 +9,7 @@ - Display more detailed GPU information: -`nvidia-smi --query` +`nvidia-smi {{[-q|--query]}}` - Monitor overall GPU usage with 1-second update interval: diff --git a/pages/common/nxc.md b/pages/common/nxc.md index 30bf938f58..ff25eb0400 100644 --- a/pages/common/nxc.md +++ b/pages/common/nxc.md @@ -2,7 +2,7 @@ > Network service enumeration and exploitation tool. > Some subcommands such as `smb` have their own usage documentation. -> More information: . +> More information: . - [L]ist available modules for the specified protocol: diff --git a/pages/common/objdump.md b/pages/common/objdump.md index f71d6d6ee9..749a4acbb7 100644 --- a/pages/common/objdump.md +++ b/pages/common/objdump.md @@ -5,20 +5,20 @@ - Display the file header information: -`objdump -f {{path/to/binary}}` +`objdump {{[-f|--file-headers]}} {{path/to/binary}}` - Display all header information: -`objdump -x {{path/to/binary}}` +`objdump {{[-x|--all-headers]}} {{path/to/binary}}` - Display the disassembled output of executable sections: -`objdump -d {{path/to/binary}}` +`objdump {{[-d|--disassemble]}} {{path/to/binary}}` - Display the disassembled executable sections in Intel syntax: -`objdump -M intel -d {{path/to/binary}}` +`objdump {{[-M|--disassembler-options]}} intel {{[-d|--disassemble]}} {{path/to/binary}}` - Display a complete binary hex dump of all sections: -`objdump -s {{path/to/binary}}` +`objdump {{[-s|--full-contents]}} {{path/to/binary}}` diff --git a/pages/common/oc.md b/pages/common/oc.md index c3350b3b96..44a4a145e2 100644 --- a/pages/common/oc.md +++ b/pages/common/oc.md @@ -2,7 +2,7 @@ > The OpenShift Container Platform CLI. > Allows for application and container management. -> More information: . +> More information: . - Log in to the OpenShift Container Platform server: diff --git a/pages/common/ocaml.md b/pages/common/ocaml.md index 871b7cfc71..ed7940cd61 100644 --- a/pages/common/ocaml.md +++ b/pages/common/ocaml.md @@ -2,7 +2,7 @@ > The OCaml repl (read-evaluate-print-loop). > Interprets Ocaml commands. -> More information: . +> More information: . - Read OCaml commands from the user and execute them: diff --git a/pages/common/ocamlc.md b/pages/common/ocamlc.md index 295fb488c7..892013c317 100644 --- a/pages/common/ocamlc.md +++ b/pages/common/ocamlc.md @@ -2,7 +2,7 @@ > The OCaml bytecode compiler. > Produces executables runnable by the OCaml interpreter. -> More information: . +> More information: . - Create a binary from a source file: diff --git a/pages/common/ocamlfind.md b/pages/common/ocamlfind.md index cfad68ac0e..1c4619e0f8 100644 --- a/pages/common/ocamlfind.md +++ b/pages/common/ocamlfind.md @@ -2,7 +2,7 @@ > The findlib package manager for OCaml. > Simplifies linking executables with external libraries. -> More information: . +> More information: . - Compile a source file to a native binary and link with packages: diff --git a/pages/common/ocamlopt.md b/pages/common/ocamlopt.md index 138bb74782..c99575a653 100644 --- a/pages/common/ocamlopt.md +++ b/pages/common/ocamlopt.md @@ -2,7 +2,7 @@ > The OCaml native code compiler. > Produces native executables, e.g. ELF on Linux. -> More information: . +> More information: . - Compile a source file: diff --git a/pages/common/olevba.md b/pages/common/olevba.md index 69bd11fd01..50498557e2 100644 --- a/pages/common/olevba.md +++ b/pages/common/olevba.md @@ -14,15 +14,15 @@ - Provide a password for encrypted Microsoft Office files (may be repeated): -`olevba --password {{password}} {{path/to/encrypted_file}}` +`olevba {{[-p|--password]}} {{password}} {{path/to/encrypted_file}}` - Display only analysis results, without showing macro source code: -`olevba -a {{path/to/file}}` +`olevba {{[-a|--analysis]}} {{path/to/file}}` - Display only macro source code: -`olevba -c {{path/to/file}}` +`olevba {{[-c|--code]}} {{path/to/file}}` - Show obfuscated strings and their decoded content: diff --git a/pages/common/onionsearch.md b/pages/common/onionsearch.md index 2bfe1caa0f..b5f644c0c0 100644 --- a/pages/common/onionsearch.md +++ b/pages/common/onionsearch.md @@ -22,4 +22,4 @@ - List all supported search engines: -`onionsearch --help | grep -A1 -i "supported engines"` +`onionsearch --help | grep {{[-A|--after-context]}} 1 {{[-i|--ignore-case]}} "supported engines"` diff --git a/pages/common/open.md b/pages/common/open.md index 75d9eb9ee8..1679062d87 100644 --- a/pages/common/open.md +++ b/pages/common/open.md @@ -4,7 +4,7 @@ - View documentation for the command available in macOS: -`tldr open -p osx` +`tldr open {{[-p|--platform]}} osx` - View documentation for the command available through fish: diff --git a/pages/common/openscad.md b/pages/common/openscad.md index 04389e12a0..b5e5eefc8d 100644 --- a/pages/common/openscad.md +++ b/pages/common/openscad.md @@ -1,7 +1,7 @@ # openscad > Software for creating solid 3D CAD objects. -> More information: . +> More information: . - Open a file: diff --git a/pages/common/openttd.md b/pages/common/openttd.md index 56fd5cc446..73cb1d957f 100644 --- a/pages/common/openttd.md +++ b/pages/common/openttd.md @@ -1,7 +1,7 @@ # openttd > Open source clone of the Microprose game "Transport Tycoon Deluxe". -> More information: . +> More information: . - Start a new game: diff --git a/pages/common/optipng.md b/pages/common/optipng.md index de0878bc90..57b2abd9a0 100644 --- a/pages/common/optipng.md +++ b/pages/common/optipng.md @@ -9,11 +9,11 @@ - Compress a PNG with the best compression: -`optipng -o{{7}} {{path/to/file.png}}` +`optipng -o {{7}} {{path/to/file.png}}` - Compress a PNG with the fastest compression: -`optipng -o{{0}} {{path/to/file.png}}` +`optipng -o {{0}} {{path/to/file.png}}` - Compress a PNG and add interlacing: diff --git a/pages/common/p7zip.md b/pages/common/p7zip.md index b53b1e7cc2..471cdb5c9a 100644 --- a/pages/common/p7zip.md +++ b/pages/common/p7zip.md @@ -10,16 +10,16 @@ - Archive a file keeping the input file: -`p7zip -k {{path/to/file}}` +`p7zip {{[-k|--heep]}} {{path/to/file}}` - Decompress a file, replacing it with the original uncompressed version: -`p7zip -d {{compressed.ext}}.7z` +`p7zip {{[-d|--decompress]}} {{compressed.ext}}.7z` - Decompress a file keeping the input file: -`p7zip -d -k {{compressed.ext}}.7z` +`p7zip {{[-d|--decompress]}} {{[-k|--heep]}} {{compressed.ext}}.7z` - Skip some checks and force compression or decompression: -`p7zip -f {{path/to/file}}` +`p7zip {{[-f|--force]}} {{path/to/file}}` diff --git a/pages/common/pageres.md b/pages/common/pageres.md index 5cc803fef6..11466c309e 100644 --- a/pages/common/pageres.md +++ b/pages/common/pageres.md @@ -9,7 +9,7 @@ - Provide specific options for a URL, overriding global options: -`pageres [{{https://example.com/}} {{1366x768}} --no-crop] [{{https://example2.com/}} {{1024x768}}] --crop` +`pageres [{{https://example.com/}} {{1366x768}} --no-crop] [{{https://example2.com/}} {{1024x768}}] {{[-c|--crop]}}` - Provide a custom filename template: diff --git a/pages/common/pamixer.md b/pages/common/pamixer.md index 56149ab1d9..564ccc28bf 100644 --- a/pages/common/pamixer.md +++ b/pages/common/pamixer.md @@ -1,7 +1,7 @@ # pamixer > A simple command-line mixer for PulseAudio. -> More information: . +> More information: . - List all sinks and sources with their corresponding IDs: @@ -17,11 +17,11 @@ - Increase the volume on default sink by 5%: -`pamixer --increase {{5}}` +`pamixer {{[-i|--increase]}} {{5}}` - Decrease the volume on a source by 5%: -`pamixer --decrease {{5}} --source {{ID}}` +`pamixer {{[-d|--decrease]}} {{5}} --source {{ID}}` - Use the allow boost option to increase, decrease, or set the volume above 100%: @@ -29,4 +29,4 @@ - Mute the default sink (use `--unmute` instead to unmute): -`pamixer --mute` +`pamixer {{[-m|--mute]}}` diff --git a/pages/common/pants.md b/pages/common/pants.md index e1d140af20..866714ebca 100644 --- a/pages/common/pants.md +++ b/pages/common/pants.md @@ -1,7 +1,7 @@ # pants > Fast, scalable, user-friendly, open-source build and developer workflow tool. -> More information: . +> More information: . - List all targets: diff --git a/pages/common/parallel.md b/pages/common/parallel.md index 2d9b2e6642..c22941d3d6 100644 --- a/pages/common/parallel.md +++ b/pages/common/parallel.md @@ -9,7 +9,7 @@ - Read arguments from `stdin`, run 4 jobs at once: -`ls *.txt | parallel -j4 gzip` +`ls *.txt | parallel {{[-j|--jobs]}} 4 gzip` - Convert JPEG images to PNG using replacement strings: @@ -25,11 +25,11 @@ - Run on multiple machines via SSH: -`parallel -S {{machine1}},{{machine2}} {{command}} ::: {{arg1}} {{arg2}}` +`parallel {{[-S|--sshlogin]}} {{machine1}},{{machine2}} {{command}} ::: {{arg1}} {{arg2}}` - Download 4 files simultaneously from a text file containing links showing progress: -`parallel -j4 --bar --eta wget {{[-q|--quote]}} {} :::: {{path/to/links.txt}}` +`parallel {{[-j|--jobs]}} 4 --bar --eta wget {{[-q|--quote]}} {} :::: {{path/to/links.txt}}` - Print the jobs which `parallel` is running in `stderr`: diff --git a/pages/common/pass-otp.md b/pages/common/pass-otp.md index 4baf4bd08d..f86bb50212 100644 --- a/pages/common/pass-otp.md +++ b/pages/common/pass-otp.md @@ -1,7 +1,7 @@ # pass otp > A pass extension for managing one-time-password (OTP) tokens. -> More information: . +> More information: . - Prompt for an otpauth URI token and create a new pass file: @@ -17,12 +17,12 @@ - Copy and don't print a 2FA code using the OTP token in a pass file: -`pass otp --clip {{path/to/pass}}` +`pass otp {{[-c|--clip]}} {{path/to/pass}}` - Display a QR code using the OTP token stored in a pass file: -`pass otp uri --qrcode {{path/to/pass}}` +`pass otp uri {{[-q|--qrcode]}} {{path/to/pass}}` - Prompt for an OTP secret value specifying issuer and account (at least one must be specified) and append to existing pass file: -`pass otp append --secret --issuer {{issuer_name}} --account {{account_name}} {{path/to/pass}}` +`pass otp append {{[-s|--secret]}} {{[-i|--issuer]}} {{issuer_name}} {{[-a|--account]}} {{account_name}} {{path/to/pass}}` diff --git a/pages/common/pass.md b/pages/common/pass.md index 64a6eb8ef6..8f921fd860 100644 --- a/pages/common/pass.md +++ b/pages/common/pass.md @@ -10,7 +10,7 @@ - Save a new password and additional information (press `` on a new line to complete): -`pass insert --multiline {{path/to/data}}` +`pass insert {{[-m|--multiline]}} {{path/to/data}}` - Edit an entry: @@ -18,7 +18,7 @@ - Copy a password (first line of the data file) to the clipboard: -`pass -c {{path/to/data}}` +`pass {{[-c|--clip]}} {{path/to/data}}` - List the whole store tree: @@ -26,7 +26,7 @@ - Generate a new random password with a given length, and copy it to the clipboard: -`pass generate -c {{path/to/data}} {{num}}` +`pass generate {{[-c|--clip]}} {{path/to/data}} {{num}}` - Initialize a new Git repository (any changes done by pass will be committed automatically): diff --git a/pages/common/patch.md b/pages/common/patch.md index 06bb86a1e2..67f98f036e 100644 --- a/pages/common/patch.md +++ b/pages/common/patch.md @@ -14,12 +14,12 @@ - Patch a file writing the result to a different file: -`patch {{path/to/input_file}} -o {{path/to/output_file}} < {{patch.diff}}` +`patch {{path/to/input_file}} {{[-o|--output]}} {{path/to/output_file}} < {{patch.diff}}` - Apply a patch to the current directory: -`patch -p1 < {{patch.diff}}` +`patch {{[-p|--strip]}} 1 < {{patch.diff}}` - Apply the reverse of a patch: -`patch -R < {{patch.diff}}` +`patch {{[-R|--reverse]}} < {{patch.diff}}` diff --git a/pages/common/pathchk.md b/pages/common/pathchk.md index 58fb6a53b2..337364408b 100644 --- a/pages/common/pathchk.md +++ b/pages/common/pathchk.md @@ -13,7 +13,7 @@ - Check pathnames for validity on all POSIX compliant systems: -`pathchk --portability {{path1 path2 …}}` +`pathchk {{[-p -P|--portability]}} {{path1 path2 …}}` - Only check for empty pathnames or leading dashes (-): diff --git a/pages/common/pdftk.md b/pages/common/pdftk.md index c5b6ee3bd6..0fa0bd1937 100644 --- a/pages/common/pdftk.md +++ b/pages/common/pdftk.md @@ -1,7 +1,7 @@ # pdftk > PDF toolkit. -> More information: . +> More information: . - Extract pages 1-3, 5 and 6-10 from a PDF file and save them as another one: diff --git a/pages/common/peerflix.md b/pages/common/peerflix.md index a3732c0945..0ed13baba0 100644 --- a/pages/common/peerflix.md +++ b/pages/common/peerflix.md @@ -9,16 +9,16 @@ - List all streamable files contained in a torrent (given as a magnet link): -`peerflix "{{magnet:?xt=urn:btih:0123456789abcdef0123456789abcdef01234567}}" --list` +`peerflix "{{magnet:?xt=urn:btih:0123456789abcdef0123456789abcdef01234567}}" {{[-l|--list]}}` - Stream the largest file in a torrent, given as a torrent URL, to VLC: -`peerflix "{{http://example.net/music.torrent}}" --vlc` +`peerflix "{{http://example.net/music.torrent}}" {{[-v|--vlc]}}` - Stream the largest file in a torrent to MPlayer, with subtitles: -`peerflix "{{torrent_url|magnet_link}}" --mplayer --subtitles {{subtitle-file.srt}}` +`peerflix "{{torrent_url|magnet_link}}" {{[-m|--mplayer]}} {{[-t|--subtitles]}} {{subtitle-file.srt}}` - Stream all files from a torrent to Airplay: -`peerflix "{{torrent_url|magnet_link}}" --all --airplay` +`peerflix "{{torrent_url|magnet_link}}" {{[-a|--all]}} {{[-s|--airplay]}}` diff --git a/pages/common/peerindex.md b/pages/common/peerindex.md index 5c425f73f5..1f642cb41a 100644 --- a/pages/common/peerindex.md +++ b/pages/common/peerindex.md @@ -10,4 +10,4 @@ - Display all peers that have provided routing information: -`peerindex -r {{master6.mrt}}` +`peerindex {{[-r|--only-refs]}} {{master6.mrt}}` diff --git a/pages/common/pg_ctl.md b/pages/common/pg_ctl.md index b8141c0b59..d3d68f02d2 100644 --- a/pages/common/pg_ctl.md +++ b/pages/common/pg_ctl.md @@ -5,20 +5,20 @@ - Initialize a new PostgreSQL database cluster: -`pg_ctl -D {{data_directory}} init` +`pg_ctl {{[-D|--pgdata]}} {{data_directory}} init` - Start a PostgreSQL server: -`pg_ctl -D {{data_directory}} start` +`pg_ctl {{[-D|--pgdata]}} {{data_directory}} start` - Stop a PostgreSQL server: -`pg_ctl -D {{data_directory}} stop` +`pg_ctl {{[-D|--pgdata]}} {{data_directory}} stop` - Restart a PostgreSQL server: -`pg_ctl -D {{data_directory}} restart` +`pg_ctl {{[-D|--pgdata]}} {{data_directory}} restart` - Reload the PostgreSQL server configuration: -`pg_ctl -D {{data_directory}} reload` +`pg_ctl {{[-D|--pgdata]}} {{data_directory}} reload` diff --git a/pages/common/pg_dump.md b/pages/common/pg_dump.md index b394e3642e..bb9af7350b 100644 --- a/pages/common/pg_dump.md +++ b/pages/common/pg_dump.md @@ -9,20 +9,20 @@ - Same as above, customize username: -`pg_dump -U {{username}} {{db_name}} > {{output_file.sql}}` +`pg_dump {{[-U|--username]}} {{username}} {{db_name}} > {{output_file.sql}}` - Same as above, customize host and port: -`pg_dump -h {{host}} -p {{port}} {{db_name}} > {{output_file.sql}}` +`pg_dump {{[-h|--host]}} {{host}} {{[-p|--port]}} {{port}} {{db_name}} > {{output_file.sql}}` - Dump a database into a custom-format archive file: -`pg_dump -Fc {{db_name}} > {{output_file.dump}}` +`pg_dump {{[-F|--format]}} {{[c|custom]}} {{db_name}} > {{output_file.dump}}` - Dump only database data into an SQL-script file: -`pg_dump -a {{db_name}} > {{path/to/output_file.sql}}` +`pg_dump {{[-a|--data-only]}} {{db_name}} > {{path/to/output_file.sql}}` - Dump only schema (data definitions) into an SQL-script file: -`pg_dump -s {{db_name}} > {{path/to/output_file.sql}}` +`pg_dump {{[-s|--schema-only]}} {{db_name}} > {{path/to/output_file.sql}}` diff --git a/pages/common/pg_isready.md b/pages/common/pg_isready.md index c757f31e85..4c01918406 100644 --- a/pages/common/pg_isready.md +++ b/pages/common/pg_isready.md @@ -9,8 +9,8 @@ - Check connection with a specific hostname and port: -`pg_isready --host={{hostname}} --port={{port}}` +`pg_isready {{[-h|--host]}} {{hostname}} {{[-p|--port]}} {{port}}` - Check connection displaying a message only when the connection fails: -`pg_isready --quiet` +`pg_isready {{[-q|--quiet]}}` diff --git a/pages/common/pg_restore.md b/pages/common/pg_restore.md index 901913d2a8..c44a6bc37c 100644 --- a/pages/common/pg_restore.md +++ b/pages/common/pg_restore.md @@ -5,24 +5,24 @@ - Restore an archive into an existing database: -`pg_restore -d {{db_name}} {{archive_file.dump}}` +`pg_restore {{[-d|--dbname]}} {{db_name}} {{archive_file.dump}}` - Same as above, customize username: -`pg_restore -U {{username}} -d {{db_name}} {{archive_file.dump}}` +`pg_restore {{[-U|--username]}} {{username}} {{[-d|--dbname]}} {{db_name}} {{archive_file.dump}}` - Same as above, customize host and port: -`pg_restore -h {{host}} -p {{port}} -d {{db_name}} {{archive_file.dump}}` +`pg_restore {{[-h|--host]}} {{host}} {{[-p|--port]}} {{port}} {{[-d|--dbname]}} {{db_name}} {{archive_file.dump}}` - List database objects included in the archive: -`pg_restore --list {{archive_file.dump}}` +`pg_restore {{[-l|--list]}} {{archive_file.dump}}` - Clean database objects before creating them: -`pg_restore --clean -d {{db_name}} {{archive_file.dump}}` +`pg_restore {{[-c|--clean]}} {{[-d|--dbname]}} {{db_name}} {{archive_file.dump}}` - Use multiple jobs to do the restoring: -`pg_restore -j {{2}} -d {{db_name}} {{archive_file.dump}}` +`pg_restore {{[-j|--jobs]}} {{2}} {{[-d|--dbname]}} {{db_name}} {{archive_file.dump}}` diff --git a/pages/common/pgbench.md b/pages/common/pgbench.md index dac17765d5..c403e562c0 100644 --- a/pages/common/pgbench.md +++ b/pages/common/pgbench.md @@ -1,7 +1,7 @@ # pgbench > Run a benchmark test on PostgreSQL. -> More information: . +> More information: . - Initialize a database with a scale factor of 50 times the default size: diff --git a/pages/common/phing.md b/pages/common/phing.md index dc7ccc8f42..a366f4a8f6 100644 --- a/pages/common/phing.md +++ b/pages/common/phing.md @@ -1,7 +1,7 @@ # phing > A PHP build tool based on Apache Ant. -> More information: . +> More information: . - Perform the default task in the `build.xml` file: @@ -9,7 +9,7 @@ - Initialize a new build file: -`phing -i {{path/to/build.xml}}` +`phing {{[-i|--init]}} {{path/to/build.xml}}` - Perform a specific task: @@ -17,7 +17,7 @@ - Use the given build file path: -`phing -f {{path/to/build.xml}} {{task_name}}` +`phing {{[-f|-buildfile]}} {{path/to/build.xml}} {{task_name}}` - Log to the given file: diff --git a/pages/common/phive.md b/pages/common/phive.md index d7b06bc36c..3e5cb9dd41 100644 --- a/pages/common/phive.md +++ b/pages/common/phive.md @@ -1,7 +1,7 @@ # phive > The Phar Installation and Verification Environment for secure PHP application deployment. -> More information: . +> More information: . - Display a list of available aliased Phars: @@ -13,11 +13,11 @@ - Install a specified Phar globally: -`phive install {{alias|url}} --global` +`phive install {{alias|url}} {{[-g|--global]}}` - Install a specified Phar to a target directory: -`phive install {{alias|url}} --target {{path/to/directory}}` +`phive install {{alias|url}} {{[-t|--target]}} {{path/to/directory}}` - Update all Phar files to the latest version: diff --git a/pages/common/phpspec.md b/pages/common/phpspec.md index 957aacc2b4..5f07603031 100644 --- a/pages/common/phpspec.md +++ b/pages/common/phpspec.md @@ -17,11 +17,11 @@ - Run specifications using a specific configuration file: -`phpspec run -c {{path/to/configuration_file}}` +`phpspec run {{[-c|--config]}} {{path/to/configuration_file}}` - Run specifications using a specific bootstrap file: -`phpspec run -b {{path/to/bootstrap_file}}` +`phpspec run {{[-b|--bootstrap]}} {{path/to/bootstrap_file}}` - Disable code generation prompts: diff --git a/pages/common/phpstorm.md b/pages/common/phpstorm.md index fb5967ce55..c63afffeef 100644 --- a/pages/common/phpstorm.md +++ b/pages/common/phpstorm.md @@ -1,7 +1,7 @@ # phpstorm > A cross-platform IDE for PHP based on the JetBrains IntelliJ platform. -> More information: . +> More information: . - Open a specific directory: diff --git a/pages/common/picard.md b/pages/common/picard.md index fa310221da..da46202240 100644 --- a/pages/common/picard.md +++ b/pages/common/picard.md @@ -1,7 +1,7 @@ # picard > Next generation MusicBrainz tagging application. -> More information: . +> More information: . - Start Picard: @@ -13,4 +13,4 @@ - Display the version of Picard installed: -`picard --long-version` +`picard {{[-V|--long-version]}}` diff --git a/pages/common/pickle.md b/pages/common/pickle.md index 5785a6abe0..f25658507c 100644 --- a/pages/common/pickle.md +++ b/pages/common/pickle.md @@ -1,7 +1,7 @@ # pickle > A PHP extension installer based on Composer. -> More information: . +> More information: . - Install a specific PHP extension: diff --git a/pages/common/pigz.md b/pages/common/pigz.md index b7a20a6cc4..c55da1bb2a 100644 --- a/pages/common/pigz.md +++ b/pages/common/pigz.md @@ -9,11 +9,11 @@ - Compress a file using the best compression method: -`pigz -9 {{path/to/file}}` +`pigz {{[-9|--best]}} {{path/to/file}}` - Compress a file using no compression and 4 processors: -`pigz -0 -p{{4}} {{path/to/file}}` +`pigz -0 {{[-p|--processes]}} {{4}} {{path/to/file}}` - Compress a directory using tar: @@ -21,8 +21,8 @@ - Decompress a file: -`pigz -d {{archive.gz}}` +`pigz {{[-d|--decompress]}} {{archive.gz}}` - List the contents of an archive: -`pigz -l {{archive.tar.gz}}` +`pigz {{[-l|--list]}} {{archive.tar.gz}}` diff --git a/pages/common/ping.py.md b/pages/common/ping.py.md new file mode 100644 index 0000000000..7ca0ace8f4 --- /dev/null +++ b/pages/common/ping.py.md @@ -0,0 +1,13 @@ +# ping.py + +> Simple ICMP ping using Impacket to check if an IPv4 host is reachable. +> Sends ICMP echo requests and listens for echo replies. Requires root privileges for raw socket access (e.g., run with `sudo`). +> More information: . + +- Ping a host from a specified source IPv4 address: + +`ping.py {{source_ipv4}} {{destination_ipv4}}` + +- Ping 192.168.1.100 from 192.168.1.10: + +`ping.py 192.168.1.10 192.168.1.100` diff --git a/pages/common/ping6.py.md b/pages/common/ping6.py.md new file mode 100644 index 0000000000..623f22c251 --- /dev/null +++ b/pages/common/ping6.py.md @@ -0,0 +1,13 @@ +# ping6.py + +> Simple ICMPv6 ping using Impacket to check if an IPv6 host is reachable. +> Sends ICMPv6 echo requests and listens for echo replies. Requires root privileges for raw socket access (e.g., run with `sudo`). +> More information: . + +- Ping an IPv6 host from a specified source IPv6 address: + +`ping6.py {{source_ipv6}} {{destination_ipv6}}` + +- Ping 2001:db8::2 from 2001:db8::1: + +`ping6.py 2001:db8::1 2001:db8::2` diff --git a/pages/common/pip-freeze.md b/pages/common/pip-freeze.md index 273ccb90b8..fc0f2d9796 100644 --- a/pages/common/pip-freeze.md +++ b/pages/common/pip-freeze.md @@ -13,7 +13,7 @@ - List installed packages in a virtual environment, excluding globally installed packages: -`pip freeze --local > requirements.txt` +`pip freeze {{[-l|--local]}} > requirements.txt` - List installed packages in the user-site: diff --git a/pages/common/pip-install.md b/pages/common/pip-install.md index 0889ccff8d..c02b6a5855 100644 --- a/pages/common/pip-install.md +++ b/pages/common/pip-install.md @@ -13,12 +13,12 @@ - Install packages listed in a file: -`pip install -r {{path/to/requirements.txt}}` +`pip install {{[-r|--requirement]}} {{path/to/requirements.txt}}` - Install packages from an URL or local file archive (.tar.gz | .whl): -`pip install --find-links {{url|path/to/file}}` +`pip install {{[-f|--find-links]}} {{url|path/to/file}}` - Install the local package in the current directory in develop (editable) mode: -`pip install --editable {{.}}` +`pip install {{[-e|--editable]}} {{.}}` diff --git a/pages/common/pip-uninstall.md b/pages/common/pip-uninstall.md index 51be163f84..510b145ade 100644 --- a/pages/common/pip-uninstall.md +++ b/pages/common/pip-uninstall.md @@ -9,8 +9,8 @@ - Uninstall packages listed in a specific file: -`pip uninstall --requirement {{path/to/requirements.txt}}` +`pip uninstall {{[-r|--requirement]}} {{path/to/requirements.txt}}` - Uninstall package without asking for confirmation: -`pip uninstall --yes {{package}}` +`pip uninstall {{[-y|--yes]}} {{package}}` diff --git a/pages/common/pip.md b/pages/common/pip.md index 9756647a0a..814b532879 100644 --- a/pages/common/pip.md +++ b/pages/common/pip.md @@ -14,7 +14,7 @@ - Upgrade a package: -`pip install --upgrade {{package}}` +`pip install {{[-U|--upgrade]}} {{package}}` - Uninstall a package: @@ -30,4 +30,4 @@ - Install packages from a file: -`pip install --requirement {{requirements.txt}}` +`pip install {{[-r|--requirement]}} {{requirements.txt}}` diff --git a/pages/common/pip3.md b/pages/common/pip3.md index 2437bf8f1d..913a330787 100644 --- a/pages/common/pip3.md +++ b/pages/common/pip3.md @@ -13,7 +13,7 @@ - Upgrade a package: -`pip3 install --upgrade {{package}}` +`pip3 install {{[-U|--upgrade]}} {{package}}` - Uninstall a package: @@ -25,7 +25,7 @@ - Install packages from a file: -`pip3 install --requirement {{requirements.txt}}` +`pip3 install {{[-r|--requirement]}} {{requirements.txt}}` - Show installed package info: diff --git a/pages/common/pnmtofiasco.md b/pages/common/pnmtofiasco.md index 6a5c72e4ee..d9582407f6 100644 --- a/pages/common/pnmtofiasco.md +++ b/pages/common/pnmtofiasco.md @@ -13,7 +13,7 @@ - Specify the compression quality: -`pnmtofiasco {{[-qua|--quality]}} {{quality_level}} {{path/to/file.pnm}} > {{path/to/file.fiasco}}` +`pnmtofiasco {{[-q|--quality]}} {{quality_level}} {{path/to/file.pnm}} > {{path/to/file.fiasco}}` - Load the options to be used from the specified configuration file: diff --git a/pages/common/podman-compose.md b/pages/common/podman-compose.md index e6e4052516..1bdc92d29d 100644 --- a/pages/common/podman-compose.md +++ b/pages/common/podman-compose.md @@ -9,7 +9,7 @@ - Create and start all containers in the background using a local `docker-compose.yml`: -`podman-compose up -d` +`podman-compose up {{[-d|--detach]}}` - Start all containers, building if needed: @@ -25,11 +25,11 @@ - Remove all containers, networks, and volumes: -`podman-compose down --volumes` +`podman-compose down {{[-v|--volumes]}}` - Follow logs for a container (omit all container names): -`podman-compose logs --follow {{container_name}}` +`podman-compose logs {{[-f|--follow]}} {{container_name}}` - Run a one-time command in a service with no ports mapped: diff --git a/pages/common/poetry.md b/pages/common/poetry.md index e6e7b35e7a..349900639e 100644 --- a/pages/common/poetry.md +++ b/pages/common/poetry.md @@ -16,7 +16,7 @@ `poetry install` -- Interactively initialize the current directory as a new Poetry project: +- Interactively (append `-n` for non-interactively) initialize the current directory as a new Poetry project: `poetry init` diff --git a/pages/common/popeye.md b/pages/common/popeye.md index a5854c8a1a..89cf152a80 100644 --- a/pages/common/popeye.md +++ b/pages/common/popeye.md @@ -9,12 +9,12 @@ - Scan a specific namespace: -`popeye -n {{namespace}}` +`popeye {{[-n|--namespace]}} {{namespace}}` - Scan specific Kubernetes context: -`popeye --context={{context}}` +`popeye --context {{context}}` - Use a spinach configuration file for scanning: -`popeye -f {{spinach.yaml}}` +`popeye {{[-f|--file]}} {{spinach.yaml}}` diff --git a/pages/common/powershell.md b/pages/common/powershell.md index 3823802ba7..3b2564373a 100644 --- a/pages/common/powershell.md +++ b/pages/common/powershell.md @@ -10,4 +10,4 @@ - View the documentation for the command referring to the legacy Windows PowerShell (version 5.1 and below): -`tldr powershell -p windows` +`tldr powershell {{[-p|--platform]}} windows` diff --git a/pages/common/print.md b/pages/common/print.md index 7547a095de..44abc7e2cf 100644 --- a/pages/common/print.md +++ b/pages/common/print.md @@ -8,8 +8,8 @@ - View documentation for the `print` alias of `run-mailcap`: -`tldr --platform linux print.runmailcap` +`tldr {{[-p|--platform]}} linux print.runmailcap` - View documentation for printing text files on Windows: -`tldr --platform windows print.win` +`tldr {{[-p|--platform]}} windows print.win` diff --git a/pages/common/progress.md b/pages/common/progress.md index 2026616350..4d690bf4e1 100644 --- a/pages/common/progress.md +++ b/pages/common/progress.md @@ -9,12 +9,12 @@ - Show the progress of running coreutils in quiet mode: -`progress -q` +`progress {{[-q|--quiet]}}` - Launch and monitor a single long-running command: -`{{command}} & progress --monitor --pid $!` +`{{command}} & progress {{[-m|--monitor]}} {{[-p|--pid]}} $!` - Include an estimate of time remaining for completion: -`progress --wait --command {{firefox}}` +`progress {{[-w|--wait]}} {{[-c|--command]}} {{firefox}}` diff --git a/pages/common/projucer.md b/pages/common/projucer.md index a5bd184835..fadbd01b3b 100644 --- a/pages/common/projucer.md +++ b/pages/common/projucer.md @@ -1,7 +1,7 @@ # Projucer > A project manager for JUCE framework applications. -> More information: . +> More information: . - Display information about a project: diff --git a/pages/common/proxify.md b/pages/common/proxify.md index 3598cecec0..e019cebb76 100644 --- a/pages/common/proxify.md +++ b/pages/common/proxify.md @@ -10,11 +10,11 @@ - Start a HTTP proxy on a custom network interface and port (may require `sudo` for a port number lower than `1024`): -`proxify -http-addr "{{ip_address}}:{{port_number}}"` +`proxify {{[-ha|-http-addr]}} "{{ip_address}}:{{port_number}}"` - Specify output format and output file: -`proxify -output-format {{jsonl|yaml}} -output {{path/to/file}}` +`proxify {{[-of|-output-format]}} {{jsonl|yaml}} {{[-o|-output]}} {{path/to/file}}` - Display help: diff --git a/pages/common/psql.md b/pages/common/psql.md index 2c83bdfeeb..77803cde63 100644 --- a/pages/common/psql.md +++ b/pages/common/psql.md @@ -9,16 +9,16 @@ - Connect to the database on given server host running on given port with given username, without a password prompt: -`psql -h {{host}} -p {{port}} -U {{username}} {{database}}` +`psql {{[-h|--host]}} {{host}} {{[-p|--port]}} {{port}} {{[-U|--username]}} {{username}} {{database}}` - Connect to the database; user will be prompted for password: -`psql -h {{host}} -p {{port}} -U {{username}} -W {{database}}` +`psql {{[-h|--host]}} {{host}} {{[-p|--port]}} {{port}} {{[-U|--username]}} {{username}} {{[-W|--password]}} {{database}}` - Execute a single SQL query or PostgreSQL command on the given database (useful in shell scripts): -`psql -c '{{query}}' {{database}}` +`psql {{[-c|--command]}} '{{query}}' {{database}}` - Execute commands from a file on the given database: -`psql {{database}} -f {{file.sql}}` +`psql {{database}} {{[-f|--file]}} {{file.sql}}` diff --git a/pages/common/pssh.md b/pages/common/pssh.md index 8f21aa6619..7cc4b0fbb8 100644 --- a/pages/common/pssh.md +++ b/pages/common/pssh.md @@ -5,24 +5,24 @@ - Run a command on two hosts, and print its output on each server inline: -`pssh -i -H "{{host1}} {{host2}}" {{hostname -i}}` +`pssh {{[-i|--inline]}} {{[-H|--host]}} "{{host1}} {{host2}}" {{hostname --ip-addresses}}` - Run a command and save the output to separate files: -`pssh -H {{host1}} -H {{host2}} -o {{path/to/output_dir}} {{hostname -i}}` +`pssh {{[-H|--host]}} {{host1}} {{[-H|--host]}} {{host2}} {{[-o|--outdir]}} {{path/to/output_dir}} {{hostname --ip-addresses}}` - Run a command on multiple hosts, specified in a new-line separated file: -`pssh -i -h {{path/to/hosts_file}} {{hostname -i}}` +`pssh {{[-i|--inline]}} {{[-h|--hosts]}} {{path/to/hosts_file}} {{hostname --ip-addresses}}` - Run a command as root (this asks for the root password): -`pssh -i -h {{path/to/hosts_file}} -A -l {{root_username}} {{hostname -i}}` +`pssh {{[-i|--inline]}} {{[-h|--hosts]}} {{path/to/hosts_file}} {{[-A|--askpass]}} {{[-l|--user]}} {{root_username}} {{hostname --ip-addresses}}` - Run a command with extra SSH arguments: -`pssh -i -h {{path/to/hosts_file}} -x "{{-O VisualHostKey=yes}}" {{hostname -i}}` +`pssh {{[-i|--inline]}} {{[-h|--hosts]}} {{path/to/hosts_file}} {{[-x|--extra-arg]}} "{{-O VisualHostKey=yes}}" {{hostname --ip-addresses}}` - Run a command limiting the number of parallel connections to 10: -`pssh -i -h {{path/to/hosts_file}} -p {{10}} '{{cd dir; ./script.sh; exit}}'` +`pssh {{[-i|--inline]}} {{[-h|--hosts]}} {{path/to/hosts_file}} {{[-p|-par]}} {{10}} '{{cd dir; ./script.sh; exit}}'` diff --git a/pages/common/pt.md b/pages/common/pt.md index 6c4fc4568e..c3b23958b3 100644 --- a/pages/common/pt.md +++ b/pages/common/pt.md @@ -10,15 +10,15 @@ - Find files containing "foo" and display count of matches in each file: -`pt -c {{foo}}` +`pt {{[-c|--count]}} {{foo}}` - Find files containing "foo" as a whole word and ignore its case: -`pt -wi {{foo}}` +`pt {{[-wi|--word-regexp --ignore-case]}} {{foo}}` - Find "foo" in files with a given extension using a regular expression: -`pt -G='{{\.bar$}}' {{foo}}` +`pt {{[-G|--file-search-regexp]}}='{{\.bar$}}' {{foo}}` - Find files whose contents match the regular expression, up to 2 directories deep: diff --git a/pages/common/ptpython.md b/pages/common/ptpython.md index 1985600157..03a300a362 100644 --- a/pages/common/ptpython.md +++ b/pages/common/ptpython.md @@ -13,7 +13,7 @@ - Execute a specific Python file and start a REPL: -`ptpython -i {{path/to/file.py}}` +`ptpython {{[-i|--interactive]}} {{path/to/file.py}}` - Open the menu: diff --git a/pages/common/pueue-add.md b/pages/common/pueue-add.md index ba2db585c4..31426d7cfb 100644 --- a/pages/common/pueue-add.md +++ b/pages/common/pueue-add.md @@ -13,16 +13,16 @@ - Add a command but do not start it if it's the first in a queue: -`pueue add --stashed -- {{rsync --archive --compress /local/directory /remote/directory}}` +`pueue add {{[-s|--stashed]}} -- {{rsync {{[-a|--archive]}} {{[-z|--compress]}} /local/directory /remote/directory}}` - Add a command to a group and start it immediately, see `pueue group` to manage groups: -`pueue add --immediate --group "{{CPU_intensive}}" -- {{ffmpeg -i input.mp4 frame_%d.png}}` +`pueue add {{[-i|--immediate]}} {{[-g|--group]}} "{{CPU_intensive}}" -- {{ffmpeg -i input.mp4 frame_%d.png}}` - Add a command and start it after commands 9 and 12 finish successfully: -`pueue add --after {{9}} {{12}} --group "{{torrents}}" -- {{transmission-cli torrent_file.torrent}}` +`pueue add {{[-a|--after]}} {{9}} {{12}} {{[-g|--group]}} "{{torrents}}" -- {{transmission-cli torrent_file.torrent}}` - Add a command with a label after some delay has passed, see `pueue enqueue` for valid datetime formats: -`pueue add --label "{{compressing large file}}" --delay "{{wednesday 10:30pm}}" -- "{{7z a compressed_file.7z large_file.xml}}"` +`pueue add {{[-l|--label]}} "{{compressing large file}}" {{[-d|--delay]}} "{{wednesday 10:30pm}}" -- "{{7z a compressed_file.7z large_file.xml}}"` diff --git a/pages/common/pueue-clean.md b/pages/common/pueue-clean.md index 2bfa9fc265..0eb851635e 100644 --- a/pages/common/pueue-clean.md +++ b/pages/common/pueue-clean.md @@ -9,4 +9,4 @@ - Only clean commands that finished successfully: -`pueue clean --successful-only` +`pueue clean {{[-s|--successful-only]}}` diff --git a/pages/common/pueue-enqueue.md b/pages/common/pueue-enqueue.md index f862ae83ce..bf85299a3e 100644 --- a/pages/common/pueue-enqueue.md +++ b/pages/common/pueue-enqueue.md @@ -10,20 +10,20 @@ - Enqueue a stashed task after 60 seconds: -`pueue enqueue --delay {{60}} {{task_id}}` +`pueue enqueue {{[-d|--delay]}} {{60}} {{task_id}}` - Enqueue a stashed task next Wednesday: -`pueue enqueue --delay {{wednesday}} {{task_id}}` +`pueue enqueue {{[-d|--delay]}} {{wednesday}} {{task_id}}` - Enqueue a stashed task after four months: -`pueue enqueue --delay "4 months" {{task_id}}` +`pueue enqueue {{[-d|--delay]}} "4 months" {{task_id}}` - Enqueue a stashed task on 2021-02-19: -`pueue enqueue --delay {{2021-02-19}} {{task_id}}` +`pueue enqueue {{[-d|--delay]}} {{2021-02-19}} {{task_id}}` - List all available date/time formats: -`pueue enqueue --help` +`pueue enqueue {{[-h|--help]}}` diff --git a/pages/common/pueue-group.md b/pages/common/pueue-group.md index 4242ccc390..f71934a02b 100644 --- a/pages/common/pueue-group.md +++ b/pages/common/pueue-group.md @@ -9,8 +9,8 @@ - Add a custom group: -`pueue group --add "{{group_name}}"` +`pueue group add "{{group_name}}"` - Remove a group and move its tasks to the default group: -`pueue group --remove "{{group_name}}"` +`pueue group remove "{{group_name}}"` diff --git a/pages/common/pueue-kill.md b/pages/common/pueue-kill.md index 4d09e96f6b..8eab23800e 100644 --- a/pages/common/pueue-kill.md +++ b/pages/common/pueue-kill.md @@ -17,8 +17,8 @@ - Kill all tasks in a group and pause the group: -`pueue kill --group {{group_name}}` +`pueue kill {{[-g|--group]}} {{group_name}}` - Kill all tasks across all groups and pause all groups: -`pueue kill --all` +`pueue kill {{[-a|--all]}}` diff --git a/pages/common/pueue-log.md b/pages/common/pueue-log.md index 934fe66d72..7bdc674351 100644 --- a/pages/common/pueue-log.md +++ b/pages/common/pueue-log.md @@ -18,4 +18,4 @@ - Print a specific number of lines from the tail of output: -`pueue log --lines {{number_of_lines}} {{task_id}}` +`pueue log {{[-l|--lines]}} {{number_of_lines}} {{task_id}}` diff --git a/pages/common/pueue-parallel.md b/pages/common/pueue-parallel.md index 6478cf2295..18d9d6e99c 100644 --- a/pages/common/pueue-parallel.md +++ b/pages/common/pueue-parallel.md @@ -9,4 +9,4 @@ - Set the maximum number of tasks allowed to run in parallel, in a specific group: -`pueue parallel --group {{group_name}} {{maximum_number_of_parallel_tasks}}` +`pueue parallel {{[-g|--group]}} {{group_name}} {{maximum_number_of_parallel_tasks}}` diff --git a/pages/common/pueue-pause.md b/pages/common/pueue-pause.md index 5ab1f50ed5..eae882bd84 100644 --- a/pages/common/pueue-pause.md +++ b/pages/common/pueue-pause.md @@ -18,8 +18,8 @@ - Pause all tasks in a group and prevent it from starting new tasks: -`pueue pause --group {{group_name}}` +`pueue pause {{[-g|--group]}} {{group_name}}` - Pause all tasks and prevent all groups from starting new tasks: -`pueue pause --all` +`pueue pause {{[-a|--all]}}` diff --git a/pages/common/pueue-reset.md b/pages/common/pueue-reset.md index 07b6ededfe..5c29f8f71b 100644 --- a/pages/common/pueue-reset.md +++ b/pages/common/pueue-reset.md @@ -13,4 +13,4 @@ - Reset without asking for confirmation: -`pueue reset --force` +`pueue reset {{[-f|--force]}}` diff --git a/pages/common/pueue-restart.md b/pages/common/pueue-restart.md index 01d36b06e3..1565696e3c 100644 --- a/pages/common/pueue-restart.md +++ b/pages/common/pueue-restart.md @@ -9,7 +9,7 @@ - Restart multiple tasks at once, and start them immediately (do not enqueue): -`pueue restart --start-immediately {{task_id}} {{task_id}}` +`pueue restart {{[-k|--immediately]}} {{task_id}} {{task_id}}` - Restart a specific task from a different path: @@ -17,12 +17,12 @@ - Edit a command before restarting: -`pueue restart --edit {{task_id}}` +`pueue restart {{[-e|--edit]}} {{task_id}}` - Restart a task in-place (without enqueuing as a separate task): -`pueue restart --in-place {{task_id}}` +`pueue restart {{[-i|--in-place]}} {{task_id}}` - Restart all failed tasks and stash them: -`pueue restart --all-failed --stashed` +`pueue restart {{[-a|--all-failed]}} --stashed` diff --git a/pages/common/pueue-start.md b/pages/common/pueue-start.md index 48fcba3bb2..f26e79770f 100644 --- a/pages/common/pueue-start.md +++ b/pages/common/pueue-start.md @@ -18,7 +18,7 @@ - Resume all tasks and start their children: -`pueue start --all --children` +`pueue start {{[-a|--all]}} --children` - Resume all tasks in a specific group: diff --git a/pages/common/pueue-status.md b/pages/common/pueue-status.md index e6e495adf2..5211a9489c 100644 --- a/pages/common/pueue-status.md +++ b/pages/common/pueue-status.md @@ -9,4 +9,4 @@ - Show the status of a specific group: -`pueue status --group {{group_name}}` +`pueue status {{[-g|--group]}} {{group_name}}` diff --git a/pages/common/pueue.md b/pages/common/pueue.md index 5bc8012243..138e5f5d44 100644 --- a/pages/common/pueue.md +++ b/pages/common/pueue.md @@ -6,7 +6,7 @@ - Show general help and available subcommands: -`pueue --help` +`pueue {{[-h|--help]}}` - Execute a pueue subcommand: @@ -14,4 +14,4 @@ - Check the version of pueue: -`pueue --version` +`pueue {{[-V|--version]}}` diff --git a/pages/common/puppet-agent.md b/pages/common/puppet-agent.md index 83cfa4a995..b72770f361 100644 --- a/pages/common/puppet-agent.md +++ b/pages/common/puppet-agent.md @@ -1,7 +1,7 @@ # puppet agent > Retrieves the client configuration from a Puppet server and applies it to the local host. -> More information: . +> More information: . - Register a node at a Puppet server and apply the received catalog: diff --git a/pages/common/puppet-apply.md b/pages/common/puppet-apply.md index 1b167f785d..6a6ac87911 100644 --- a/pages/common/puppet-apply.md +++ b/pages/common/puppet-apply.md @@ -1,7 +1,7 @@ # puppet apply > Apply Puppet manifests locally. -> More information: . +> More information: . - Apply a manifest: diff --git a/pages/common/puppet.md b/pages/common/puppet.md index 1413cc7ee4..c18056285c 100644 --- a/pages/common/puppet.md +++ b/pages/common/puppet.md @@ -2,7 +2,7 @@ > Help to manage and automate the configuration of servers. > Some subcommands such as `agent` have their own usage documentation. -> More information: . +> More information: . - Execute a Puppet subcommand: diff --git a/pages/common/pushd.md b/pages/common/pushd.md index 3d99b74f53..7a711da6b7 100644 --- a/pages/common/pushd.md +++ b/pages/common/pushd.md @@ -2,7 +2,7 @@ > Place a directory on a stack so it can be accessed later. > See also `popd` to switch back to original directory and `dirs` to display directory stack contents. -> More information: . +> More information: . - Switch to directory and push it on the stack: diff --git a/pages/common/pv.md b/pages/common/pv.md index e68155f2d3..cdf06049e3 100644 --- a/pages/common/pv.md +++ b/pages/common/pv.md @@ -9,20 +9,20 @@ - Measure the speed and amount of data flow between pipes (`--size` is optional): -`command1 | pv --size {{expected_amount_of_data_for_eta}} | command2` +`command1 | pv {{[-s|--size]}} {{expected_amount_of_data_for_eta}} | command2` - Filter a file, see both progress and amount of output data: -`pv -cN in {{big_text_file}} | grep {{pattern}} | pv -cN out > {{filtered_file}}` +`pv {{[-cN|--cursor --name]}} in {{big_text_file}} | grep {{pattern}} | pv {{[-cN|--cursor --name]}} out > {{filtered_file}}` - Attach to an already running process and see its file reading progress: -`pv -d {{PID}}` +`pv {{[-d|--watchfd]}} {{PID}}` - Read an erroneous file, skip errors as `dd conv=sync,noerror` would: -`pv -EE {{path/to/faulty_media}} > image.img` +`pv {{[-EE|--skip-errors --skip-errors]}} {{path/to/faulty_media}} > image.img` - Stop reading after reading specified amount of data, rate limit to 1K/s: -`pv -L 1K --stop-at --size {{maximum_file_size_to_be_read}}` +`pv {{[-L|--rate-limit]}} 1K {{[-S|--stop-at-size]}} {{maximum_file_size_to_be_read}}` diff --git a/pages/common/py-spy.md b/pages/common/py-spy.md index 5fead329e7..a1d6d2037f 100644 --- a/pages/common/py-spy.md +++ b/pages/common/py-spy.md @@ -5,7 +5,7 @@ - Show a live view of the functions that take the most execution time of a running process: -`py-spy top --pid {{pid}}` +`py-spy top {{[-p|--pid]}} {{pid}}` - Start a program and show a live view of the functions that take the most execution time: @@ -13,8 +13,8 @@ - Produce an SVG flame graph of the function call execution time: -`py-spy record -o {{path/to/profile.svg}} --pid {{pid}}` +`py-spy record {{[-o|--output]}} {{path/to/profile.svg}} {{[-p|--pid]}} {{pid}}` - Dump the call stack of a running process: -`py-spy dump --pid {{pid}}` +`py-spy dump {{[-p|--pid]}} {{pid}}` diff --git a/pages/common/pydoc.md b/pages/common/pydoc.md index 5173f2ad95..bb578705aa 100644 --- a/pages/common/pydoc.md +++ b/pages/common/pydoc.md @@ -1,7 +1,7 @@ # pydoc > Display offline Python documentation. -> More information: . +> More information: . - Print documentation on a subject (Python keyword, topic, function, module, package, etc.): diff --git a/pages/common/q.md b/pages/common/q.md index c14946494c..5390b04a3f 100644 --- a/pages/common/q.md +++ b/pages/common/q.md @@ -5,15 +5,15 @@ - Query a CSV file by specifying the delimiter as ',': -`q -d',' "SELECT * from {{path/to/file}}"` +`q {{[-d|--delimiter]}} ',' "SELECT * from {{path/to/file}}"` - Query a TSV file: -`q -t "SELECT * from {{path/to/file}}"` +`q {{[-t|--tab-delimited]}} "SELECT * from {{path/to/file}}"` - Query file with header row: -`q -d{{delimiter}} -H "SELECT * from {{path/to/file}}"` +`q {{[-d|--delimiter]}} {{delimiter}} {{[-H|--skip-header]}} "SELECT * from {{path/to/file}}"` - Read data from `stdin`; '-' in the query represents the data from `stdin`: @@ -25,4 +25,4 @@ - Format output using an output delimiter with an output header line (Note: command will output column names based on the input file header or the column aliases overridden in the query): -`q -D{{delimiter}} -O "SELECT {{column}} as {{alias}} from {{path/to/file}}"` +`q {{[-D|--output-delimiter]}} {{delimiter}} {{[-O|--output-header]}} "SELECT {{column}} as {{alias}} from {{path/to/file}}"` diff --git a/pages/common/qmv.md b/pages/common/qmv.md index 8d8e8faaf3..27795b09dc 100644 --- a/pages/common/qmv.md +++ b/pages/common/qmv.md @@ -13,7 +13,7 @@ - Move multiple directories: -`qmv {{[-d|--directory]}} {{path/to/directory1}} {{path/to/directory2}} {{path/to/directory3}}` +`qmv {{[-d|--directory]}} {{path/to/directory1 path/to/directory2 path/to/directory3 ...}}` - Move all files and directories inside a directory: diff --git a/pages/common/qr.md b/pages/common/qr.md index 0ebc9aaec3..804729702c 100644 --- a/pages/common/qr.md +++ b/pages/common/qr.md @@ -1,7 +1,7 @@ # qr > Generate QR codes in the terminal with ANSI VT-100 escape codes. -> More information: . +> More information: . - Generate a QR code: diff --git a/pages/common/qrencode.md b/pages/common/qrencode.md index e50439a7b4..c1c2aa4193 100644 --- a/pages/common/qrencode.md +++ b/pages/common/qrencode.md @@ -1,20 +1,20 @@ # qrencode > QR Code generator. Supports PNG and EPS. -> More information: . +> More information: . - Convert a string to a QR code and save to an output file: -`qrencode -o {{path/to/output_file.png}} {{string}}` +`qrencode {{[-o|--output]}} {{path/to/output_file.png}} {{string}}` - Convert an input file to a QR code and save to an output file: -`qrencode -o {{path/to/output_file.png}} -r {{path/to/input_file}}` +`qrencode {{[-o|--output]}} {{path/to/output_file.png}} {{[-r|--read-from]}} {{path/to/input_file}}` - Convert a string to a QR code and print it in terminal: -`qrencode -t ansiutf8 {{string}}` +`qrencode {{[-t|--type]}} ansiutf8 {{string}}` - Convert input from pipe to a QR code and print it in terminal: -`echo {{string}} | qrencode -t ansiutf8` +`echo {{string}} | qrencode {{[-t|--type]}} ansiutf8` diff --git a/pages/common/quilt.md b/pages/common/quilt.md index 63f32593e2..56b8031281 100644 --- a/pages/common/quilt.md +++ b/pages/common/quilt.md @@ -1,7 +1,7 @@ # quilt > Manage a series of patches. -> More information: . +> More information: . - Import an existing patch from a file: diff --git a/pages/common/quota.md b/pages/common/quota.md index 4f3531f2ca..dba699a2b3 100644 --- a/pages/common/quota.md +++ b/pages/common/quota.md @@ -5,20 +5,20 @@ - Show disk quotas in human-readable units for the current user: -`quota -s` +`quota {{[-s|--human-readable]}}` - Verbose output (also display quotas on filesystems where no storage is allocated): -`quota -v` +`quota {{[-v|--verbose]}}` - Quiet output (only display quotas on filesystems where usage is over quota): -`quota -q` +`quota {{[-q|--quiet]}}` - Print quotas for the groups of which the current user is a member: -`quota -g` +`quota {{[-g|--group]}}` - Show disk quotas for another user: -`sudo quota -u {{username}}` +`sudo quota {{[-u|--user]}} {{username}}` diff --git a/pages/common/r.md b/pages/common/r.md index 7a891b56fa..dd41ca2568 100644 --- a/pages/common/r.md +++ b/pages/common/r.md @@ -9,11 +9,11 @@ - Start R in vanilla mode (i.e. a blank session that doesn't save the workspace at the end): -`R --vanilla` +`R {{[-v|--vanilla]}}` - Execute a file: -`R -f {{path/to/file.R}}` +`R {{[-f|--file]}} {{path/to/file.R}}` - Execute an R expression and then exit: @@ -21,7 +21,7 @@ - Run R with a debugger: -`R -d {{debugger}}` +`R {{[-d|--debugger]}} {{debugger}}` - Check R packages from package sources: diff --git a/pages/common/r2e.md b/pages/common/r2e.md index 0400f18226..098e26e9e8 100644 --- a/pages/common/r2e.md +++ b/pages/common/r2e.md @@ -2,7 +2,7 @@ > Forwards RSS feeds to an email address. > Requires a configured `sendmail` or smtp setup. -> More information: . +> More information: . - Create a new feed database that sends email to an email address: diff --git a/pages/common/rails-console.md b/pages/common/rails-console.md index 8750a27e5e..255fb9a1a6 100644 --- a/pages/common/rails-console.md +++ b/pages/common/rails-console.md @@ -9,12 +9,12 @@ - Start the Rails console and roll back all data modifications on exit: -`rails console --sandbox` +`rails console {{[-s|--sandbox]}}` - Start the Rails console on a specified environment: -`rails console --environment {{dev|test|production|...}}` +`rails console {{[-e|--environment]}} {{dev|test|production|...}}` - Display help: -`rails console --help` +`rails console {{[-h|--help]}}` diff --git a/pages/common/rails-new.md b/pages/common/rails-new.md index c7190e0df8..e9692a4866 100644 --- a/pages/common/rails-new.md +++ b/pages/common/rails-new.md @@ -13,12 +13,12 @@ - Create a Rails app with `postgresql` as the database: -`rails new {{app_name}} --database postgresql` +`rails new {{app_name}} {{[-d|--database]}} postgresql` - Create a Rails app without generating JavaScript files: -`rails new {{app_name}} --skip-javascript` +`rails new {{app_name}} {{[-J|--skip-javascript]}}` - Display help: -`rails new --help` +`rails new {{[-h|--help]}}` diff --git a/pages/common/rails-routes.md b/pages/common/rails-routes.md index 8d6eae808d..a3d5d27337 100644 --- a/pages/common/rails-routes.md +++ b/pages/common/rails-routes.md @@ -13,8 +13,8 @@ - List routes partially matching URL helper method name, HTTP verb, or URL path: -`rails routes -g {{posts_path|GET|/posts}}` +`rails routes {{[-g|--grep]}} {{posts_path|GET|/posts}}` - List routes that map to a specified controller: -`rails routes -c {{posts|Posts|Blogs::PostsController}}` +`rails routes {{[-c|--controller]}} {{posts|Posts|Blogs::PostsController}}` diff --git a/pages/common/rails-server.md b/pages/common/rails-server.md index 4b63b730d8..4f9f4dc21f 100644 --- a/pages/common/rails-server.md +++ b/pages/common/rails-server.md @@ -9,16 +9,16 @@ - Run the web server on a specified port: -`rails server --port {{port_number}}` +`rails server {{[-p|--port]}} {{port_number}}` - Run the web server on a specified IP address: -`rails server --binding {{ip_address}}` +`rails server {{[-b|--binding]}} {{ip_address}}` - Run the web server on a specified environment: -`rails server --environment {{environment}}` +`rails server {{[-e|--environment]}} {{environment}}` - Display help: -`rails server --help` +`rails server {{[-h|--help]}}` diff --git a/pages/common/rails.md b/pages/common/rails.md index 35882fbcf6..76fa4de153 100644 --- a/pages/common/rails.md +++ b/pages/common/rails.md @@ -26,7 +26,7 @@ - Start local server for current project on a specified port: -`rails server -p "{{port}}"` +`rails server {{[-p|--port]}} "{{port}}"` - Open console to interact with application from command-line: @@ -34,4 +34,4 @@ - Check current version of rails: -`rails --version` +`rails {{[-v|--version]}}` diff --git a/pages/common/rapper.md b/pages/common/rapper.md index f1df4f6eab..26893d1ae6 100644 --- a/pages/common/rapper.md +++ b/pages/common/rapper.md @@ -6,8 +6,8 @@ - Convert an RDF/XML document to Turtle: -`rapper -i rdfxml -o turtle {{path/to/file}}` +`rapper {{[-i|--input]}} rdfxml {{[-o|--output]}} turtle {{path/to/file}}` - Count the number of triples in a Turtle file: -`rapper -i turtle -c {{path/to/file}}` +`rapper {{[-i|--input]}} turtle {{[-c|--count]}} {{path/to/file}}` diff --git a/pages/common/rar.md b/pages/common/rar.md index ed333ce4df..566e4bd613 100644 --- a/pages/common/rar.md +++ b/pages/common/rar.md @@ -5,7 +5,7 @@ - Archive 1 or more files: -`rar a {{path/to/archive_name.rar}} {{path/to/file1}} {{path/to/file2}} {{path/to/file3}}` +`rar a {{path/to/archive_name.rar}} {{path/to/file1 path/to/file2 path/to/file3 ...}}` - Archive a directory: diff --git a/pages/common/rbac-lookup.md b/pages/common/rbac-lookup.md index 1b6363a066..7cfd0c5bf4 100644 --- a/pages/common/rbac-lookup.md +++ b/pages/common/rbac-lookup.md @@ -13,11 +13,11 @@ - View all RBAC bindings along with the source role binding: -`rbac-lookup -o wide` +`rbac-lookup {{[-o|--output]}} wide` - View all RBAC bindings filtered by subject: -`rbac-lookup -k {{user|group|serviceaccount}}` +`rbac-lookup {{[-k|--kind]}} {{user|group|serviceaccount}}` - View all RBAC bindings along with IAM roles (if you are using GKE): diff --git a/pages/common/rclone.md b/pages/common/rclone.md index d214b6ab5a..3928c70a86 100644 --- a/pages/common/rclone.md +++ b/pages/common/rclone.md @@ -17,7 +17,7 @@ - Copy files changed within the past 24 hours to a remote from the local machine, asking the user to confirm each file: -`rclone copy --interactive --max-age 24h {{remote_name}}:{{path/to/directory}} {{path/to/local_directory}}` +`rclone copy {{[-i|--interactive]}} --max-age 24h {{remote_name}}:{{path/to/directory}} {{path/to/local_directory}}` - Mirror a specific file or directory (Note: Unlike copy, sync removes files from the remote if it does not exist locally): @@ -25,7 +25,7 @@ - Delete a remote file or directory (Note: `--dry-run` means test, remove it from the command to actually delete): -`rclone --dry-run delete {{remote_name}}:{{path/to/file_or_directory}}` +`rclone {{[-n|--dry-run]}} delete {{remote_name}}:{{path/to/file_or_directory}}` - Mount rclone remote (experimental): @@ -33,4 +33,4 @@ - Unmount rclone remote if `` fails (experimental): -`fusermount -u {{path/to/mount_point}}` +`fusermount {{[-u|--update]}} {{path/to/mount_point}}` diff --git a/pages/common/rdfind.md b/pages/common/rdfind.md index 1588b757cf..c742948bf2 100644 --- a/pages/common/rdfind.md +++ b/pages/common/rdfind.md @@ -1,7 +1,7 @@ # rdfind > Find files with duplicate content and get rid of them. -> More information: . +> More information: . - Identify all duplicates in a given directory and output a summary: diff --git a/pages/common/recon-ng.md b/pages/common/recon-ng.md new file mode 100644 index 0000000000..efa62a63fc --- /dev/null +++ b/pages/common/recon-ng.md @@ -0,0 +1,32 @@ +# recon-ng + +> Automated reconnaissance and information gathering tool. +> More information: . + +- Start the tool: + +`recon-ng` + +- Create a workspace: + +`workspaces create {{workspace_name}}` + +- Search the marketplace for modules used to accomplish different reconnaissance tasks: + +`marketplace search` + +- Install all available modules (some may need API keys to function completely): + +`marketplace install all` + +- Load the profiler module. It is used to scan the web for profiles matching the target, scrape them, and store them: + +`modules load profiler` + +- Insert the target's username. After entering this command, enter the desired username of the search and leave the rest of the options blank: + +`db insert profiles` + +- Run the current module: + +`run` diff --git a/pages/common/reflac.md b/pages/common/reflac.md index ed014d02ff..ac46d3cbd6 100644 --- a/pages/common/reflac.md +++ b/pages/common/reflac.md @@ -9,15 +9,15 @@ - Enable maximum compression (very slow): -`reflac --best {{path/to/directory}}` +`reflac {{[-8|--best]}} {{path/to/directory}}` - Display filenames as they are processed: -`reflac --verbose {{path/to/directory}}` +`reflac {{[-v|--verbose]}} {{path/to/directory}}` - Recurse into subdirectories: -`reflac --recursive {{path/to/directory}}` +`reflac {{[-r|--recursive]}} {{path/to/directory}}` - Preserve file modification times: diff --git a/pages/common/robo.md b/pages/common/robo.md index cbe5a69399..dc12ed76c4 100644 --- a/pages/common/robo.md +++ b/pages/common/robo.md @@ -1,7 +1,7 @@ # robo > PHP task runner. -> More information: . +> More information: . - List available commands: diff --git a/pages/common/route.md b/pages/common/route.md index 2dfc753922..ae548ed021 100644 --- a/pages/common/route.md +++ b/pages/common/route.md @@ -1,6 +1,6 @@ # route -> Use route cmd to set the route table. +> Show and manipulate the route table. > More information: . - Display the information of route table: diff --git a/pages/common/rpcdump.py.md b/pages/common/rpcdump.py.md new file mode 100644 index 0000000000..0fcb1c809e --- /dev/null +++ b/pages/common/rpcdump.py.md @@ -0,0 +1,25 @@ +# rpcdump.py + +> Dump remote RPC endpoints information via the Endpoint Mapper. +> Part of the Impacket suite. +> More information: . + +- Dump RPC endpoints using username and password: + +`rpcdump.py {{domain}}/{{username}}:{{password}}@{{target}}` + +- Dump RPC endpoints using NTLM hashes: + +`rpcdump.py -hashes {{LMHASH}}:{{NTHASH}} {{domain}}/{{username}}:{{password}}@{{target}}` + +- Specify a target IP address explicitly (useful if the target name is a NetBIOS name): + +`rpcdump.py -target-ip {{target_ip}} {{domain}}/{{username}}:{{password}}@{{target}}` + +- Connect to a specific port (default is 135 for RPC Endpoint Mapper): + +`rpcdump.py -port {{port_number}} {{domain}}/{{username}}:{{password}}@{{target}}` + +- Enable debug output: + +`rpcdump.py -debug {{domain}}/{{username}}:{{password}}@{{target}}` diff --git a/pages/common/rpcmap.py.md b/pages/common/rpcmap.py.md new file mode 100644 index 0000000000..b16a05c874 --- /dev/null +++ b/pages/common/rpcmap.py.md @@ -0,0 +1,37 @@ +# rpcmap.py + +> Lookup listening MSRPC interfaces using a string binding (e.g., `ncacn_ip_tcp:host[port]`). +> Part of the Impacket suite. +> More information: . + +- Connect to an MSRPC interface using a string binding (e.g., `ncacn_ip_tcp:host[port]`): + +`rpcmap.py {{stringbinding}}` + +- Bruteforce UUIDs even if the MGMT interface is available: + +`rpcmap.py -brute-uuids {{stringbinding}}` + +- Bruteforce operation numbers (opnums) for discovered UUIDs: + +`rpcmap.py -brute-opnums {{stringbinding}}` + +- Bruteforce major versions of found UUIDs: + +`rpcmap.py -brute-versions {{stringbinding}}` + +- Specify a target IP address manually: + +`rpcmap.py -target-ip {{ip_address}} {{stringbinding}}` + +- Authenticate to the RPC interface with username and password: + +`rpcmap.py -auth-rpc {{domain}}/{{username}}:{{password}} {{stringbinding}}` + +- Authenticate using NTLM hashes for RPC: + +`rpcmap.py -hashes-rpc {{LMHASH:NTHASH}} {{stringbinding}}` + +- Enable debug output for verbose information: + +`rpcmap.py -debug {{stringbinding}}` diff --git a/pages/common/rss2email.md b/pages/common/rss2email.md index e366f99120..293c7857dc 100644 --- a/pages/common/rss2email.md +++ b/pages/common/rss2email.md @@ -25,4 +25,4 @@ - Display help: -`r2e -h` +`r2e {{[-h|--help]}}` diff --git a/pages/common/rsstail.md b/pages/common/rsstail.md index 9e47b4f06b..3d3d4c9213 100644 --- a/pages/common/rsstail.md +++ b/pages/common/rsstail.md @@ -1,7 +1,7 @@ # rsstail > `tail` for RSS feeds. -> More information: . +> More information: . - Show the feed of a given URL and wait for new entries appearing at the bottom: diff --git a/pages/common/rtmpdump.md b/pages/common/rtmpdump.md index 203593ca41..4177783b4a 100644 --- a/pages/common/rtmpdump.md +++ b/pages/common/rtmpdump.md @@ -5,16 +5,16 @@ - Download a file: -`rtmpdump --rtmp {{rtmp://example.com/path/to/video}} -o {{file.ext}}` +`rtmpdump {{[-r|--rtmp]}} {{rtmp://example.com/path/to/video}} {{[-o|--flv]}} {{file.ext}}` - Download a file from a Flash player: -`rtmpdump --rtmp {{rtmp://example.com/path/to/video}} --swfVfy {{http://example.com/player}} --flashVer "{{LNX 10,0,32,18}}" -o {{file.ext}}` +`rtmpdump {{[-r|--rtmp]}} {{rtmp://example.com/path/to/video}} {{[-W|--swfVfy]}} {{http://example.com/player}} {{[-f|--flashVer]}} "{{LNX 10,0,32,18}}" {{[-o|--flv]}} {{file.ext}}` - Specify connection parameters if they are not detected correctly: -`rtmpdump --rtmp {{rtmp://example.com/path/to/video}} --app {{app_name}} --playpath {{path/to/video}} -o {{file.ext}}` +`rtmpdump {{[-r|--rtmp]}} {{rtmp://example.com/path/to/video}} {{[-a|--app]}} {{app_name}} {{[-y|--playpath]}} {{path/to/video}} {{[-o|--flv]}} {{file.ext}}` - Download a file from a server that requires a referrer: -`rtmpdump --rtmp {{rtmp://example.com/path/to/video}} --pageUrl {{http://example.com/webpage}} -o {{file.ext}}` +`rtmpdump {{[-r|--rtmp]}} {{rtmp://example.com/path/to/video}} {{[-p|--pageUrl]}} {{http://example.com/webpage}} {{[-o|--flv]}} {{file.ext}}` diff --git a/pages/common/rustc.md b/pages/common/rustc.md index 57dbe3b7a8..ce148c1ec1 100644 --- a/pages/common/rustc.md +++ b/pages/common/rustc.md @@ -10,7 +10,7 @@ - Compile with optimizations (`s` means optimize for binary size; `z` is the same with even more optimizations): -`rustc -C lto -C opt-level={{0|1|2|3|s|z}} {{path/to/main.rs}}` +`rustc {{[-C|--codegen]}} lto {{[-C|--codegen]}} opt-level={{0|1|2|3|s|z}} {{path/to/main.rs}}` - Compile with debugging information: @@ -22,7 +22,7 @@ - Compile with architecture-specific optimizations for the current CPU: -`rustc -C target-cpu={{native}} {{path/to/main.rs}}` +`rustc {{[-C|--codegen]}} target-cpu={{native}} {{path/to/main.rs}}` - Display the target list (Note: you have to add a target using `rustup` first to be able to compile for it): diff --git a/pages/common/salt-call.md b/pages/common/salt-call.md index 75cd449da1..cbbb52e78c 100644 --- a/pages/common/salt-call.md +++ b/pages/common/salt-call.md @@ -13,7 +13,7 @@ - Perform a highstate with verbose debugging output: -`salt-call -l debug state.highstate` +`salt-call {{[-l|--log-level]}} debug state.highstate` - List this minion's grains: diff --git a/pages/common/salt-key.md b/pages/common/salt-key.md index b69b662817..53528a48b0 100644 --- a/pages/common/salt-key.md +++ b/pages/common/salt-key.md @@ -6,16 +6,16 @@ - List all accepted, unaccepted and rejected minion keys: -`salt-key -L` +`salt-key {{[-L|--list-all]}}` - Accept a minion key by name: -`salt-key -a {{MINION_ID}}` +`salt-key {{[-a|--accept-all]}} {{MINION_ID}}` - Reject a minion key by name: -`salt-key -r {{MINION_ID}}` +`salt-key {{[-r|--reject]}} {{MINION_ID}}` - Print fingerprints of all public keys: -`salt-key -F` +`salt-key {{[-F|--finger-all]}}` diff --git a/pages/common/samtools.md b/pages/common/samtools.md index 81e9a912ee..9796d00e24 100644 --- a/pages/common/samtools.md +++ b/pages/common/samtools.md @@ -6,15 +6,15 @@ - Convert a SAM input file to BAM stream and save to file: -`samtools view -S -b {{input.sam}} > {{output.bam}}` +`samtools view -S {{[-b|--bam]}} {{input.sam}} > {{output.bam}}` - Take input from `stdin` (-) and print the SAM header and any reads overlapping a specific region to `stdout`: -`{{other_command}} | samtools view -h - chromosome:start-end` +`{{other_command}} | samtools view {{[-h|--with-header]}} - chromosome:start-end` - Sort file and save to BAM (the output format is automatically determined from the output file's extension): -`samtools sort {{input}} -o {{output.bam}}` +`samtools sort {{input}} {{[-o|--output]}} {{output.bam}}` - Index a sorted BAM file (creates `sorted_input.bam.bai`): diff --git a/pages/common/scc.md b/pages/common/scc.md index 27d28e66e9..a472c6ade2 100644 --- a/pages/common/scc.md +++ b/pages/common/scc.md @@ -17,11 +17,11 @@ - Display output using a specific output format (defaults to `tabular`): -`scc --format {{tabular|wide|json|csv|cloc-yaml|html|html-table}}` +`scc {{[-f|--format]}} {{tabular|wide|json|csv|cloc-yaml|html|html-table}}` - Only count files with specific file extensions: -`scc --include-ext {{go,java,js}}` +`scc {{[-i|--include-ext]}} {{go,java,js}}` - Exclude directories from being counted: @@ -29,8 +29,8 @@ - Display output and sort by column (defaults to by files): -`scc --sort {{files|name|lines|blanks|code|comments|complexity}}` +`scc {{[-s|--sort]}} {{files|name|lines|blanks|code|comments|complexity}}` - Display help: -`scc -h` +`scc {{[-h|--help]}}` diff --git a/pages/common/sd.md b/pages/common/sd.md index b42c174379..2aff96d553 100644 --- a/pages/common/sd.md +++ b/pages/common/sd.md @@ -13,7 +13,7 @@ - Find and replace in a specific file (output stream: `stdout`): -`sd -p {{'window.fetch'}} {{'fetch'}} {{path/to/file.js}}` +`sd {{[-p|--preview]}} {{'window.fetch'}} {{'fetch'}} {{path/to/file.js}}` - Find and replace in all files in the current project (output stream: `stdout`): diff --git a/pages/common/sdiff.md b/pages/common/sdiff.md index 0d43635555..b2191788e2 100644 --- a/pages/common/sdiff.md +++ b/pages/common/sdiff.md @@ -9,16 +9,16 @@ - Compare 2 files, ignoring all tabs and whitespace: -`sdiff -W {{path/to/file1}} {{path/to/file2}}` +`sdiff {{[-W|--ignore-all-space]}} {{path/to/file1}} {{path/to/file2}}` - Compare 2 files, ignoring whitespace at the end of lines: -`sdiff -Z {{path/to/file1}} {{path/to/file2}}` +`sdiff {{[-Z|--ignore-trailing-space]}} {{path/to/file1}} {{path/to/file2}}` - Compare 2 files in a case-insensitive manner: -`sdiff -i {{path/to/file1}} {{path/to/file2}}` +`sdiff {{[-i|--ignore-case]}} {{path/to/file1}} {{path/to/file2}}` - Compare and then merge, writing the output to a new file: -`sdiff -o {{path/to/merged_file}} {{path/to/file1}} {{path/to/file2}}` +`sdiff {{[-o|--output]}} {{path/to/merged_file}} {{path/to/file1}} {{path/to/file2}}` diff --git a/pages/common/sequelize.md b/pages/common/sequelize.md index 2777250807..5d5fd0db52 100644 --- a/pages/common/sequelize.md +++ b/pages/common/sequelize.md @@ -1,7 +1,7 @@ # sequelize > Promise-based Node.js ORM for Postgres, MySQL, MariaDB, SQLite and Microsoft SQL Server. -> More information: . +> More information: . - Create a model with 3 fields and a migration file: diff --git a/pages/common/serve.md b/pages/common/serve.md index 81ea0c6ecd..69bbab9cb6 100644 --- a/pages/common/serve.md +++ b/pages/common/serve.md @@ -13,11 +13,11 @@ - Start an HTTP server with CORS enabled by including the `Access-Control-Allow-Origin: *` header in all responses: -`serve --cors` +`serve {{[-C|--cors]}}` - Start an HTTP server on the default port rewriting all not-found requests to the `index.html` file: -`serve --single` +`serve {{[-s|--single]}}` - Start an HTTPS server on the default port using the specified certificate: @@ -25,7 +25,7 @@ - Start an HTTP server on the default port using a specific configuration file: -`serve --config {{path/to/serve.json}}` +`serve {{[-c|--config]}} {{path/to/serve.json}}` - Display help: diff --git a/pages/common/serverless.md b/pages/common/serverless.md index b476189e20..8a68cd5e81 100644 --- a/pages/common/serverless.md +++ b/pages/common/serverless.md @@ -26,4 +26,4 @@ - Follow the logs for a project: -`serverless logs -t` +`serverless logs {{[-t|--tail]}}` diff --git a/pages/common/sfdk-check.md b/pages/common/sfdk-check.md index 9f0a2b9a19..45c4511dfb 100644 --- a/pages/common/sfdk-check.md +++ b/pages/common/sfdk-check.md @@ -13,16 +13,16 @@ - Add testing level to the check: -`sfdk check -l +{{level}}` +`sfdk check {{[-l|--levels]}} +{{level}}` - Remove testing level from the check: -`sfdk check -l -{{level}}` +`sfdk check {{[-l|--levels]}} -{{level}}` - Add testing suite to the check: -`sfdk check -s +{{suite}}` +`sfdk check {{[-s|--suites]}} +{{suite}}` - Remove testing suite from the check: -`sfdk check -s -{{suite}}` +`sfdk check {{[-s|--suites]}} -{{suite}}` diff --git a/pages/common/sfdk-deploy.md b/pages/common/sfdk-deploy.md index 01d1786707..35444f8a5c 100644 --- a/pages/common/sfdk-deploy.md +++ b/pages/common/sfdk-deploy.md @@ -9,7 +9,7 @@ - Preview deploy without applying the changes: -`sfdk deploy --{{method}} --dry-run` +`sfdk deploy --{{method}} {{[-n|--dry-run]}}` - Deploy files in glob pattern `package*`: diff --git a/pages/common/sfdk-emulator-device-model-show.md b/pages/common/sfdk-emulator-device-model-show.md index 5ab7a5f8be..197f7985d4 100644 --- a/pages/common/sfdk-emulator-device-model-show.md +++ b/pages/common/sfdk-emulator-device-model-show.md @@ -1,6 +1,7 @@ # sfdk emulator device-model-show > Show emulated device model's properties. +> More information: . - Show a model properties: diff --git a/pages/common/sfdk-emulator-install.md b/pages/common/sfdk-emulator-install.md index 42c2405665..654b222a8f 100644 --- a/pages/common/sfdk-emulator-install.md +++ b/pages/common/sfdk-emulator-install.md @@ -13,7 +13,7 @@ - Display the available emulators: -`sfdk emulator list -a` +`sfdk emulator list {{[-a|--available]}}` - Display the installed emulators: diff --git a/pages/common/sfdk-emulator-start.md b/pages/common/sfdk-emulator-start.md index de30a8e2a3..ce58788370 100644 --- a/pages/common/sfdk-emulator-start.md +++ b/pages/common/sfdk-emulator-start.md @@ -1,6 +1,7 @@ # sfdk emulator start > Starts an emulator. +> More information: . - Start an emulator: diff --git a/pages/common/sfdk-init.md b/pages/common/sfdk-init.md index 43ea8596fd..1c0fdc7a6c 100644 --- a/pages/common/sfdk-init.md +++ b/pages/common/sfdk-init.md @@ -5,16 +5,16 @@ - Initialize a new project of the given type: -`sfdk init -t {{type}}` +`sfdk init {{[-t|--type]}} {{type}}` - Initialize a new project with a specified builder: -`sfdk init -t {{type}} -b {{builder}}` +`sfdk init {{[-t|--type]}} {{type}} {{[-b|--builder]}} {{builder}}` - Initialize a new project ignoring non-empty directory: -`sfdk init -t {{type}} --force` +`sfdk init {{[-t|--type]}} {{type}} --force` - List available project types: -`sfdk init -l` +`sfdk init {{[-l|--list-types]}}` diff --git a/pages/common/sfdk-maintain.md b/pages/common/sfdk-maintain.md index 6db707cd23..e80e731b6e 100644 --- a/pages/common/sfdk-maintain.md +++ b/pages/common/sfdk-maintain.md @@ -1,6 +1,7 @@ # sfdk maintain > Launches the interactive SDK Maintenance tool. +> More information: . - Launch SDK Maintenance tool: diff --git a/pages/common/sfdk-qmltypes.md b/pages/common/sfdk-qmltypes.md index e9f932bb55..c4a63aba07 100644 --- a/pages/common/sfdk-qmltypes.md +++ b/pages/common/sfdk-qmltypes.md @@ -1,6 +1,7 @@ # sfdk qmltypes > Generates qmltypes files. +> More information: . - Generate qmltypes files: diff --git a/pages/common/sfdk-scrape.md b/pages/common/sfdk-scrape.md index 6ffb55fca2..66c89ef4e0 100644 --- a/pages/common/sfdk-scrape.md +++ b/pages/common/sfdk-scrape.md @@ -1,6 +1,7 @@ # sfdk scrape > Converts source code modifications to patches. +> More information: . - Save source modifications as patches: @@ -8,7 +9,7 @@ - Preview the list of commits to be scrapped: -`sfdk scrape --dry-run` +`sfdk scrape {{[-n|--dry-run]}}` - Scrape while preserving the original patches file names: @@ -16,7 +17,7 @@ - Scrape while saving patches to a specified [o]utput directory: -`sfdk scrape -o {{directory}}` +`sfdk scrape {{[-o|--output-dir]}} {{directory}}` - Scrape without removing commits from submodules after creating patches: diff --git a/pages/common/sfdk-undeploy.md b/pages/common/sfdk-undeploy.md index 978dd0bb95..c28e8d2a8b 100644 --- a/pages/common/sfdk-undeploy.md +++ b/pages/common/sfdk-undeploy.md @@ -9,7 +9,7 @@ - Preview undeploy without applying the changes: -`sfdk undeploy --{{method}} --dry-run` +`sfdk undeploy --{{method}} {{[-n|--dry-run]}}` - Undeploy files in glob pattern `package*`: diff --git a/pages/common/sfdk.md b/pages/common/sfdk.md index 71eda94f8e..246727970d 100644 --- a/pages/common/sfdk.md +++ b/pages/common/sfdk.md @@ -17,7 +17,7 @@ - Display help: -`sfdk --help` +`sfdk {{[-h|--help]}}` - Display help for specific topic (`building`, `testing`, `maintaining`, `ide`, `all`): diff --git a/pages/common/shellcheck.md b/pages/common/shellcheck.md index e0dadf2f0f..d3ffd82ce8 100644 --- a/pages/common/shellcheck.md +++ b/pages/common/shellcheck.md @@ -7,30 +7,30 @@ `shellcheck {{path/to/script.sh}}` -- Check a shell script interpreting it as the specified [s]hell dialect (overrides the shebang at the top of the script): +- Check a shell script interpreting it as the specified shell dialect (overrides the shebang at the top of the script): -`shellcheck --shell {{sh|bash|dash|ksh}} {{path/to/script.sh}}` +`shellcheck {{[-s|--shell]}} {{sh|bash|dash|ksh}} {{path/to/script.sh}}` -- Ignor[e] one or more error types: +- Ignore one or more error types: -`shellcheck --exclude {{SC1009,SC1073,...}} {{path/to/script.sh}}` +`shellcheck {{[-e|--exclude]}} {{SC1009,SC1073,...}} {{path/to/script.sh}}` - Also check any sourced shell scripts: -`shellcheck --check-sourced {{path/to/script.sh}}` +`shellcheck {{[-a|--check-sourced]}} {{path/to/script.sh}}` -- Display output in the specified [f]ormat (defaults to `tty`): +- Display output in the specified format (defaults to `tty`): -`shellcheck --format {{tty|checkstyle|diff|gcc|json|json1|quiet}} {{path/to/script.sh}}` +`shellcheck {{[-f|--format]}} {{tty|checkstyle|diff|gcc|json|json1|quiet}} {{path/to/script.sh}}` - Enable one or more [o]ptional checks: -`shellcheck --enable {{add-default-case,avoid-nullary-conditions,...}} {{path/to/script.sh}}` +`shellcheck {{[-o|--enable]}} {{add-default-case,avoid-nullary-conditions,...}} {{path/to/script.sh}}` - List all available optional checks that are disabled by default: `shellcheck --list-optional` -- Adjust the level of [S]everity to consider (defaults to `style`): +- Adjust the level of severity to consider (defaults to `style`): -`shellcheck --severity {{error|warning|info|style}} {{path/to/script.sh}}` +`shellcheck {{[-S|--severity]}} {{error|warning|info|style}} {{path/to/script.sh}}` diff --git a/pages/common/shiori.md b/pages/common/shiori.md index b5dc3af00e..78de5fbbc5 100644 --- a/pages/common/shiori.md +++ b/pages/common/shiori.md @@ -1,7 +1,7 @@ # shiori > Simple bookmark manager built with Go. -> More information: . +> More information: . - Import bookmarks from HTML Netscape bookmark format file: diff --git a/pages/common/shred.md b/pages/common/shred.md index e6df761e39..09a78d8aaf 100644 --- a/pages/common/shred.md +++ b/pages/common/shred.md @@ -25,4 +25,4 @@ - Overwrite a file 100 times, add a final overwrite with zeros, remove the file after overwriting it and show verbose progress on the screen: -`shred {{[-vzun|--verbose --zero -u --iterations]}} 100 {{path/to/file}}` +`shred {{[-vzun|--verbose --zero --remove --iterations]}} 100 {{path/to/file}}` diff --git a/pages/common/skaffold.md b/pages/common/skaffold.md index b7b35704fb..7e5fc2626e 100644 --- a/pages/common/skaffold.md +++ b/pages/common/skaffold.md @@ -5,20 +5,20 @@ - Build the artifacts: -`skaffold build -f {{skaffold.yaml}}` +`skaffold build {{[-f|--filename]}} {{skaffold.yaml}}` - Build and deploy your app every time your code changes: -`skaffold dev -f {{skaffold.yaml}}` +`skaffold dev {{[-f|--filename]}} {{skaffold.yaml}}` - Run a pipeline file: -`skaffold run -f {{skaffold.yaml}}` +`skaffold run {{[-f|--filename]}} {{skaffold.yaml}}` - Run a diagnostic on Skaffold: -`skaffold diagnose -f {{skaffold.yaml}}` +`skaffold diagnose {{[-f|--filename]}} {{skaffold.yaml}}` - Deploy the artifacts: -`skaffold deploy -f {{skaffold.yaml}}` +`skaffold deploy {{[-f|--filename]}} {{skaffold.yaml}}` diff --git a/pages/common/skicka.md b/pages/common/skicka.md index 8c36633eca..8346af1f9c 100644 --- a/pages/common/skicka.md +++ b/pages/common/skicka.md @@ -1,7 +1,7 @@ # skicka > Manage your Google Drive. -> More information: . +> More information: . - Upload a file/folder to Google Drive: diff --git a/pages/common/slackcat.md b/pages/common/slackcat.md index 7c11491328..832f23df01 100644 --- a/pages/common/slackcat.md +++ b/pages/common/slackcat.md @@ -1,20 +1,20 @@ # slackcat > Utility for passing files and command output to Slack. -> More information: . +> More information: . - Post a file to Slack: -`slackcat --channel {{channel_name}} {{path/to/file}}` +`slackcat {{[-c|--channel]}} {{channel_name}} {{path/to/file}}` - Post a file to Slack with a custom filename: -`slackcat --channel {{channel_name}} --filename={{filename}} {{path/to/file}}` +`slackcat {{[-c|--channel]}} {{channel_name}} {{[-n|--filename]}} {{filename}} {{path/to/file}}` - Pipe command output to Slack as a text snippet: -`{{command}} | slackcat --channel {{channel_name}} --filename={{snippet_name}}` +`{{command}} | slackcat {{[-c|--channel]}} {{channel_name}} {{[-n|--filename]}} {{snippet_name}}` - Stream command output to Slack continuously: -`{{command}} | slackcat --channel {{channel_name}} --stream` +`{{command}} | slackcat {{[-c|--channel]}} {{channel_name}} {{[-s|--stream]}}` diff --git a/pages/common/sonar-scanner.md b/pages/common/sonar-scanner.md index d93ee623ff..498d68ec5c 100644 --- a/pages/common/sonar-scanner.md +++ b/pages/common/sonar-scanner.md @@ -9,12 +9,12 @@ - Scan a project using configuration file other than `sonar-project.properties`: -`sonar-scanner -D{{project.settings=myproject.properties}}` +`sonar-scanner {{[-D|--define]}} {{project.settings=myproject.properties}}` - Print debugging information: -`sonar-scanner -X` +`sonar-scanner {{[-X|--debug]}}` - Display help: -`sonar-scanner -h` +`sonar-scanner {{[-h|--help]}}` diff --git a/pages/common/sops.md b/pages/common/sops.md index b3d88b7d6c..19cea0083f 100644 --- a/pages/common/sops.md +++ b/pages/common/sops.md @@ -1,7 +1,7 @@ # sops > SOPS (Secrets OPerationS): a simple and flexible tool for managing secrets. -> More information: . +> More information: . - Encrypt a file: diff --git a/pages/common/sort.md b/pages/common/sort.md index e55a876324..f5a1da71a5 100644 --- a/pages/common/sort.md +++ b/pages/common/sort.md @@ -13,7 +13,7 @@ - Sort a file in case-insensitive way: -`sort {{-f|--ignore-case}} {{path/to/file}}` +`sort {{[-f|--ignore-case]}} {{path/to/file}}` - Sort a file using numeric rather than alphabetic order: diff --git a/pages/common/sox.md b/pages/common/sox.md index 95de2b251e..404de2a083 100644 --- a/pages/common/sox.md +++ b/pages/common/sox.md @@ -2,11 +2,11 @@ > Sound eXchange: play, record and convert audio files. > Audio formats are identified by the extension. -> More information: . +> More information: . - Merge two audio files into one: -`sox -m {{path/to/input_audio1}} {{path/to/input_audio2}} {{path/to/output_audio}}` +`sox {{[-m|--combine mix]}} {{path/to/input_audio1}} {{path/to/input_audio2}} {{path/to/output_audio}}` - Trim an audio file to the specified times: @@ -22,8 +22,8 @@ - Print statistical data of an audio file: -`sox {{path/to/input_audio}} -n stat` +`sox {{path/to/input_audio}} {{[-n|--null]}} stat` - Increase the volume of an audio file by 2x: -`sox -v 2.0 {{path/to/input_audio}} {{path/to/output_audio}}` +`sox {{[-v|--volume]}} 2.0 {{path/to/input_audio}} {{path/to/output_audio}}` diff --git a/pages/common/sphinx-build.md b/pages/common/sphinx-build.md index 99e6097b8b..4fe8d8a124 100644 --- a/pages/common/sphinx-build.md +++ b/pages/common/sphinx-build.md @@ -5,8 +5,8 @@ - Build documentation: -`sphinx-build -b {{html|epub|text|latex|man|...}} {{path/to/source_dir}} {{path/to/build_dir}}` +`sphinx-build {{[-b|--builder]}} {{html|epub|text|latex|man|...}} {{path/to/source_dir}} {{path/to/build_dir}}` - Build documentations intended for readthedocs.io (requires the sphinx-rtd-theme pip package): -`sphinx-build -b {{html}} {{path/to/docs_dir}} {{path/to/build_dir}}` +`sphinx-build {{[-b|--builder]}} {{html}} {{path/to/docs_dir}} {{path/to/build_dir}}` diff --git a/pages/common/spike.md b/pages/common/spike.md index 13ddfe0802..7c7176bb10 100644 --- a/pages/common/spike.md +++ b/pages/common/spike.md @@ -1,7 +1,7 @@ # spike > A fully featured static website generator written in JavaScript. -> More information: . +> More information: . - Create a new project using the default template: diff --git a/pages/common/sponge.md b/pages/common/sponge.md index 881502eeb1..afa418949e 100644 --- a/pages/common/sponge.md +++ b/pages/common/sponge.md @@ -9,4 +9,4 @@ - Remove all lines starting with # in a file: -`grep -v '^{{#}}' {{path/to/file}} | sponge {{path/to/file}}` +`grep {{[-v|--invert-match]}} '^{{#}}' {{path/to/file}} | sponge {{path/to/file}}` diff --git a/pages/common/sqlite-utils.md b/pages/common/sqlite-utils.md index 213a29601d..0b98bfa7be 100644 --- a/pages/common/sqlite-utils.md +++ b/pages/common/sqlite-utils.md @@ -33,4 +33,4 @@ - Display help: -`sqlite-utils -h` +`sqlite-utils {{[-h|--help]}}` diff --git a/pages/common/sqlite3.md b/pages/common/sqlite3.md index 60fcd6c973..bfda5a6cb3 100644 --- a/pages/common/sqlite3.md +++ b/pages/common/sqlite3.md @@ -1,7 +1,7 @@ # sqlite3 > The command-line interface to SQLite 3, which is a self-contained file-based embedded SQL engine. -> More information: . +> More information: . - Start an interactive shell with a new database: diff --git a/pages/common/sqlmap.md b/pages/common/sqlmap.md index 069e645671..3edb575df2 100644 --- a/pages/common/sqlmap.md +++ b/pages/common/sqlmap.md @@ -5,20 +5,20 @@ - Run sqlmap against a single target URL: -`python sqlmap.py -u "{{http://www.target.com/vuln.php?id=1}}"` +`python sqlmap.py {{[-u|--url]}} "{{http://www.example.com/vuln.php?id=1}}"` - Send data in a POST request (`--data` implies POST request): -`python sqlmap.py -u "{{http://www.target.com/vuln.php}}" --data="{{id=1}}"` +`python sqlmap.py {{[-u|--url]}} "{{http://www.example.com/vuln.php}}" --data="{{id=1}}"` - Change the parameter delimiter (& is the default): -`python sqlmap.py -u "{{http://www.target.com/vuln.php}}" --data="{{query=foobar;id=1}}" --param-del="{{;}}"` +`python sqlmap.py {{[-u|--url]}} "{{http://www.example.com/vuln.php}}" --data="{{query=foobar;id=1}}" --param-del="{{;}}"` - Select a random `User-Agent` from `./txt/user-agents.txt` and use it: -`python sqlmap.py -u "{{http://www.target.com/vuln.php}}" --random-agent` +`python sqlmap.py {{[-u|--url]}} "{{http://www.example.com/vuln.php}}" --random-agent` - Provide user credentials for HTTP protocol authentication: -`python sqlmap.py -u "{{http://www.target.com/vuln.php}}" --auth-type {{Basic}} --auth-cred "{{testuser:testpass}}"` +`python sqlmap.py {{[-u|--url]}} "{{http://www.example.com/vuln.php}}" --auth-type {{Basic}} --auth-cred "{{testuser:testpass}}"` diff --git a/pages/common/srm.md b/pages/common/srm.md index ce03f4a510..fea348b674 100644 --- a/pages/common/srm.md +++ b/pages/common/srm.md @@ -6,7 +6,7 @@ - Remove a file after a single-pass overwriting with random data: -`srm -s {{path/to/file}}` +`srm {{[-s|--simple]}} {{path/to/file}}` - Remove a file after seven passes of overwriting with random data: @@ -14,8 +14,8 @@ - Recursively remove a directory and its contents overwriting each file with a single-pass of random data: -`srm -r -s {{path/to/directory}}` +`srm {{[-r|--recursive]}} {{[-s|--simple]}} {{path/to/directory}}` - Prompt before every removal: -`srm -i {{\*}}` +`srm {{[-i|--interactive]}} {{\*}}` diff --git a/pages/common/st-flash.md b/pages/common/st-flash.md index a1b0039726..8410e55950 100644 --- a/pages/common/st-flash.md +++ b/pages/common/st-flash.md @@ -1,7 +1,7 @@ # st-flash > Flash binary files to STM32 ARM Cortex microcontrollers. -> More information: . +> More information: . - Read 4096 bytes from the device starting from 0x8000000: diff --git a/pages/common/st-util.md b/pages/common/st-util.md index 05311814b3..9d8647eafe 100644 --- a/pages/common/st-util.md +++ b/pages/common/st-util.md @@ -5,7 +5,7 @@ - Run GDB server on port 4500: -`st-util -p {{4500}}` +`st-util {{[-p|--listen_port]}} {{4500}}` - Connect to GDB server: diff --git a/pages/common/strings.md b/pages/common/strings.md index 1dc45cc313..3916798292 100644 --- a/pages/common/strings.md +++ b/pages/common/strings.md @@ -9,12 +9,12 @@ - Limit results to strings at least n characters long: -`strings -n {{n}} {{path/to/file}}` +`strings {{[-n|--bytes]}} {{n}} {{path/to/file}}` - Prefix each result with its offset within the file: -`strings -t d {{path/to/file}}` +`strings {{[-t|--radix]}} d {{path/to/file}}` - Prefix each result with its offset within the file in hexadecimal: -`strings -t x {{path/to/file}}` +`strings {{[-t|--radix]}} x {{path/to/file}}` diff --git a/pages/common/stty.md b/pages/common/stty.md index fc415405e7..3ecdcf3122 100644 --- a/pages/common/stty.md +++ b/pages/common/stty.md @@ -3,6 +3,10 @@ > Set options for a terminal device interface. > More information: . +- Display current terminal size: + +`stty size` + - Display all settings for the current terminal: `stty {{[-a|--all]}}` diff --git a/pages/common/subliminal.md b/pages/common/subliminal.md index 0e039aab6a..6f2d9609ac 100644 --- a/pages/common/subliminal.md +++ b/pages/common/subliminal.md @@ -5,4 +5,4 @@ - Download English subtitles for a video: -`subliminal download -l {{en}} {{video.ext}}` +`subliminal download {{[-l|--language]}} {{en}} {{video.ext}}` diff --git a/pages/common/supervisord.md b/pages/common/supervisord.md index c81236e8e4..c8a123fa73 100644 --- a/pages/common/supervisord.md +++ b/pages/common/supervisord.md @@ -6,8 +6,8 @@ - Start `supervisord` with specified configuration file: -`supervisord -c {{path/to/file}}` +`supervisord {{[-c|--configuration]}} {{path/to/file}}` - Run supervisord in the foreground: -`supervisord -n` +`supervisord {{[-n|--nodaemon]}}` diff --git a/pages/common/svgo.md b/pages/common/svgo.md index 5d85dfb6da..37b7b45d6c 100644 --- a/pages/common/svgo.md +++ b/pages/common/svgo.md @@ -10,23 +10,23 @@ - Optimize a file and save the result to another file: -`svgo {{test.svg}} -o {{test.min.svg}}` +`svgo {{test.svg}} {{[-o|--output]}} {{test.min.svg}}` - Optimize all SVG files within a directory (overwrites the original files): -`svgo -f {{path/to/directory/with/svg/files}}` +`svgo {{[-f|--folder]}} {{path/to/directory/with/svg/files}}` - Optimize all SVG files within a directory and save the resulting files to another directory: -`svgo -f {{path/to/input/directory}} -o {{path/to/output/directory}}` +`svgo {{[-f|--folder]}} {{path/to/input/directory}} {{[-o|--output]}} {{path/to/output/directory}}` - Optimize SVG content passed from another command, and save the result to a file: -`{{cat test.svg}} | svgo -i - -o {{test.min.svg}}` +`{{cat test.svg}} | svgo {{[-i|--input]}} - {{[-o|--output]}} {{test.min.svg}}` - Optimize a file and print out the result: -`svgo {{test.svg}} -o -` +`svgo {{test.svg}} {{[-o|--output]}} -` - Show available plugins: diff --git a/pages/common/svn-changelist.md b/pages/common/svn-changelist.md index e6238537ee..37014b83a5 100644 --- a/pages/common/svn-changelist.md +++ b/pages/common/svn-changelist.md @@ -1,7 +1,7 @@ # svn changelist > Associate a changelist with a set of files. -> More information: . +> More information: . - Add files to a changelist, creating the changelist if it does not exist: diff --git a/pages/common/swagger-codegen.md b/pages/common/swagger-codegen.md index 6c362a7dbc..75027d2237 100644 --- a/pages/common/swagger-codegen.md +++ b/pages/common/swagger-codegen.md @@ -5,11 +5,11 @@ - Generate documentation and code from an OpenAPI/swagger file: -`swagger-codegen generate -i {{swagger_file}} -l {{language}}` +`swagger-codegen generate {{[-i|--input-spec]}} {{swagger_file}} {{[-l|--lang]}} {{language}}` - Generate Java code using the library retrofit2 and the option useRxJava2: -`swagger-codegen generate -i {{http://petstore.swagger.io/v2/swagger.json}} -l {{java}} --library {{retrofit2}} -D{{useRxJava2}}={{true}}` +`swagger-codegen generate {{[-i|--input-spec]}} {{http://petstore.swagger.io/v2/swagger.json}} {{[-l|--lang]}} {{java}} --library {{retrofit2}} -D{{useRxJava2}}={{true}}` - List available languages: diff --git a/pages/common/symfony.md b/pages/common/symfony.md index 04322ae926..c9060842e6 100644 --- a/pages/common/symfony.md +++ b/pages/common/symfony.md @@ -1,7 +1,7 @@ # symfony > The console component for the Symfony framework. -> More information: . +> More information: . - Create a new Symfony project: diff --git a/pages/common/tcpreplay.md b/pages/common/tcpreplay.md index d04871e7b0..f47ca92616 100644 --- a/pages/common/tcpreplay.md +++ b/pages/common/tcpreplay.md @@ -9,20 +9,20 @@ - Replay traffic to interface: -`tcpreplay -i {{eth0}} {{traffic.pcap}}` +`tcpreplay {{[-i|--intf1]}} {{eth0}} {{traffic.pcap}}` - Replay traffic to interface and `stdout`: -`tcpreplay -i {{eth0}} --verbose {{traffic.pcap}}` +`tcpreplay {{[-i|--intf1]}} {{eth0}} {{[-v|--verbose]}} {{traffic.pcap}}` - Replay traffic to interface as fast as possible: -`tcpreplay -i {{eth0}} --topspeed {{traffic.pcap}}` +`tcpreplay {{[-i|--intf1]}} {{eth0}} {{[-t|--topspeed]}} {{traffic.pcap}}` - Replay traffic to interface at given Mbps: -`tcpreplay -i {{eth0}} -M {{10}} {{traffic.pcap}}` +`tcpreplay {{[-i|--intf1]}} {{eth0}} {{[-M|--mbps]}} {{10}} {{traffic.pcap}}` - Replay traffic to interface several times: -`tcpreplay -i {{eth0}} --loop={{num_times}} {{traffic.pcap}}` +`tcpreplay {{[-i|--intf1]}} {{eth0}} {{[-l|--loop]}} {{num_times}} {{traffic.pcap}}` diff --git a/pages/common/tee.md b/pages/common/tee.md index 684854758d..9b52d8a7ca 100644 --- a/pages/common/tee.md +++ b/pages/common/tee.md @@ -17,4 +17,4 @@ - Create a directory called "example", count the number of characters in "example" and write "example" to the terminal: -`echo "example" | tee >(xargs mkdir) >(wc -c)` +`echo "example" | tee >(xargs mkdir) >(wc {{[-c|--bytes]}})` diff --git a/pages/common/telnet.md b/pages/common/telnet.md index 3ae2768d59..0a7721ad2a 100644 --- a/pages/common/telnet.md +++ b/pages/common/telnet.md @@ -21,7 +21,7 @@ - Start `telnet` with "x" as the session termination character: -`telnet -e {{x}} {{ip_address}} {{port}}` +`telnet {{[-e|--escape]}} {{x}} {{ip_address}} {{port}}` - Telnet to Star Wars animation: diff --git a/pages/common/terraform.md b/pages/common/terraform.md index 3cefa09d56..782f1fdcf0 100644 --- a/pages/common/terraform.md +++ b/pages/common/terraform.md @@ -1,7 +1,7 @@ # terraform > Create and deploy infrastructure as code to cloud providers. -> More information: . +> More information: . - Initialize a new or existing Terraform configuration: diff --git a/pages/common/thunderbird.md b/pages/common/thunderbird.md index b5ad280153..d4a91f294e 100644 --- a/pages/common/thunderbird.md +++ b/pages/common/thunderbird.md @@ -1,7 +1,7 @@ # thunderbird > Email client and RSS reader. -> More information: . +> More information: . - Open thunderbird: diff --git a/pages/common/tidy.md b/pages/common/tidy.md index c67ec8810c..5b5acf00a1 100644 --- a/pages/common/tidy.md +++ b/pages/common/tidy.md @@ -2,7 +2,7 @@ > Clean up and pretty print HTML, XHTML and XML files. > Note: `tidy` cannot preserve original indentation. -> More information: . +> More information: . - Pretty print an HTML file: diff --git a/pages/common/tmpmail.md b/pages/common/tmpmail.md index c92352e300..3d0bb03a1b 100644 --- a/pages/common/tmpmail.md +++ b/pages/common/tmpmail.md @@ -1,11 +1,11 @@ # tmpmail > A temporary email right from your terminal written in POSIX sh. -> More information: . +> More information: . - Create a temporary inbox: -`tmpmail --generate` +`tmpmail {{[-g|--generate]}}` - List messages and their numeric ID: @@ -13,7 +13,7 @@ - Display the most recent received email: -`tmpmail --recent` +`tmpmail {{[-r|--recent]}}` - Open a specific message: @@ -21,8 +21,8 @@ - View email as raw text without HTML tags: -`tmpmail --text` +`tmpmail {{[-t|--text]}}` - Open email with a specific browser (default is w3m): -`tmpmail --browser {{browser}}` +`tmpmail {{[-b|--browser]}} {{browser}}` diff --git a/pages/common/tokei.md b/pages/common/tokei.md index 9eb459949b..d1a2f4598f 100644 --- a/pages/common/tokei.md +++ b/pages/common/tokei.md @@ -9,12 +9,12 @@ - Display a report for a directory excluding `.min.js` files: -`tokei {{path/to/directory}} -e {{*.min.js}}` +`tokei {{path/to/directory}} {{[-e|--exclude]}} {{*.min.js}}` - Display statistics for individual files in a directory: -`tokei {{path/to/directory}} --files` +`tokei {{path/to/directory}} {{[-f|--files]}}` - Display a report for all files of type Rust and Markdown: -`tokei {{path/to/directory}} -t={{Rust}},{{Markdown}}` +`tokei {{path/to/directory}} {{[-t|--type]}} {{Rust}},{{Markdown}}` diff --git a/pages/common/topgrade.md b/pages/common/topgrade.md index 07e41eb975..ded784b7de 100644 --- a/pages/common/topgrade.md +++ b/pages/common/topgrade.md @@ -9,11 +9,11 @@ - Say yes to all updates: -`topgrade -y` +`topgrade {{[-y|--yes]}}` - Cleanup temporary/old files: -`topgrade -c` +`topgrade {{[-c|--cleanup]}}` - Disable a certain update operation: diff --git a/pages/common/tox.md b/pages/common/tox.md index 848c3aaa34..4c8fdef815 100644 --- a/pages/common/tox.md +++ b/pages/common/tox.md @@ -14,7 +14,7 @@ - List the available environments: -`tox --listenvs-all` +`tox {{[-a|--listenvs-all]}}` - Run tests on a specific environment (e.g. Python 3.6): @@ -22,4 +22,4 @@ - Force the virtual environment to be recreated: -`tox --recreate -e {{py27}}` +`tox {{[-r|--recreate]}} -e {{py27}}` diff --git a/pages/common/tqdm.md b/pages/common/tqdm.md index b440835cfc..75887425af 100644 --- a/pages/common/tqdm.md +++ b/pages/common/tqdm.md @@ -13,8 +13,8 @@ - Create an archive out of a directory and use the file count of that directory to create a progress bar: -`zip -r {{path/to/archive.zip}} {{path/to/directory}} | tqdm --total $(find {{path/to/directory}} | wc -l) --unit files --null` +`zip {{[-r|--recurse-paths]}} {{path/to/archive.zip}} {{path/to/directory}} | tqdm --total $(find {{path/to/directory}} | wc {{[-l|--lines]}}) --unit files --null` - Create an archive with tar and create a progress bar (system agnostic, GNU tar uses `stdout` while BSD tar uses `stderr`): -`tar vzcf {{path/to/archive.tar.gz}} {{path/to/directory}} 2>&1 | tqdm --total $(find {{path/to/directory}} | wc -l) --unit files --null` +`tar vzcf {{path/to/archive.tar.gz}} {{path/to/directory}} 2>&1 | tqdm --total $(find {{path/to/directory}} | wc {{[-l|--lines]}}) --unit files --null` diff --git a/pages/common/traceroute.md b/pages/common/traceroute.md index 747c0d2d4f..1a127bc689 100644 --- a/pages/common/traceroute.md +++ b/pages/common/traceroute.md @@ -13,11 +13,11 @@ - Specify wait time in seconds for response: -`traceroute --wait={{0.5}} {{example.com}}` +`traceroute {{[-w|--wait]}} {{0.5}} {{example.com}}` - Specify number of queries per hop: -`traceroute --queries={{5}} {{example.com}}` +`traceroute {{[-q|--queries]}} {{5}} {{example.com}}` - Specify size in bytes of probing packet: @@ -29,4 +29,4 @@ - Use ICMP instead of UDP for tracerouting: -`traceroute --icmp {{example.com}}` +`traceroute {{[-I|--icmp]}} {{example.com}}` diff --git a/pages/common/trans.md b/pages/common/trans.md index a9eb076757..699b55d7ae 100644 --- a/pages/common/trans.md +++ b/pages/common/trans.md @@ -9,7 +9,7 @@ - Get a brief translation: -`trans --brief "{{word_or_sentence_to_translate}}"` +`trans {{[-b|-brief]}} "{{word_or_sentence_to_translate}}"` - Translate a word into french: @@ -21,4 +21,4 @@ - Behave like a dictionary to get the meaning of a word: -`trans -d {{word}}` +`trans {{[-d|-dictionary]}} {{word}}` diff --git a/pages/common/transmission-cli.md b/pages/common/transmission-cli.md index ae80ac8dbd..ae888218a2 100644 --- a/pages/common/transmission-cli.md +++ b/pages/common/transmission-cli.md @@ -2,7 +2,7 @@ > A lightweight, command-line BitTorrent client. > This tool has been deprecated, please see `transmission-remote`. -> More information: . +> More information: . - Download a specific torrent: @@ -10,7 +10,7 @@ - Download a torrent to a specific directory: -`transmission-cli --download-dir {{path/to/download_directory}} {{url|magnet|path/to/file}}` +`transmission-cli {{[-w|--download-dir]}} {{path/to/download_directory}} {{url|magnet|path/to/file}}` - Create a torrent file from a specific file or directory: @@ -18,20 +18,20 @@ - Specify the download speed limit (in KB/s): -`transmission-cli --downlimit {{50}} {{url|magnet|path/to/file}}` +`transmission-cli {{[-d|--downlimit]}} {{50}} {{url|magnet|path/to/file}}` - Specify the upload speed limit (in KB/s): -`transmission-cli --uplimit {{50}} {{url|magnet|path/to/file}}` +`transmission-cli {{[-u|--uplimit]}} {{50}} {{url|magnet|path/to/file}}` - Use a specific port for connections: -`transmission-cli --port {{port_number}} {{url|magnet|path/to/file}}` +`transmission-cli {{[-p|--port]}} {{port_number}} {{url|magnet|path/to/file}}` - Force encryption for peer connections: -`transmission-cli --encryption-required {{url|magnet|path/to/file}}` +`transmission-cli {{[-er|--encryption-required]}} {{url|magnet|path/to/file}}` - Use a Bluetack-formatted peer blocklist: -`transmission-cli --blocklist {{blocklist_url|path/to/blocklist}} {{url|magnet|path/to/file}}` +`transmission-cli {{[-b|--blocklist]}} {{blocklist_url|path/to/blocklist}} {{url|magnet|path/to/file}}` diff --git a/pages/common/transmission-create.md b/pages/common/transmission-create.md index 5b24a2aaf3..7f2f2b2ba8 100644 --- a/pages/common/transmission-create.md +++ b/pages/common/transmission-create.md @@ -4,22 +4,22 @@ > See also: `transmission`. > More information: . -- Create a torrent with 2048 KB as the piece size: +- Create a torrent with a specific piece size (in KB): -`transmission-create -o {{path/to/example.torrent}} --tracker {{tracker_announce_url}} --piecesize {{2048}} {{path/to/file_or_directory}}` +`transmission-create {{[-o|--outfile]}} {{path/to/example.torrent}} {{[-t|--tracker]}} {{tracker_announce_url}} {{[-s|--piecesize]}} {{2048}} {{path/to/file_or_directory}}` -- Create a private torrent with a 2048 KB piece size: +- Create a private torrent with a specific piece size (in KB): -`transmission-create -p -o {{path/to/example.torrent}} --tracker {{tracker_announce_url}} --piecesize {{2048}} {{path/to/file_or_directory}}` +`transmission-create {{[-p|--private]}} {{[-o|--outfile]}} {{path/to/example.torrent}} {{[-t|--tracker]}} {{tracker_announce_url}} {{[-s|--piecesize]}} {{2048}} {{path/to/file_or_directory}}` - Create a torrent with a comment: -`transmission-create -o {{path/to/example.torrent}} --tracker {{tracker_url1}} -c {{comment}} {{path/to/file_or_directory}}` +`transmission-create {{[-o|--outfile]}} {{path/to/example.torrent}} {{[-t|--tracker]}} {{tracker_url1}} {{[-c|--comment]}} {{comment}} {{path/to/file_or_directory}}` - Create a torrent with multiple trackers: -`transmission-create -o {{path/to/example.torrent}} --tracker {{tracker_url1}} --tracker {{tracker_url2}} {{path/to/file_or_directory}}` +`transmission-create {{[-o|--outfile]}} {{path/to/example.torrent}} {{[-t|--tracker]}} {{tracker_url1}} {{[-t|--tracker]}} {{tracker_url2}} {{path/to/file_or_directory}}` - Display help page: -`transmission-create --help` +`transmission-create {{[-h|--help]}}` diff --git a/pages/common/transmission-daemon.md b/pages/common/transmission-daemon.md index c8c24c51cd..1017912de2 100644 --- a/pages/common/transmission-daemon.md +++ b/pages/common/transmission-daemon.md @@ -10,12 +10,12 @@ - Start and watch a specific directory for new torrents: -`transmission-daemon --watch-dir {{path/to/directory}}` +`transmission-daemon {{[-c|--watch-dir]}} {{path/to/directory}}` - Dump daemon settings in JSON format: -`transmission-daemon --dump-settings > {{path/to/file.json}}` +`transmission-daemon {{[-d|--dump-settings]}} > {{path/to/file.json}}` - Start with specific settings for the web interface: -`transmission-daemon --auth --username {{username}} --password {{password}} --port {{9091}} --allowed {{127.0.0.1}}` +`transmission-daemon {{[-t|--auth]}} {{[-u|--username]}} {{username}} {{[-v|--password]}} {{password}} {{[-p|--port]}} {{9091}} {{[-a|--allowed]}} {{127.0.0.1}}` diff --git a/pages/common/transmission-edit.md b/pages/common/transmission-edit.md index 9891e2fff6..2f0ca3a515 100644 --- a/pages/common/transmission-edit.md +++ b/pages/common/transmission-edit.md @@ -4,10 +4,14 @@ > See also: `transmission`. > More information: . -- Add or remove a URL from a torrent's announce list: +- Add a URL to a torrent's announce list: -`transmission-edit --{{add|delete}} {{http://example.com}} {{path/to/file.torrent}}` +`transmission-edit {{[-a|--add]}} {{http://example.com}} {{path/to/file.torrent}}` + +- Remove a URL from a torrent's announce list: + +`transmission-edit {{[-d|--delete]}} {{http://example.com}} {{path/to/file.torrent}}` - Update a tracker's passcode in a torrent file: -`transmission-edit --replace {{old-passcode}} {{new-passcode}} {{path/to/file.torrent}}` +`transmission-edit {{[-r|--replace]}} {{old-passcode}} {{new-passcode}} {{path/to/file.torrent}}` diff --git a/pages/common/transmission-remote.md b/pages/common/transmission-remote.md index 0078fe2c6e..801820bda4 100644 --- a/pages/common/transmission-remote.md +++ b/pages/common/transmission-remote.md @@ -1,32 +1,32 @@ # transmission-remote > Remote control utility for `transmission-daemon` and `transmission`. -> More information: . +> More information: . - Add a torrent file or magnet link to Transmission and download to a specified directory: -`transmission-remote {{hostname}} -a {{torrent|url}} -w {{/path/to/download_directory}}` +`transmission-remote {{hostname}} {{[-a|--all]}} {{torrent|url}} {{[-w|--download-dir]}} {{/path/to/download_directory}}` - Change the default download directory: -`transmission-remote {{hostname}} -w {{/path/to/download_directory}}` +`transmission-remote {{hostname}} {{[-w|--download-dir]}} {{/path/to/download_directory}}` - List all torrents: -`transmission-remote {{hostname}} --list` +`transmission-remote {{hostname}} {{[-l|--list]}}` - Start torrent 1 and 2, stop torrent 3: -`transmission-remote {{hostname}} -t "{{1,2}}" --start -t {{3}} --stop` +`transmission-remote {{hostname}} {{[-t|--torrent]}} "1,2" {{[-s|--start]}} {{[-t|--torrent]}} 3 {{[-S|--stop]}}` - Remove torrent 1 and 2, and also delete local data for torrent 2: -`transmission-remote {{hostname}} -t {{1}} --remove -t {{2}} --remove-and-delete` +`transmission-remote {{hostname}} {{[-t|--torrent]}} 1 {{[-r|--remove]}} {{[-t|--torrent]}} 2 {{[-rad|--remove-and-delete]}}` - Stop all torrents: -`transmission-remote {{hostname}} -t {{all}} --stop` +`transmission-remote {{hostname}} {{[-t|--torrent]}} {{all}} {{[-S|--stop]}}` - Move torrents 1-10 and 15-20 to a new directory (which will be created if it does not exist): -`transmission-remote {{hostname}} -t "{{1-10,15-20}}" --move {{/path/to/new_directory}}` +`transmission-remote {{hostname}} {{[-t|--torrent]}} "1-10,15-20" --move {{/path/to/new_directory}}` diff --git a/pages/common/transmission-show.md b/pages/common/transmission-show.md index 7ac460bd6d..eaebb27495 100644 --- a/pages/common/transmission-show.md +++ b/pages/common/transmission-show.md @@ -10,8 +10,8 @@ - Generate a magnet link for a specific torrent: -`transmission-show --magnet {{path/to/file.torrent}}` +`transmission-show {{[-m|--magnet]}} {{path/to/file.torrent}}` - Query a torrent's trackers and print the current number of peers: -`transmission-show --scrape {{path/to/file.torrent}}` +`transmission-show {{[-s|--scrape]}} {{path/to/file.torrent}}` diff --git a/pages/common/trivy.md b/pages/common/trivy.md index ff6caa8c08..887444a9bf 100644 --- a/pages/common/trivy.md +++ b/pages/common/trivy.md @@ -9,7 +9,7 @@ - Scan a Docker image filtering the output by severity: -`trivy image --severity {{HIGH,CRITICAL}} {{alpine:3.15}}` +`trivy image {{[-s|--severity]}} {{HIGH,CRITICAL}} {{alpine:3.15}}` - Scan a Docker image ignoring any unfixed/unpatched vulnerabilities: @@ -33,4 +33,4 @@ - Generate output with a SARIF template: -`trivy image --format {{template}} --template "{{@sarif.tpl}}" -o {{path/to/report.sarif}} {{image:tag}}` +`trivy image {{[-f|--format]}} {{template}} {{[-t|--template]}} "{{@sarif.tpl}}" {{[-o|--output]}} {{path/to/report.sarif}} {{image:tag}}` diff --git a/pages/common/tspin.md b/pages/common/tspin.md index 81b8c663f3..8a45ca235d 100644 --- a/pages/common/tspin.md +++ b/pages/common/tspin.md @@ -9,11 +9,11 @@ - Read from another command and print to stdout: -`journalctl -b --follow | tspin` +`journalctl {{[-b|--boot]}} {{[-f|--follow]}} | tspin` - Read from file and print to `stdout`: -`tspin {{path/to/application.log}} --print` +`tspin {{path/to/application.log}} {{[-p|--print]}}` - Read from `stdin` and print to `stdout`: diff --git a/pages/common/tuc.md b/pages/common/tuc.md index 0bf5929cb9..14ed1c3522 100644 --- a/pages/common/tuc.md +++ b/pages/common/tuc.md @@ -6,20 +6,20 @@ - Cut and rearrange fields: -`echo "foo bar baz" | tuc -d '{{ }}' -f {{3,2,1}}` +`echo "foo bar baz" | tuc {{[-d|--delimiter]}} '{{ }}' {{[-f|--fields]}} {{3,2,1}}` - Replace the delimiter `space` with an arrow: -`echo "foo bar baz" | tuc -d ' ' -r ' ➡ '` +`echo "foo bar baz" | tuc {{[-d|--delimiter]}} ' ' {{[-r|--replace-delimiter]}} ' ➡ '` - Keep a range of fields: -`echo "foo bar baz" | tuc -d ' ' -f {{2:}}` +`echo "foo bar baz" | tuc {{[-d|--delimiter]}} ' ' {{[-f|--fields]}} {{2:}}` - Cut using regular expressions: -`echo "a,b, c" | tuc -e '{{[, ]+}}' -f {{1,3}}` +`echo "a,b, c" | tuc {{[-e|--regex]}} '{{[, ]+}}' {{[-f|--fields]}} {{1,3}}` - Emit JSON output: -`echo "foo bar baz" | tuc -d '{{ }}' --json` +`echo "foo bar baz" | tuc {{[-d|--delimiter]}} '{{ }}' --json` diff --git a/pages/common/twm.md b/pages/common/twm.md index d1fbdfd60e..4ce43e068c 100644 --- a/pages/common/twm.md +++ b/pages/common/twm.md @@ -1,7 +1,7 @@ # twm > A window manager for the X Window system. -> More information: . +> More information: . - Connect to the default X server: @@ -9,16 +9,16 @@ - Connect to a specific X server: -`twm -display {{display}}` +`twm {{[-d|-display]}} {{display}}` - Only manage the default screen: -`twm -s` +`twm {{[-s|-single]}}` - Use a specific startup file: -`twm -f {{path/to/file}}` +`twm {{[-f|-file]}} {{path/to/file}}` - Enable verbose mode and print unexpected errors in X: -`twm -v` +`twm {{[-v|-verbose]}}` diff --git a/pages/common/twurl.md b/pages/common/twurl.md index cd2633f995..3316166745 100644 --- a/pages/common/twurl.md +++ b/pages/common/twurl.md @@ -5,23 +5,23 @@ - Authorize `twurl` to access a Twitter account: -`twurl authorize --consumer-key {{twitter_api_key}} --consumer-secret {{twitter_api_secret}}` +`twurl authorize {{[-c|--consumer-key]}} {{twitter_api_key}} {{[-s|--consumer-secret]}} {{twitter_api_secret}}` - Make a GET request to an API endpoint: -`twurl -X GET {{twitter_api_endpoint}}` +`twurl {{[-X|--request-method]}} GET {{twitter_api_endpoint}}` - Make a POST request to an API endpoint: -`twurl -X POST -d '{{endpoint_params}}' {{twitter_api_endpoint}}` +`twurl {{[-X|--request-method]}} POST {{[-d|--data]}} '{{endpoint_params}}' {{twitter_api_endpoint}}` - Upload media to Twitter: -`twurl -H "{{twitter_upload_url}}" -X POST "{{twitter_upload_endpoint}}" --file "{{path/to/media.jpg}}" --file-field "media"` +`twurl {{[-H|--host]}} "{{twitter_upload_url}}" {{[-X|--request-method]}} POST "{{twitter_upload_endpoint}}" {{[-f|--file]}} "{{path/to/media.jpg}}" {{[-F|--file-field]}} "media"` - Access a different Twitter API host: -`twurl -H {{twitter_api_url}} -X GET {{twitter_api_endpoint}}` +`twurl {{[-H|--host]}} {{twitter_api_url}} {{[-X|--request-method]}} GET {{twitter_api_endpoint}}` - Create an alias for a requested resource: diff --git a/pages/common/ulimit.md b/pages/common/ulimit.md index 665cf41c99..20eb41c3ec 100644 --- a/pages/common/ulimit.md +++ b/pages/common/ulimit.md @@ -1,7 +1,7 @@ # ulimit > Get and set resource limits for user processes. -> More information: . +> More information: . - Get the properties of all the user limits: diff --git a/pages/common/unar.md b/pages/common/unar.md index cd68d1e3d2..e17ae2043f 100644 --- a/pages/common/unar.md +++ b/pages/common/unar.md @@ -9,16 +9,16 @@ - Extract an archive to the specified directory: -`unar -o {{path/to/directory}} {{path/to/archive}}` +`unar {{[-o|-output-directory]}} {{path/to/directory}} {{path/to/archive}}` - Force overwrite if files to be unpacked already exist: -`unar -f {{path/to/archive}}` +`unar {{[-f|-force-overwrite]}} {{path/to/archive}}` - Force rename if files to be unpacked already exist: -`unar -r {{path/to/archive}}` +`unar {{[-r|-force-rename]}} {{path/to/archive}}` - Force skip if files to be unpacked already exist: -`unar -s {{path/to/archive}}` +`unar {{[-s|-force-skip]}} {{path/to/archive}}` diff --git a/pages/common/uuencode.md b/pages/common/uuencode.md index 545a1f18a5..c2171496cc 100644 --- a/pages/common/uuencode.md +++ b/pages/common/uuencode.md @@ -13,4 +13,4 @@ - Encode a file using Base64 instead of the default uuencode encoding and write the result to a file: -`uuencode -m -o {{path/to/output_file}} {{path/to/input_file}} {{output_file_name_after_decoding}}` +`uuencode {{[-m|--base64]}} -o {{path/to/output_file}} {{path/to/input_file}} {{output_file_name_after_decoding}}` diff --git a/pages/common/velero.md b/pages/common/velero.md index 8df1ba98d9..77902cf4d6 100644 --- a/pages/common/velero.md +++ b/pages/common/velero.md @@ -1,7 +1,7 @@ # velero > Backup and migrate Kubernetes applications and their persistent volumes. -> More information: . +> More information: . - Create a backup containing all resources: diff --git a/pages/common/venv.md b/pages/common/venv.md index d9a0cbab74..d5d044ae0b 100644 --- a/pages/common/venv.md +++ b/pages/common/venv.md @@ -1,7 +1,7 @@ # venv > Create lightweight virtual environments in python. -> More information: . +> More information: . - Create a Python virtual environment: @@ -18,3 +18,7 @@ - Deactivate the virtual environment: `deactivate` + +- Create an alias that generates a `venv` folder and automatically activates it: + +`alias venv='python -m venv .venv && source {{.venv/bin/activate|.venv\Scripts\activate.bat}}'` diff --git a/pages/common/vinmap.md b/pages/common/vinmap.md index d6554f958d..5a27b7bba1 100644 --- a/pages/common/vinmap.md +++ b/pages/common/vinmap.md @@ -5,20 +5,20 @@ - Perform a basic scan of a subnet: -`vinmap -ip {{192.168.1.0/24}}` +`vinmap {{[-ip|--ip_range]}} {{192.168.1.0/24}}` - Scan a domain with version and OS detection, saving results to a specific file: -`vinmap -ip {{example.com}} -s "-sV -O" -o {{path/to/scan_results.xml}}` +`vinmap {{[-ip|--ip_range]}} {{example.com}} {{[-s|--scan_type]}} "-sV -O" -o {{path/to/scan_results.xml}}` - Scan an IP range using 10 chunks and 20 concurrent threads, uses half of the system's CPU cores if not specified: -`vinmap -ip {{10.0.0.1-10.0.0.255}} -n 10 -t 20` +`vinmap {{[-ip|--ip_range]}} {{10.0.0.1-10.0.0.255}} {{[-n|--num_chunks]}} 10 {{[-t|--threads]}} 20` - Output scan results in JSON format: -`vinmap -ip {{192.168.1.1-192.168.1.100}} -f json` +`vinmap {{[-ip|--ip_range]}} {{192.168.1.1-192.168.1.100}} {{[-f|--format]}} json` - Scan multiple IPs with default settings and save merged XML output: -`vinmap -ip {{192.168.1.1,192.168.1.2,...}}` +`vinmap {{[-ip|--ip_range]}} {{192.168.1.1,192.168.1.2,...}}` diff --git a/pages/common/virtualenv.md b/pages/common/virtualenv.md index 0b43a3d6b6..6c46c08d59 100644 --- a/pages/common/virtualenv.md +++ b/pages/common/virtualenv.md @@ -1,7 +1,7 @@ # virtualenv > Create virtual isolated Python environments. -> More information: . +> More information: . - Create a new environment: @@ -9,11 +9,11 @@ - Customize the prompt prefix: -`virtualenv --prompt={{prompt_prefix}} {{path/to/venv}}` +`virtualenv --prompt {{prompt_prefix}} {{path/to/venv}}` - Use a different version of Python with virtualenv: -`virtualenv --python={{path/to/pythonbin}} {{path/to/venv}}` +`virtualenv {{[-p|--python]}} {{path/to/pythonbin}} {{path/to/venv}}` - Start (select) the environment: diff --git a/pages/common/visudo.md b/pages/common/visudo.md index ad1395dc77..6b5d760171 100644 --- a/pages/common/visudo.md +++ b/pages/common/visudo.md @@ -9,7 +9,7 @@ - Check the sudoers file for errors: -`sudo visudo -c` +`sudo visudo {{[-c|--check]}}` - Edit the sudoers file using a specific editor: @@ -17,4 +17,4 @@ - Display version information: -`visudo --version` +`visudo {{[-V|--version]}}` diff --git a/pages/common/viu.md b/pages/common/viu.md index c09246c9f0..b057a0b47e 100644 --- a/pages/common/viu.md +++ b/pages/common/viu.md @@ -9,16 +9,16 @@ - Render an image or GIF from the internet using `curl`: -`curl -s {{https://example.com/image.png}} | viu -` +`curl {{[-s|--silent]}} {{https://example.com/image.png}} | viu -` - Render an image with a transparent background: -`viu -t {{path/to/file}}` +`viu {{[-t|--transparent]}} {{path/to/file}}` - Render an image with a specific width and height in pixels: -`viu -w {{width}} -h {{height}} {{path/to/file}}` +`viu {{[-w|--width]}} {{width}} {{[-h|--height]}} {{height}} {{path/to/file}}` - Render an image or GIF and display its file name: -`viu -n {{path/to/file}}` +`viu {{[-n|--name]}} {{path/to/file}}` diff --git a/pages/common/vue-build.md b/pages/common/vue-build.md index a821281233..934c8a33d4 100644 --- a/pages/common/vue-build.md +++ b/pages/common/vue-build.md @@ -1,7 +1,7 @@ # vue build > A subcommand provided by `@vue/cli` and `@vue/cli-service-global` that enables quick prototyping. -> More information: . +> More information: . - Build a `.js` or `.vue` file in production mode with zero config: diff --git a/pages/common/vue-serve.md b/pages/common/vue-serve.md index c3282ef0e2..fa8070d798 100644 --- a/pages/common/vue-serve.md +++ b/pages/common/vue-serve.md @@ -1,7 +1,7 @@ # vue serve > A subcommand provided by `@vue/cli` and `@vue/cli-service-global` that enables quick prototyping. -> More information: . +> More information: . - Serve a `.js` or `.vue` file in development mode with zero config: diff --git a/pages/common/vue.md b/pages/common/vue.md index 3ba7b052cf..f7be362111 100644 --- a/pages/common/vue.md +++ b/pages/common/vue.md @@ -2,7 +2,7 @@ > Multi-purpose CLI for Vue.js. > Some subcommands such as `build` have their own usage documentation. -> More information: . +> More information: . - Create a new Vue project interactively: diff --git a/pages/common/wafw00f.md b/pages/common/wafw00f.md index 3c75571eae..6bb42c88de 100644 --- a/pages/common/wafw00f.md +++ b/pages/common/wafw00f.md @@ -15,7 +15,7 @@ `wafw00f {{[-p|--proxy]}} {{http://localhost:8080}} {{https://www.example.com}}` -- Test for a specific WAF product (run `wafw00f -l` to get list of all supported WAFs): +- Test for a specific WAF product (run `wafw00f --list` to get list of all supported WAFs): `wafw00f {{[-t|--test]}} {{Cloudflare|Cloudfront|Fastly|ZScaler|...}} {{https://www.example.com}}` diff --git a/pages/common/wakeonlan.md b/pages/common/wakeonlan.md index fb7fab1792..a7d40c9996 100644 --- a/pages/common/wakeonlan.md +++ b/pages/common/wakeonlan.md @@ -9,12 +9,12 @@ - Send packet to a specific device via IP address: -`wakeonlan {{01:02:03:04:05:06}} -i {{192.168.178.2}}` +`wakeonlan {{01:02:03:04:05:06}} {{[-i|--ip]}} {{192.168.178.2}}` - Print the commands, but don't execute them (dry-run): -`wakeonlan -n {{01:02:03:04:05:06}}` +`wakeonlan {{[-n|--dry-run]}} {{01:02:03:04:05:06}}` - Run in quiet mode: -`wakeonlan -q {{01:02:03:04:05:06}}` +`wakeonlan {{[-q|--quiet]}} {{01:02:03:04:05:06}}` diff --git a/pages/common/wasm-objdump.md b/pages/common/wasm-objdump.md index af8422ff4b..a219278804 100644 --- a/pages/common/wasm-objdump.md +++ b/pages/common/wasm-objdump.md @@ -5,16 +5,16 @@ - Display the section headers of a given binary: -`wasm-objdump -h {{file.wasm}}` +`wasm-objdump {{[-h|--headers]}} {{file.wasm}}` - Display the entire disassembled output of a given binary: -`wasm-objdump -d {{file.wasm}}` +`wasm-objdump {{[-d|--disassemble]}} {{file.wasm}}` - Display the details of each section: -`wasm-objdump --details {{file.wasm}}` +`wasm-objdump {{[-x|--details]}} {{file.wasm}}` - Display the details of a given section: -`wasm-objdump --section '{{import}}' --details {{file.wasm}}` +`wasm-objdump {{[-j|--section]}} '{{import}}' {{[-x|--details]}} {{file.wasm}}` diff --git a/pages/common/wasm-opt.md b/pages/common/wasm-opt.md index f472e34e49..55ec27438b 100644 --- a/pages/common/wasm-opt.md +++ b/pages/common/wasm-opt.md @@ -5,15 +5,15 @@ - Apply default optimizations and write to a given file: -`wasm-opt -O {{input.wasm}} -o {{output.wasm}}` +`wasm-opt -O {{input.wasm}} {{[-o|--output]}} {{output.wasm}}` - Apply all optimizations and write to a given file (takes more time, but generates optimal code): -`wasm-opt -O4 {{input.wasm}} -o {{output.wasm}}` +`wasm-opt -O4 {{input.wasm}} {{[-o|--output]}} {{output.wasm}}` - Optimize a file for size: -`wasm-opt -Oz {{input.wasm}} -o {{output.wasm}}` +`wasm-opt -Oz {{input.wasm}} {{[-o|--output]}} {{output.wasm}}` - Print the textual representation of the binary to console: diff --git a/pages/common/wasm2c.md b/pages/common/wasm2c.md index c9684cb10a..84d6fbae9c 100644 --- a/pages/common/wasm2c.md +++ b/pages/common/wasm2c.md @@ -9,4 +9,4 @@ - Write the output to a given file (`file.h` gets additionally generated): -`wasm2c {{file.wasm}} -o {{file.c}}` +`wasm2c {{file.wasm}} {{[-o|--output]}} {{file.c}}` diff --git a/pages/common/wasm2wat.md b/pages/common/wasm2wat.md index cbfc851b7e..afeee8758e 100644 --- a/pages/common/wasm2wat.md +++ b/pages/common/wasm2wat.md @@ -9,4 +9,4 @@ - Write the output to a given file: -`wasm2wat {{file.wasm}} -o {{file.wat}}` +`wasm2wat {{file.wasm}} {{[-o|--output]}} {{file.wat}}` diff --git a/pages/common/wat2wasm.md b/pages/common/wat2wasm.md index f7114efc5b..0ced799d1b 100644 --- a/pages/common/wat2wasm.md +++ b/pages/common/wat2wasm.md @@ -9,8 +9,8 @@ - Write the output binary to a given file: -`wat2wasm {{file.wat}} -o {{file.wasm}}` +`wat2wasm {{file.wat}} {{[-o|--output]}} {{file.wasm}}` - Display simplified representation of every byte: -`wat2wasm -v {{file.wat}}` +`wat2wasm {{[-v|--verbose]}} {{file.wat}}` diff --git a/pages/common/watchexec.md b/pages/common/watchexec.md index 755daea2ed..3732a54393 100644 --- a/pages/common/watchexec.md +++ b/pages/common/watchexec.md @@ -1,7 +1,7 @@ # watchexec > Run arbitrary commands when files change. -> More information: . +> More information: . - Call `ls -la` when any file in the current directory changes: @@ -9,12 +9,12 @@ - Run `make` when any JavaScript, CSS and HTML file in the current directory changes: -`watchexec --exts {{js,css,html}} make` +`watchexec {{[-e|--exts]}} {{js,css,html}} make` - Run `make` when any file in the `lib` or `src` directory changes: -`watchexec --watch {{lib}} --watch {{src}} {{make}}` +`watchexec {{[-w|--watch]}} {{lib}} {{[-w|--watch]}} {{src}} {{make}}` - Call/restart `my_server` when any file in the current directory changes, sending `SIGKILL` to stop the child process: -`watchexec --restart --stop-signal {{SIGKILL}} {{my_server}}` +`watchexec {{[-r|--restart]}} --stop-signal {{SIGKILL}} {{my_server}}` diff --git a/pages/common/waymore.md b/pages/common/waymore.md index 5c24efb027..6897316309 100644 --- a/pages/common/waymore.md +++ b/pages/common/waymore.md @@ -6,16 +6,16 @@ - Search for URLs of a domain (output will typically be in `~/.config/waymore/results/`): -`waymore -i {{example.com}}` +`waymore {{[-i|--input]}} {{example.com}}` - Limit search results to only include a list of URLs for a domain and store outputs to the specified file: -`waymore -mode U -oU {{path/to/example.com-urls.txt}} -i {{example.com}}` +`waymore -mode U {{[-oU|--output-urls]}} {{path/to/example.com-urls.txt}} {{[-i|--input]}} {{example.com}}` - Only output the content bodies of URLs and store outputs to the specified directory: -`waymore -mode R -oR {{path/to/example.com-url-responses}} -i {{example.com}}` +`waymore -mode R {{[-oR|--output-responses]}} {{path/to/example.com-url-responses}} {{[-i|--input]}} {{example.com}}` - Filter the results by specifying date ranges: -`waymore -from {{YYYYMMDD|YYYYMM|YYYY}} -to {{YYYYMMDD|YYYYMM|YYYY}} -i {{example.com}}` +`waymore -from {{YYYYMMDD|YYYYMM|YYYY}} {{[-to|--to-date]}} {{YYYYMMDD|YYYYMM|YYYY}} {{[-i|--input]}} {{example.com}}` diff --git a/pages/common/webstorm.md b/pages/common/webstorm.md index 6802dea26e..bc2540729a 100644 --- a/pages/common/webstorm.md +++ b/pages/common/webstorm.md @@ -11,7 +11,7 @@ `webstorm {{path/to/directory}}` -- Open specific files in the LightEdit mode: +- Open specific files in the LightEdit mode: `webstorm -e {{path/to/file1 path/to/file2 ...}}` diff --git a/pages/common/whatweb.md b/pages/common/whatweb.md index 01d1541f99..308f362e0f 100644 --- a/pages/common/whatweb.md +++ b/pages/common/whatweb.md @@ -9,15 +9,15 @@ - Read targets/websites from a file: -`whatweb -i {{targets_file}}` +`whatweb {{[-i|--input-file]}} {{targets_file}}` - Scan a website/target in verbose mode: -`whatweb -v {{example.com}}` +`whatweb {{[-v|--verbose]}} {{example.com}}` - Run an aggressive scan on a website: -`whatweb -a 3 {{example.com}}` +`whatweb {{[-a|--aggression]}} 3 {{example.com}}` - Scan a network and suppress errors: @@ -25,8 +25,8 @@ - List plugins: -`whatweb -l` +`whatweb {{[-l|--list-plugins]}}` - List plugin details: -`whatweb -I {{plugin_name}}` +`whatweb {{[-I|--info-plugins]}} {{plugin_name}}` diff --git a/pages/common/which.md b/pages/common/which.md index 2e809be293..7809a630fb 100644 --- a/pages/common/which.md +++ b/pages/common/which.md @@ -9,4 +9,4 @@ - If there are multiple executables which match, display all: -`which -a {{executable}}` +`which {{[-a|--all]}} {{executable}}` diff --git a/pages/common/wondershaper.md b/pages/common/wondershaper.md index b8ed86e236..b92d7ac9bc 100644 --- a/pages/common/wondershaper.md +++ b/pages/common/wondershaper.md @@ -3,10 +3,6 @@ > Allows the user to limit the bandwidth of network adapters. > More information: . -- Display [h]elp: - -`wondershaper -h` - - Show the current [s]tatus of a specific [a]dapter: `wondershaper -s -a {{adapter_name}}` @@ -26,3 +22,7 @@ - Set a specific maximum [d]ownload rate and [u]pload rate (in Kpbs): `wondershaper -a {{adapter_name}} -d {{1024}} -u {{512}}` + +- Display [h]elp: + +`wondershaper -h` diff --git a/pages/common/wrk.md b/pages/common/wrk.md index 5dd1428c59..925b0cda1e 100644 --- a/pages/common/wrk.md +++ b/pages/common/wrk.md @@ -5,12 +5,12 @@ - Run a benchmark for `30` seconds, using `12` threads, and keeping `400` HTTP connections open: -`wrk -t{{12}} -c{{400}} -d{{30s}} "{{http://127.0.0.1:8080/index.html}}"` +`wrk {{[-t|--threads]}} {{12}} {{[-c|--connections]}} {{400}} {{[-d|--duration]}} {{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|--threads]}} {{2}} {{[-c|--connections]}} {{5}} {{[-d|--duration]}} {{5s}} {{[-H|--header]}} "{{Host: example.com}}" "{{http://example.com/index.html}}"` - Run a benchmark with a request timeout of `2` seconds: -`wrk -t{{2}} -c{{5}} -d{{5s}} --timeout {{2s}} "{{http://example.com/index.html}}"` +`wrk {{[-t|--threads]}} {{2}} {{[-c|--connections]}} {{5}} {{[-d|--duration]}} {{5s}} --timeout {{2s}} "{{http://example.com/index.html}}"` diff --git a/pages/common/x_x.md b/pages/common/x_x.md index 50fe1742b6..d216056b8c 100644 --- a/pages/common/x_x.md +++ b/pages/common/x_x.md @@ -9,8 +9,8 @@ - View an XLSX or CSV file, using the first row as table headers: -`x_x -h {{0}} {{file.xlsx|file.csv}}` +`x_x {{[-h|--heading]}} {{0}} {{file.xlsx|file.csv}}` - View a CSV file with unconventional delimiters: -`x_x --delimiter={{';'}} --quotechar={{'|'}} {{file.csv}}` +`x_x {{[-d|--delimiter]}} {{';'}} {{[-q|--quotechar]}} {{'|'}} {{file.csv}}` diff --git a/pages/common/xargs.md b/pages/common/xargs.md index 8aae16c8b5..8ca876cfac 100644 --- a/pages/common/xargs.md +++ b/pages/common/xargs.md @@ -18,7 +18,7 @@ - Execute the command once per argument: -`{{arguments_source}} | xargs {{-n|--max-args}} 1 {{command}}` +`{{arguments_source}} | xargs {{[-n|--max-args]}} 1 {{command}}` - Execute the command once for each input line, replacing any occurrences of the placeholder (here marked as `_`) with the input line: diff --git a/pages/common/xidel.md b/pages/common/xidel.md index b130b9151b..c679c62008 100644 --- a/pages/common/xidel.md +++ b/pages/common/xidel.md @@ -5,32 +5,32 @@ - Print all URLs found by a Google search: -`xidel {{https://www.google.com/search?q=test}} --extract "//a/extract(@href, 'url[?]q=([^&]+)&', 1)[. != '']"` +`xidel {{https://www.google.com/search?q=test}} {{[-e|--extract]}} "//a/extract(@href, 'url[?]q=([^&]+)&', 1)[. != '']"` - Print the title of all pages found by a Google search and download them: -`xidel {{https://www.google.com/search?q=test}} --follow "{{//a/extract(@href, 'url[?]q=([^&]+)&', 1)[. != '']}}" --extract {{//title}} --download {{'{$host}/'}}` +`xidel {{https://www.google.com/search?q=test}} {{[-f|--follow]}} "{{//a/extract(@href, 'url[?]q=([^&]+)&', 1)[. != '']}}" {{[-e|--extract]}} {{//title}} --download {{'{$host}/'}}` - Follow all links on a page and print the titles, with XPath: -`xidel {{https://example.org}} --follow {{//a}} --extract {{//title}}` +`xidel {{https://example.org}} {{[-f|--follow]}} {{//a}} {{[-e|--extract]}} {{//title}}` - Follow all links on a page and print the titles, with CSS selectors: -`xidel {{https://example.org}} --follow "{{css('a')}}" --css {{title}}` +`xidel {{https://example.org}} {{[-f|--follow]}} "{{css('a')}}" --css {{title}}` - Follow all links on a page and print the titles, with pattern matching: -`xidel {{https://example.org}} --follow "{{{.}*}}" --extract "{{{.}}}"` +`xidel {{https://example.org}} {{[-f|--follow]}} "{{{.}*}}" {{[-e|--extract]}} "{{{.}}}"` - Read the pattern from example.xml (which will also check if the element containing "ood" is there, and fail otherwise): -`xidel {{path/to/example.xml}} --extract "{{ood{.}}}"` +`xidel {{path/to/example.xml}} {{[-e|--extract]}} "{{ood{.}}}"` - Print all newest Stack Overflow questions with title and URL using pattern matching on their RSS feed: -`xidel {{http://stackoverflow.com/feeds}} --extract "{{{title:=.}{uri:=@href}+}}"` +`xidel {{http://stackoverflow.com/feeds}} {{[-e|--extract]}} "{{{title:=.}{uri:=@href}+}}"` - Check for unread Reddit mail, Webscraping, combining CSS, XPath, JSONiq, and automatically form evaluation: -`xidel {{https://reddit.com}} --follow "{{form(css('form.login-form')[1], {'user': '$your_username', 'passwd': '$your_password'})}}" --extract "{{css('#mail')/@title}}"` +`xidel {{https://reddit.com}} {{[-f|--follow]}} "{{form(css('form.login-form')[1], {'user': '$your_username', 'passwd': '$your_password'})}}" {{[-e|--extract]}} "{{css('#mail')/@title}}"` diff --git a/pages/common/xkcdpass.md b/pages/common/xkcdpass.md index 65abc9b058..544e88c5df 100644 --- a/pages/common/xkcdpass.md +++ b/pages/common/xkcdpass.md @@ -10,8 +10,8 @@ - Generate one passphrase whose first letters of each word match the provided argument: -`xkcdpass -a {{acrostic}}` +`xkcdpass {{[-a|--acrostic]}} {{acrostic}}` - Generate passwords interactively: -`xkcdpass -i` +`xkcdpass {{[-i|--interactive]}}` diff --git a/pages/common/xmake.md b/pages/common/xmake.md index fdc05dbb8e..0c4e7b0346 100644 --- a/pages/common/xmake.md +++ b/pages/common/xmake.md @@ -5,20 +5,20 @@ - Create an Xmake C project, consisting of a hello world and `xmake.lua`: -`xmake create --language c -P {{project_name}}` +`xmake create {{[-l|--language]}} {{[c|clean]}} {{[-P|--project]}} {{project_name}}` - Build and run an Xmake project: -`xmake build run` +`xmake {{[b|build]}} {{[r|run]}}` - Run a compiled Xmake target directly: -`xmake run {{target_name}}` +`xmake {{[r|run]}} {{target_name}}` - Configure a project's build targets: -`xmake config --plat={{macosx|linux|iphoneos|...}} --arch={{x86_64|i386|arm64|...}} --mode={{debug|release}}` +`xmake {{[f|config]}} {{[-p |--plat=]}}{{macosx|linux|iphoneos|...}} {{[-a |--arch=]}}{{x86_64|i386|arm64|...}} {{[-m |--mode=]}}{{debug|release}}` - Install the compiled target to a directory: -`xmake install -o {{path/to/directory}}` +`xmake {{[i|install]}} {{[-o |--installdir=]}}{{path/to/directory}}` diff --git a/pages/common/xmlto.md b/pages/common/xmlto.md index 834e8573a8..751315ea73 100644 --- a/pages/common/xmlto.md +++ b/pages/common/xmlto.md @@ -1,15 +1,15 @@ # xmlto > Apply an XSL stylesheet to an XML document. -> More information: . +> More information: . - Convert a DocBook XML document to PDF format: -`xmlto {{pdf}} {{document.xml}}` +`xmlto pdf {{document.xml}}` - Convert a DocBook XML document to HTML format and store the resulting files in a separate directory: -`xmlto -o {{path/to/html_files}} {{html}} {{document.xml}}` +`xmlto -o {{path/to/html_files}} html {{document.xml}}` - Convert a DocBook XML document to a single HTML file: diff --git a/pages/common/xxd.md b/pages/common/xxd.md index 3bf94beeea..32fa04f2e0 100644 --- a/pages/common/xxd.md +++ b/pages/common/xxd.md @@ -13,20 +13,20 @@ - Display a more compact output, replacing consecutive zeros (if any) with a star: -`xxd -a {{input_file}}` +`xxd {{[-a|-autoskip]}} {{input_file}}` - Display the output with 10 columns of one octet (byte) each: -`xxd -c {{10}} {{input_file}}` +`xxd {{[-c|-cols]}} {{10}} {{input_file}}` - Display output only up to a length of 32 bytes: -`xxd -l {{32}} {{input_file}}` +`xxd {{[-l|-len]}} {{32}} {{input_file}}` - Display the output in plain mode, without any gaps between the columns: -`xxd -p {{input_file}}` +`xxd {{[-p|-postscript]}} {{input_file}}` - Revert a plaintext hexdump back into binary, and save it as a binary file: -`xxd -r -p {{input_file}} {{output_file}}` +`xxd {{[-r|-revert]}} {{[-p|-postscript]}} {{input_file}} {{output_file}}` diff --git a/pages/common/ya.md b/pages/common/ya.md index 97d2c87710..914728f0aa 100644 --- a/pages/common/ya.md +++ b/pages/common/ya.md @@ -5,11 +5,11 @@ - Add a package: -`ya pack -a {{package}}` +`ya pack {{[-a|--all]}} {{package}}` - Upgrade all packages: -`ya pack -u` +`ya pack {{[-u|--upgrade]}}` - Subscribe to messages from all remote instances: diff --git a/pages/common/yarn.md b/pages/common/yarn.md index f48b6cdb54..043239f544 100644 --- a/pages/common/yarn.md +++ b/pages/common/yarn.md @@ -1,7 +1,7 @@ # yarn > JavaScript and Node.js package manager alternative. -> More information: . +> More information: . - Install a module globally: diff --git a/pages/common/youtube-dl.md b/pages/common/youtube-dl.md index 247b34bad3..489f79c7ce 100644 --- a/pages/common/youtube-dl.md +++ b/pages/common/youtube-dl.md @@ -10,23 +10,23 @@ - List all formats that a video or playlist is available in: -`youtube-dl --list-formats '{{https://www.youtube.com/watch?v=Mwa0_nE9H7A}}'` +`youtube-dl {{[-F|--list-formats]}} '{{https://www.youtube.com/watch?v=Mwa0_nE9H7A}}'` - Download a video or playlist at a specific quality: -`youtube-dl --format "{{best[height<=480]}}" '{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}'` +`youtube-dl {{[-f|--format]}} "{{best[height<=480]}}" '{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}'` - Download the audio from a video and convert it to an MP3: -`youtube-dl -x --audio-format {{mp3}} '{{url}}'` +`youtube-dl {{[-x|--extract-audio]}} --audio-format {{mp3}} '{{url}}'` - Download the best quality audio and video and merge them: -`youtube-dl -f bestvideo+bestaudio '{{url}}'` +`youtube-dl {{[-f|--format]}} bestvideo+bestaudio '{{url}}'` - Download video(s) as MP4 files with custom filenames: -`youtube-dl --format {{mp4}} -o "{{%(playlist_index)s-%(title)s by %(uploader)s on %(upload_date)s in %(playlist)s.%(ext)s}}" '{{url}}'` +`youtube-dl {{[-f|--format]}} {{mp4}} {{[-o|--output]}} "{{%(playlist_index)s-%(title)s by %(uploader)s on %(upload_date)s in %(playlist)s.%(ext)s}}" '{{url}}'` - Download a particular language's subtitles along with the video: @@ -34,4 +34,4 @@ - Download a playlist and extract MP3s from it: -`youtube-dl -f "bestaudio" --continue --no-overwrites --ignore-errors --extract-audio --audio-format mp3 -o "%(title)s.%(ext)s" '{{url_to_playlist}}'` +`youtube-dl {{[-f|--format]}} "bestaudio" {{[-c|--continue]}} {{[-w|--no-overwrites]}} {{[-i|--ignore-errors]}} {{[-x|--extract-audio]}} --audio-format mp3 {{[-o|--output]}} "%(title)s.%(ext)s" '{{url_to_playlist}}'` diff --git a/pages/common/yt-dlp.md b/pages/common/yt-dlp.md index 65fd3e31c2..49df55fe91 100644 --- a/pages/common/yt-dlp.md +++ b/pages/common/yt-dlp.md @@ -11,28 +11,28 @@ - List the available downloadable formats for a video: -`yt-dlp --list-formats "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` +`yt-dlp {{[-F|--list-formats]}} "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` - Download a video or playlist using the best MP4 video available (default is "bv\*+ba/b"): -`yt-dlp --format "{{bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4]}}" "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` +`yt-dlp {{[-f|--format]}} "{{bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4]}}" "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` - Extract audio from a video (requires ffmpeg or ffprobe): -`yt-dlp --extract-audio "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` +`yt-dlp {{[-x|--extract-audio]}} "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` - Specify audio format and audio quality of extracted audio (between 0 (best) and 10 (worst), default = 5): -`yt-dlp --extract-audio --audio-format {{mp3}} --audio-quality {{0}} "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` +`yt-dlp {{[-x|--extract-audio]}} --audio-format {{mp3}} --audio-quality {{0}} "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` - Download only the second, fourth, fifth, sixth, and last items in a playlist (the first item is 1, not 0): -`yt-dlp --playlist-items 2,4:6,-1 "{{https://youtube.com/playlist?list=PLbzoR-pLrL6pTJfLQ3UwtB-3V4fimdqnA}}"` +`yt-dlp {{[-I|--playlist-items]}} 2,4:6,-1 "{{https://youtube.com/playlist?list=PLbzoR-pLrL6pTJfLQ3UwtB-3V4fimdqnA}}"` - Download all playlists of a YouTube channel/user keeping each playlist in a separate directory: -`yt-dlp -o "{{%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s}}" "{{https://www.youtube.com/user/TheLinuxFoundation/playlists}}"` +`yt-dlp {{[-o|--output]}} "{{%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s}}" "{{https://www.youtube.com/user/TheLinuxFoundation/playlists}}"` - Download a Udemy course keeping each chapter in a separate directory: -`yt-dlp -u {{user}} -p {{password}} -P "{{path/to/directory}}" -o "{{%(playlist)s/%(chapter_number)s - %(chapter)s/%(title)s.%(ext)s}}" "{{https://www.udemy.com/java-tutorial}}"` +`yt-dlp {{[-u|--username]}} {{user}} {{[-p|--password]}} {{password}} {{[-P|--paths]}} "{{path/to/directory}}" {{[-o|--output]}} "{{%(playlist)s/%(chapter_number)s - %(chapter)s/%(title)s.%(ext)s}}" "{{https://www.udemy.com/java-tutorial}}"` diff --git a/pages/common/zgrep.md b/pages/common/zgrep.md index a674808986..7eae873a23 100644 --- a/pages/common/zgrep.md +++ b/pages/common/zgrep.md @@ -9,24 +9,24 @@ - Grep a pattern in a compressed file (case-insensitive): -`zgrep -i {{pattern}} {{path/to/compressed/file}}` +`zgrep {{[-i|--ignore-case]}} {{pattern}} {{path/to/compressed/file}}` - Output count of lines containing matched pattern in a compressed file: -`zgrep -c {{pattern}} {{path/to/compressed/file}}` +`zgrep {{[-c|--count]}} {{pattern}} {{path/to/compressed/file}}` - Display the lines which don’t have the pattern present (Invert the search function): -`zgrep -v {{pattern}} {{path/to/compressed/file}}` +`zgrep {{[-v|--invert-match]}} {{pattern}} {{path/to/compressed/file}}` - Grep a compressed file for multiple patterns: -`zgrep -e "{{pattern_1}}" -e "{{pattern_2}}" {{path/to/compressed/file}}` +`zgrep {{[-e|--regexp]}} "{{pattern_1}}" {{[-e|--regexp]}} "{{pattern_2}}" {{path/to/compressed/file}}` - Use extended regular expressions (supporting `?`, `+`, `{}`, `()` and `|`): -`zgrep -E {{regular_expression}} {{path/to/file}}` +`zgrep {{[-E|--extended-regexp]}} {{regular_expression}} {{path/to/file}}` - Print 3 lines of [C]ontext around, [B]efore, or [A]fter each match: -`zgrep -{{C|B|A}} {{3}} {{pattern}} {{path/to/compressed/file}}` +`zgrep --{{context|before-context|after-context}} {{3}} {{pattern}} {{path/to/compressed/file}}` diff --git a/pages/common/zipgrep.md b/pages/common/zipgrep.md index db197b04ba..b7f87c14b6 100644 --- a/pages/common/zipgrep.md +++ b/pages/common/zipgrep.md @@ -9,11 +9,11 @@ - Print file name and line number for each match: -`zipgrep -H -n "{{search_pattern}}" {{path/to/file.zip}}` +`zipgrep {{[-H|--with-filename]}} {{[-n|--line-number]}} "{{search_pattern}}" {{path/to/file.zip}}` - Search for lines that do not match a pattern: -`zipgrep -v "{{search_pattern}}" {{path/to/file.zip}}` +`zipgrep {{[-v|--invert-match]}} "{{search_pattern}}" {{path/to/file.zip}}` - Specify files inside a Zip archive from search: @@ -21,4 +21,4 @@ - Exclude files inside a Zip archive from search: -`zipgrep "{{search_pattern}}" {{path/to/file.zip}} -x {{file/to/exclude1}} {{file/to/exclude2}}` +`zipgrep "{{search_pattern}}" {{path/to/file.zip}} {{[-x|--line-regexp]}} {{file/to/exclude1}} {{file/to/exclude2}}` diff --git a/pages/common/zmap.md b/pages/common/zmap.md index 58053c759d..9fbd83afc8 100644 --- a/pages/common/zmap.md +++ b/pages/common/zmap.md @@ -1,15 +1,15 @@ # zmap > Fast, open-source network scanner for Internet-wide surveys. -> More information: . +> More information: . - Scan a subnet or full IPv4 space for a specific TCP port (default: 80): -`zmap {{SUBNETS}} -p {{port}}` +`zmap {{SUBNETS}} {{[-p|--target-ports]}} {{port}}` - Scan specific ports or port ranges across a subnet: -`zmap {{--target-ports}} {{port1,port2-port3,...}} {{SUBNETS}}` +`zmap {{[-p|--target-ports]}} {{port1,port2-port3,...}} {{SUBNETS}}` - Output results to a CSV file with custom fields: diff --git a/pages/common/zopflipng.md b/pages/common/zopflipng.md index 0f535b8be7..3a165eb4f6 100644 --- a/pages/common/zopflipng.md +++ b/pages/common/zopflipng.md @@ -9,4 +9,4 @@ - Optimize several PNGs and save with given prefix: -`zopflipng --prefix={{prefix}} {{image1.png}} {{image2.png}} {{image3.png}}` +`zopflipng --prefix={{prefix}} {{image1.png image2.png image3.png ...}}` diff --git a/pages/common/{.md b/pages/common/{.md index ea75bf4fe0..db7da72f9f 100644 --- a/pages/common/{.md +++ b/pages/common/{.md @@ -31,6 +31,6 @@ `echo ${!variable}` -- Capitalize all the characters: +- Group command output together: -`echo ${variable^^}` +`{ {{command1; command2; ...}} } | {{another_command}}` diff --git a/pages/linux/abrt-cli.md b/pages/linux/abrt-cli.md new file mode 100644 index 0000000000..129b11fc44 --- /dev/null +++ b/pages/linux/abrt-cli.md @@ -0,0 +1,29 @@ +# abrt-cli + +> Automatic Bug Reporting Tool for Fedora-based systems. +> Used to detect, analyze, and report application crashes. +> More information: . + +- List detected problems: + +`abrt-cli list` + +- Show details of a specific problem: + +`abrt-cli info {{problem_id}}` + +- Remove a crash report: + +`abrt-cli remove {{problem_id}}` + +- Report a problem to the configured bug tracker (e.g. Bugzilla): + +`abrt-cli report {{problem_id}}` + +- Monitor a log file and trigger a program when a match is found: + +`abrt-watch-log -F {{error_string}} {{/var/log/myapp.log}} {{notify-send "Crash detected"}}` + +- Generate a report for debugging manually: + +`abrt-cli report --analyze {{problem_id}}` diff --git a/pages/linux/abrt.md b/pages/linux/abrt.md new file mode 100644 index 0000000000..33e7e6ca10 --- /dev/null +++ b/pages/linux/abrt.md @@ -0,0 +1,7 @@ +# abrt + +> This command is an alias of `abrt-cli`. + +- View documentation for the original command: + +`tldr abrt-cli` diff --git a/pages/linux/acpi.md b/pages/linux/acpi.md index 992f982518..6ca771b167 100644 --- a/pages/linux/acpi.md +++ b/pages/linux/acpi.md @@ -1,7 +1,7 @@ # acpi > Shows battery status or thermal information. -> More information: . +> More information: . - Show battery information: @@ -9,20 +9,20 @@ - Show thermal information: -`acpi -t` +`acpi {{[-t|--thermal]}}` - Show cooling device information: -`acpi -c` +`acpi {{[-c|--cooling]}}` - Show thermal information in Fahrenheit: -`acpi -tf` +`acpi {{[-tf|--thermal --fahrenheit]}}` - Show all information: -`acpi -V` +`acpi {{[-V|--everything]}}` - Extract information from `/proc` instead of `/sys`: -`acpi -p` +`acpi {{[-p|--proc]}}` diff --git a/pages/linux/apt-key.md b/pages/linux/apt-key.md index e530a8476f..4946bdbdbf 100644 --- a/pages/linux/apt-key.md +++ b/pages/linux/apt-key.md @@ -18,7 +18,7 @@ - Add a remote key to the trusted keystore: -`wget -qO - {{https://host.tld/filename.key}} | apt-key add -` +`wget {{[-qO|--quiet --output-document]}} - {{https://host.tld/filename.key}} | apt-key add -` - Add a key from keyserver with only key ID: diff --git a/pages/linux/apt.md b/pages/linux/apt.md index b45d5b9926..64c28b56f9 100644 --- a/pages/linux/apt.md +++ b/pages/linux/apt.md @@ -9,7 +9,7 @@ `sudo apt update` -- Search for a given package (use `apt search -n package` to search within package name only): +- Search for a given package (use `apt search --name-only package` to search within package name only): `apt search {{package}}` @@ -35,4 +35,4 @@ - List installed packages: -`apt list --installed` +`apt list {{[-i|--installed]}}` diff --git a/pages/linux/arecord.md b/pages/linux/arecord.md index 71b2e749a6..ed5468b908 100644 --- a/pages/linux/arecord.md +++ b/pages/linux/arecord.md @@ -5,24 +5,24 @@ - Record a snippet in "CD" quality (finish with `` when done): -`arecord -vv --format=cd {{path/to/file.wav}}` +`arecord {{[-vv|--verbose --verbose]}} {{[-f|--format]}} cd {{path/to/file.wav}}` - Record a snippet in "CD" quality, with a fixed duration of 10 seconds: -`arecord -vv --format=cd --duration={{10}} {{path/to/file.wav}}` +`arecord {{[-vv|--verbose --verbose]}} {{[-f|--format]}} cd {{[-d|--duration]}} {{10}} {{path/to/file.wav}}` - Record a snippet and save it as an MP3 (finish with `` when done): -`arecord -vv --format=cd --file-type raw | lame -r - {{path/to/file.mp3}}` +`arecord {{[-vv|--verbose --verbose]}} {{[-f|--format]}} cd {{[-t|--file-type]}} raw | lame -r - {{path/to/file.mp3}}` - List all sound cards and digital audio devices: -`arecord --list-devices` +`arecord {{[-l|--list-devices]}}` - Allow interactive interface (e.g. use `` or `` to play or pause): -`arecord --interactive` +`arecord {{[-i|--interactive]}}` - Test your microphone by recording a 5 second sample and playing it back: -`arecord -d 5 test-mic.wav && aplay test-mic.wav && rm test-mic.wav` +`arecord {{[-d|--duration]}} 5 test-mic.wav && aplay test-mic.wav && rm test-mic.wav` diff --git a/pages/linux/arptables.md b/pages/linux/arptables.md new file mode 100644 index 0000000000..73f6a01603 --- /dev/null +++ b/pages/linux/arptables.md @@ -0,0 +1,29 @@ +# arptables + +> Manage ARP filtering rules using the `nftables` backend. +> Part of the `xtables-nft` suite for ARP packet filtering. +> More information: . + +- List all ARP rules in the filter table: + +`sudo arptables {{[-L|--list]}}` + +- Append a rule to drop ARP packets from a specific IP address: + +`sudo arptables {{[-A|--append]}} INPUT {{[-s|--source-ip]}} {{192.168.0.1}} {{[-j|--jump]}} DROP` + +- Delete a specific rule from the INPUT chain by its rule number: + +`sudo arptables {{[-D|--delete]}} INPUT {{rule_number}}` + +- Flush all rules in the filter table: + +`sudo arptables {{[-F|--flush]}}` + +- Set the default policy of the OUTPUT chain to ACCEPT: + +`sudo arptables {{[-P|--policy]}} OUTPUT ACCEPT` + +- Save the current ARP rules to a file: + +`sudo arptables-save > {{path/to/file}}` diff --git a/pages/linux/audit2allow.md b/pages/linux/audit2allow.md index 932dcb8786..60731054f1 100644 --- a/pages/linux/audit2allow.md +++ b/pages/linux/audit2allow.md @@ -6,7 +6,7 @@ - Generate a local policy to allow access for all denied services: -`sudo audit2allow --all -M {{local_policy_name}}` +`sudo audit2allow {{[-a|--all]}} -M {{local_policy_name}}` - Generate a local policy module to grant access to a specific process/service/command from the audit logs: @@ -18,4 +18,4 @@ - Install a local policy module: -`sudo semodule -i {{local_policy_name}}.pp` +`sudo semodule {{[-i|--install]}} {{local_policy_name}}.pp` diff --git a/pages/linux/beep.md b/pages/linux/beep.md index 12993b3c07..44fc58e786 100644 --- a/pages/linux/beep.md +++ b/pages/linux/beep.md @@ -17,8 +17,8 @@ - Play each new frequency and duration as a distinct beep: -`beep -f {{frequency}} -l {{duration}} -n -f {{frequency}} -l {{duration}}` +`beep -f {{frequency}} -l {{duration}} {{[-n|--new]}} -f {{frequency}} -l {{duration}}` - Play the C major scale: -`beep -f {{262}} -n -f {{294}} -n -f {{330}} -n -f {{349}} -n -f {{392}} -n -f {{440}} -n -f {{494}} -n -f {{523}}` +`beep -f {{262}} {{[-n|--new]}} -f {{294}} {{[-n|--new]}} -f {{330}} {{[-n|--new]}} -f {{349}} {{[-n|--new]}} -f {{392}} {{[-n|--new]}} -f {{440}} {{[-n|--new]}} -f {{494}} {{[-n|--new]}} -f {{523}}` diff --git a/pages/linux/betterlockscreen.md b/pages/linux/betterlockscreen.md index 31f216f5da..8d0bb31591 100644 --- a/pages/linux/betterlockscreen.md +++ b/pages/linux/betterlockscreen.md @@ -5,16 +5,16 @@ - Lock the screen: -`betterlockscreen --lock` +`betterlockscreen {{[-l|--lock]}}` - Change the lock screen background: -`betterlockscreen -u {{path/to/image.png}}` +`betterlockscreen {{[-u|--update]}} {{path/to/image.png}}` - Lock the screen, showing some custom text: -`betterlockscreen -l pixel -t "{{custom lock screen text}}"` +`betterlockscreen {{[-l|--lock]}} pixel --text "{{custom lock screen text}}"` - Lock the screen, with a custom monitor off timeout in seconds: -`betterlockscreen --off {{5}} -l` +`betterlockscreen --off {{5}} {{[-l|--lock]}}` diff --git a/pages/linux/blight.md b/pages/linux/blight.md index 002cf38272..927e60594f 100644 --- a/pages/linux/blight.md +++ b/pages/linux/blight.md @@ -5,7 +5,7 @@ - Set display brightness to 50%: -`blight set {{50}} -r` +`blight set {{50}} {{[-r|--relative]}}` - Show current display brightness: @@ -17,7 +17,7 @@ - Increase display brightness in %: -`blight inc {{number}} -r` +`blight inc {{number}} {{[-r|--relative]}}` - Decrease display brightness with internal units: diff --git a/pages/linux/bmon.md b/pages/linux/bmon.md index 81a66431d7..b1fe17bc3b 100644 --- a/pages/linux/bmon.md +++ b/pages/linux/bmon.md @@ -5,16 +5,16 @@ - Display the list of all the interfaces: -`bmon -a` +`bmon {{[-a|--show-all]}}` - Display data transfer rates in bits per second: -`bmon -b` +`bmon {{[-b|--use-bit]}}` - Specify the policy to define which network interface(s) is/are displayed: -`bmon -p {{interface_1,interface_2,interface_3}}` +`bmon {{[-p|--policy]}} {{interface_1,interface_2,interface_3}}` - Specify the interval (in seconds) in which rate per counter is calculated: -`bmon -R {{2.0}}` +`bmon {{[-R|--rate-interval]}} {{2.0}}` diff --git a/pages/linux/btrfs-filesystem.md b/pages/linux/btrfs-filesystem.md index 66f2f04c75..8bd906c362 100644 --- a/pages/linux/btrfs-filesystem.md +++ b/pages/linux/btrfs-filesystem.md @@ -13,11 +13,11 @@ - Defragment a single file on a btrfs filesystem (avoid while a deduplication agent is running): -`sudo btrfs filesystem defragment -v {{path/to/file}}` +`sudo btrfs filesystem defragment {{[-v|--verbose]}} {{path/to/file}}` - Defragment a directory recursively (does not cross subvolume boundaries): -`sudo btrfs filesystem defragment -v -r {{path/to/directory}}` +`sudo btrfs filesystem defragment {{[-v|--verbose]}} -r {{path/to/directory}}` - Force syncing unwritten data blocks to disk(s): @@ -25,4 +25,4 @@ - Summarize disk usage for the files in a directory recursively: -`sudo btrfs filesystem du --summarize {{path/to/directory}}` +`sudo btrfs filesystem du {{[-s|--summarize]}} {{path/to/directory}}` diff --git a/pages/linux/btrfs-restore.md b/pages/linux/btrfs-restore.md index 46e8fb9038..0f513542f0 100644 --- a/pages/linux/btrfs-restore.md +++ b/pages/linux/btrfs-restore.md @@ -9,16 +9,16 @@ - List (don't write) files to be restored from a btrfs filesystem: -`sudo btrfs restore --dry-run {{path/to/btrfs_device}} {{path/to/target_directory}}` +`sudo btrfs restore {{[-D|--dry-run]}} {{path/to/btrfs_device}} {{path/to/target_directory}}` - Restore files matching a given regex ([c]ase-insensitive) files to be restored from a btrfs filesystem (all parent directories of target file(s) must match as well): `sudo btrfs restore --path-regex {{regex}} -c {{path/to/btrfs_device}} {{path/to/target_directory}}` -- Restore files from a btrfs filesystem using a specific root tree `bytenr` (see `btrfs-find-root`): +- Restore files from a btrfs filesystem using a specific root [t]ree `bytenr` (see `btrfs-find-root`): `sudo btrfs restore -t {{bytenr}} {{path/to/btrfs_device}} {{path/to/target_directory}}` - Restore files from a btrfs filesystem (along with metadata, extended attributes, and Symlinks), overwriting files in the target: -`sudo btrfs restore --metadata --xattr --symlinks --overwrite {{path/to/btrfs_device}} {{path/to/target_directory}}` +`sudo btrfs restore {{[-m|--metadata]}} {{[-x|--xattr]}} {{[-S|--symlinks]}} {{[-o|--overwrite]}} {{path/to/btrfs_device}} {{path/to/target_directory}}` diff --git a/pages/linux/btrfs-scrub.md b/pages/linux/btrfs-scrub.md index a5b354b0f0..c75882f82c 100644 --- a/pages/linux/btrfs-scrub.md +++ b/pages/linux/btrfs-scrub.md @@ -26,4 +26,4 @@ - Start a scrub in quiet mode (does not print errors or statistics): -`sudo btrfs scrub start -q {{path/to/btrfs_mount}}` +`sudo btrfs scrub start {{[-q|--quiet]}} {{path/to/btrfs_mount}}` diff --git a/pages/linux/cacaclock.md b/pages/linux/cacaclock.md index 4f7f793520..d54f8178ea 100644 --- a/pages/linux/cacaclock.md +++ b/pages/linux/cacaclock.md @@ -9,8 +9,8 @@ - Change the font: -`cacaclock -f {{font}}` +`cacaclock {{[-f|--font]}} {{font}}` - Change the format using an `strftime` format specification: -`cacaclock -d {{strftime_arguments}}` +`cacaclock {{[-d|--dateformat]}} {{strftime_arguments}}` diff --git a/pages/linux/caligula.md b/pages/linux/caligula.md new file mode 100644 index 0000000000..43212f371b --- /dev/null +++ b/pages/linux/caligula.md @@ -0,0 +1,12 @@ +# caligula + +> A user-friendly, lightweight TUI for disk imaging. +> More information: . + +- Flash an ISO to a drive: + +`caligula burn {{path/to/image.iso}}` + +- Flash an ISO to a drive without entering the hash interactively: + +`caligula burn {{path/to/image.iso}} {{[s|--hash]}} {{hash}}` diff --git a/pages/linux/certbot.md b/pages/linux/certbot.md index 291f56530e..5ddf7306bb 100644 --- a/pages/linux/certbot.md +++ b/pages/linux/certbot.md @@ -2,19 +2,19 @@ > The Let's Encrypt Agent for automatically obtaining and renewing TLS certificates. > Successor to `letsencrypt`. -> More information: . +> More information: . - Obtain a new certificate via webroot authorization, but do not install it automatically: -`sudo certbot certonly --webroot --webroot-path {{path/to/webroot}} --domain {{subdomain.example.com}}` +`sudo certbot certonly --webroot {{[-w|--webroot-path]}} {{path/to/webroot}} {{[-d|--domain]}} {{subdomain.example.com}}` - Obtain a new certificate via nginx authorization, installing the new certificate automatically: -`sudo certbot --nginx --domain {{subdomain.example.com}}` +`sudo certbot --nginx {{[-d|--domain]}} {{subdomain.example.com}}` - Obtain a new certificate via apache authorization, installing the new certificate automatically: -`sudo certbot --apache --domain {{subdomain.example.com}}` +`sudo certbot --apache {{[-d|--domain]}} {{subdomain.example.com}}` - Renew all Let's Encrypt certificates that expire in 30 days or less (don't forget to restart any servers that use them afterwards): @@ -22,8 +22,8 @@ - Simulate the obtaining of a new certificate, but don't actually save any new certificates to disk: -`sudo certbot --webroot --webroot-path {{path/to/webroot}} --domain {{subdomain.example.com}} --dry-run` +`sudo certbot --webroot {{[-w|--webroot-path]}} {{path/to/webroot}} {{[-d|--domain]}} {{subdomain.example.com}} --dry-run` - Obtain an untrusted test certificate instead: -`sudo certbot --webroot --webroot-path {{path/to/webroot}} --domain {{subdomain.example.com}} --test-cert` +`sudo certbot --webroot {{[-w|--webroot-path]}} {{path/to/webroot}} {{[-d|--domain]}} {{subdomain.example.com}} --test-cert` diff --git a/pages/linux/cewl.md b/pages/linux/cewl.md index 5e97adb7df..cb01033ee3 100644 --- a/pages/linux/cewl.md +++ b/pages/linux/cewl.md @@ -1,19 +1,19 @@ # cewl > URL spidering tool for making a cracking wordlist from web content. -> More information: . +> More information: . - Create a wordlist file from the given URL up to 2 links depth: -`cewl --depth {{2}} --write {{path/to/wordlist.txt}} {{url}}` +`cewl {{[-d|--depth]}} 2 {{[-w|--write]}} {{path/to/wordlist.txt}} {{url}}` - Output an alphanumeric wordlist from the given URL with words of minimum 5 characters: -`cewl --with-numbers --min_word_length {{5}} {{url}}` +`cewl --with-numbers {{[-m|--min_word_length]}} 5 {{url}}` - Output a wordlist from the given URL in debug mode including email addresses: -`cewl --debug --email {{url}}` +`cewl --debug {{[-e|--email]}} {{url}}` - Output a wordlist from the given URL using HTTP Basic or Digest authentication: diff --git a/pages/linux/chage.md b/pages/linux/chage.md index 99c44befea..7eeed65195 100644 --- a/pages/linux/chage.md +++ b/pages/linux/chage.md @@ -5,7 +5,7 @@ - List password information for the user: -`chage {{[-l|--list]]} {{username}}` +`chage {{[-l|--list]}} {{username}}` - Enable password expiration in 10 days: diff --git a/pages/linux/compsize.md b/pages/linux/compsize.md index 95a758b720..acd558897d 100644 --- a/pages/linux/compsize.md +++ b/pages/linux/compsize.md @@ -2,7 +2,7 @@ > Calculate the compression ratio of a set of files on a btrfs filesystem. > See also `btrfs filesystem` for recompressing a file by defragmenting it. -> More information: . +> More information: . - Calculate the current compression ratio for a file or directory: @@ -10,8 +10,8 @@ - Don't traverse filesystem boundaries: -`sudo compsize --one-file-system {{path/to/file_or_directory}}` +`sudo compsize {{[-x|--one-file-system]}} {{path/to/file_or_directory}}` - Show raw byte counts instead of human-readable sizes: -`sudo compsize --bytes {{path/to/file_or_directory}}` +`sudo compsize {{[-b|--bytes]}} {{path/to/file_or_directory}}` diff --git a/pages/linux/conky.md b/pages/linux/conky.md index 7afb00eb98..3a7a69e1f4 100644 --- a/pages/linux/conky.md +++ b/pages/linux/conky.md @@ -9,20 +9,20 @@ - Create a new default config: -`conky -C > ~/.conkyrc` +`conky {{[-C|--print-config]}} > ~/.conkyrc` - Launch Conky with a given configuration file: -`conky -c {{path/to/config}}` +`conky {{[-c|--config]}} {{path/to/config}}` - Start in the background (daemonize): -`conky -d` +`conky {{[-d|--daemonize]}}` - Align Conky on the desktop: -`conky -a {{top|bottom|middle}}_{{left|right|middle}}` +`conky {{[-a|--alignment]}} {{top|bottom|middle}}_{{left|right|middle}}` - Pause for 5 seconds at startup before launching: -`conky -p {{5}}` +`conky {{[-p|--pause]}} {{5}}` diff --git a/pages/linux/conntrack.md b/pages/linux/conntrack.md index 603fd4895a..4f9026aec8 100644 --- a/pages/linux/conntrack.md +++ b/pages/linux/conntrack.md @@ -6,20 +6,20 @@ - List all currently tracked connections: -`conntrack --dump` +`conntrack {{[-L|--dump]}}` - Display a real-time event log of connection changes: -`conntrack --event` +`conntrack {{[-E|--event]}}` - Display a real-time event log of connection changes and associated timestamps: -`conntrack --event -o timestamp` +`conntrack {{[-E|--event]}} {{[-o|--output]}} timestamp` - Display a real-time event log of connection changes for a specific IP address: -`conntrack --event --orig-src {{ip_address}}` +`conntrack {{[-E|--event]}} {{[-s|--orig-src]}} {{ip_address}}` - Delete all flows for a specific source IP address: -`conntrack --delete --orig-src {{ip_address}}` +`conntrack {{[-D|--delete]}} {{[-s|--orig-src]}} {{ip_address}}` diff --git a/pages/linux/cpufreq-aperf.md b/pages/linux/cpufreq-aperf.md index e7f1a010c2..a8bccaac41 100644 --- a/pages/linux/cpufreq-aperf.md +++ b/pages/linux/cpufreq-aperf.md @@ -10,12 +10,12 @@ - Start calculating for CPU 1 only: -`sudo cpufreq-aperf -c {{1}}` +`sudo cpufreq-aperf {{[-c|--cpu]}} {{1}}` - Start calculating with a 3 second refresh interval for all CPU cores: -`sudo cpufreq-aperf -i {{3}}` +`sudo cpufreq-aperf {{[-i|--interval]}} {{3}}` - Calculate only once: -`sudo cpufreq-aperf -o` +`sudo cpufreq-aperf {{[-o|--once]}}` diff --git a/pages/linux/cpufreq-info.md b/pages/linux/cpufreq-info.md index 512316a60b..a03e066e7e 100644 --- a/pages/linux/cpufreq-info.md +++ b/pages/linux/cpufreq-info.md @@ -9,24 +9,24 @@ - Show CPU frequency information for the specified CPU: -`cpufreq-info -c {{cpu_number}}` +`cpufreq-info {{[-c|--cpu]}} {{cpu_number}}` - Show the allowed minimum and maximum CPU frequency: -`cpufreq-info -l` +`cpufreq-info {{[-l|--hwlimits]}}` - Show the current minimum and maximum CPU frequency and policy in table format: -`cpufreq-info -o` +`cpufreq-info {{[-o|--proc]}}` - Show available CPU frequency policies: -`cpufreq-info -g` +`cpufreq-info {{[-g|--governors]}}` - Show current CPU work frequency in a human-readable format, according to the cpufreq kernel module: -`cpufreq-info -f -m` +`cpufreq-info {{[-f|--freq]}} {{[-m|--human]}}` - Show current CPU work frequency in a human-readable format, by reading it from hardware (only available to root): -`sudo cpufreq-info -w -m` +`sudo cpufreq-info {{[-w|--hwfreq]}} {{[-m|--human]}}` diff --git a/pages/linux/cpufreq-set.md b/pages/linux/cpufreq-set.md index 4c4c1ee2f6..6ce3b581f7 100644 --- a/pages/linux/cpufreq-set.md +++ b/pages/linux/cpufreq-set.md @@ -6,16 +6,16 @@ - Set the CPU frequency policy of CPU 1 to "userspace": -`sudo cpufreq-set -c {{1}} -g {{userspace}}` +`sudo cpufreq-set {{[-c|--cpu]}} {{1}} {{[-g|--governor]}} {{userspace}}` - Set the current minimum CPU frequency of CPU 1: -`sudo cpufreq-set -c {{1}} --min {{min_frequency}}` +`sudo cpufreq-set {{[-c|--cpu]}} {{1}} {{[-d|--min]}} {{min_frequency}}` - Set the current maximum CPU frequency of CPU 1: -`sudo cpufreq-set -c {{1}} --max {{max_frequency}}` +`sudo cpufreq-set {{[-c|--cpu]}} {{1}} {{[-u|--max]}} {{max_frequency}}` - Set the current work frequency of CPU 1: -`sudo cpufreq-set -c {{1}} -f {{work_frequency}}` +`sudo cpufreq-set {{[-c|--cpu]}} {{1}} {{[-f|--freq]}} {{work_frequency}}` diff --git a/pages/linux/cpuid.md b/pages/linux/cpuid.md index 9fd0167455..b8cb98e89f 100644 --- a/pages/linux/cpuid.md +++ b/pages/linux/cpuid.md @@ -1,7 +1,7 @@ # cpuid > Display detailed information about all CPUs. -> More information: . +> More information: . - Display information for all CPUs: @@ -9,8 +9,8 @@ - Display information only for the current CPU: -`cpuid -1` +`cpuid {{[-1|--one-cpu]}}` - Display raw hex information with no decoding: -`cpuid -r` +`cpuid {{[-r|--raw]}}` diff --git a/pages/linux/createrepo.md b/pages/linux/createrepo.md index 8b53691d1f..8d32d932c9 100644 --- a/pages/linux/createrepo.md +++ b/pages/linux/createrepo.md @@ -9,8 +9,8 @@ - Initialize a repository, exclude test RPMs and display verbose logs: -`createrepo -v -x {{test_*.rpm}} {{path/to/directory}}` +`createrepo {{[-v|--verbose]}} {{[-x|--excludes]}} {{test_*.rpm}} {{path/to/directory}}` - Initialize a repository, using SHA1 as the checksum algorithm, and ignoring symbolic links: -`createrepo -S -s {{sha1}} {{path/to/directory}}` +`createrepo {{[-S|--skip-symlinks]}} {{[-s|--checksum]}} {{sha1}} {{path/to/directory}}` diff --git a/pages/linux/dd.md b/pages/linux/dd.md index 05f6589717..ab483df0c3 100644 --- a/pages/linux/dd.md +++ b/pages/linux/dd.md @@ -25,4 +25,4 @@ - Check the progress of an ongoing `dd` operation (run this command from another shell): -`kill -USR1 $(pgrep -x dd)` +`kill -USR1 $(pgrep {{[-x|--exact]}} dd)` diff --git a/pages/linux/ddcutil.md b/pages/linux/ddcutil.md index cece71b376..1a531340ff 100644 --- a/pages/linux/ddcutil.md +++ b/pages/linux/ddcutil.md @@ -10,12 +10,12 @@ - Change the brightness (option 0x10) of display 1 to 50%: -`ddcutil --display {{1}} setvcp {{10}} {{50}}` +`ddcutil {{[-d|--display]}} {{1}} setvcp {{10}} {{50}}` - Increase the contrast (option 0x12) of display 1 by 5%: -`ddcutil -d {{1}} setvcp {{12}} {{+}} {{5}}` +`ddcutil {{[-d|--display]}} {{1}} setvcp {{12}} {{+}} {{5}}` - Read the settings of display 1: -`ddcutil -d {{1}} getvcp {{ALL}}` +`ddcutil {{[-d|--display]}} {{1}} getvcp {{ALL}}` diff --git a/pages/linux/dex.md b/pages/linux/dex.md index 2cf6fde3ae..749f208ea0 100644 --- a/pages/linux/dex.md +++ b/pages/linux/dex.md @@ -5,27 +5,27 @@ - Execute all programs in the autostart folders: -`dex --autostart` +`dex {{[-a|--autostart]}}` - Execute all programs in the specified folders: -`dex --autostart --search-paths {{path/to/directory1}}:{{path/to/directory2}}:{{path/to/directory3}}:` +`dex {{[-a|--autostart]} {{[-s|--search-paths]}} {{path/to/directory1}}:{{path/to/directory2}}:{{path/to/directory3}}:` - Preview the programs would be executed in a GNOME specific autostart: -`dex --autostart --environment {{GNOME}}` +`dex {{[-a|--autostart]} {{[-e|--environment]}} {{GNOME}}` - Preview the programs would be executed in a regular autostart: -`dex --autostart --dry-run` +`dex {{[-a|--autostart]} {{[-d|--dry-run]}}` - Preview the value of the DesktopEntry property `Name`: -`dex --property {{Name}} {{path/to/file.desktop}}` +`dex {{[-p|--property]}} {{Name}} {{path/to/file.desktop}}` - Create a DesktopEntry for a program in the current directory: -`dex --create {{path/to/file.desktop}}` +`dex {{[-c|--create]}} {{path/to/file.desktop}}` - Execute a single program (with `Terminal=true` in the desktop file) in the given terminal: diff --git a/pages/linux/dget.md b/pages/linux/dget.md index 4a12cde85b..4d4a5c8301 100644 --- a/pages/linux/dget.md +++ b/pages/linux/dget.md @@ -13,4 +13,4 @@ - Download a package source tarball from its `.dsc` file but don't extract it: -`dget -d {{http://deb.debian.org/debian/pool/main/h/haskell-tldr/haskell-tldr_0.4.0-2.dsc}}` +`dget {{[-d|--download-only]}} {{http://deb.debian.org/debian/pool/main/h/haskell-tldr/haskell-tldr_0.4.0-2.dsc}}` diff --git a/pages/linux/dirb.md b/pages/linux/dirb.md index 9a6184f4d9..3c13b4d369 100644 --- a/pages/linux/dirb.md +++ b/pages/linux/dirb.md @@ -1,7 +1,7 @@ # dirb > Scan HTTP-based webservers for directories and files. -> More information: . +> More information: . - Scan a webserver using the default wordlist: diff --git a/pages/linux/distrobox-create.md b/pages/linux/distrobox-create.md index 318aff47fb..4d5a3aad33 100644 --- a/pages/linux/distrobox-create.md +++ b/pages/linux/distrobox-create.md @@ -6,8 +6,8 @@ - Create a Distrobox container using the Ubuntu image: -`distrobox-create {{container_name}} --image {{ubuntu:latest}}` +`distrobox-create {{container_name}} {{[-i|--image]}} {{ubuntu:latest}}` - Clone a Distrobox container: -`distrobox-create --clone {{container_name}} {{cloned_container_name}}` +`distrobox-create {{[-c|--clone]}} {{container_name}} {{cloned_container_name}}` diff --git a/pages/linux/distrobox-enter.md b/pages/linux/distrobox-enter.md index 626ddcb6db..dbd0c63313 100644 --- a/pages/linux/distrobox-enter.md +++ b/pages/linux/distrobox-enter.md @@ -14,4 +14,4 @@ - Enter a Distrobox container without instantiating a tty: -`distrobox-enter --name {{container_name}} -- {{uptime -p}}` +`distrobox-enter {{[-n|--name]}} {{container_name}} -- {{uptime --pretty}}` diff --git a/pages/linux/distrobox-export.md b/pages/linux/distrobox-export.md index 2a62445dfd..85f0474fc4 100644 --- a/pages/linux/distrobox-export.md +++ b/pages/linux/distrobox-export.md @@ -5,20 +5,20 @@ - Export an app from the container to the host (the desktop entry/icon will show up in your host system's application list): -`distrobox-export --app {{package}} --extra-flags "--foreground"` +`distrobox-export {{[-a|--app]}} {{package}} {{[-ef|--extra-flags]}} "--foreground"` - Export a binary from the container to the host: -`distrobox-export --bin {{path/to/binary}} --export-path {{path/to/binary_on_host}}` +`distrobox-export {{[-b|--bin]}} {{path/to/binary}} {{[-ep|--export-path]}} {{path/to/binary_on_host}}` - Export a binary from the container to the host (i.e.`$HOME/.local/bin`) : -`distrobox-export --bin {{path/to/binary}} --export-path {{path/to/export}}` +`distrobox-export {{[-b|--bin]}} {{path/to/binary}} {{[-ep|--export-path]}} {{path/to/export}}` - Export a service from the container to the host (`--sudo` will run the service as root inside the container): -`distrobox-export --service {{package}} --extra-flags "--allow-newer-config" --sudo` +`distrobox-export --service {{package}} {{[-ef|--extra-flags]}} "--allow-newer-config" {{[-S|--sudo]}}` - Unexport/delete an exported application: -`distrobox-export --app {{package}} --delete` +`distrobox-export {{[-a|--app]}} {{package}} {{[-d|--delete]}}` diff --git a/pages/linux/distrobox-list.md b/pages/linux/distrobox-list.md index 5fd88840ed..470ad920b2 100644 --- a/pages/linux/distrobox-list.md +++ b/pages/linux/distrobox-list.md @@ -10,4 +10,4 @@ - List all Distrobox containers with verbose information: -`distrobox-list --verbose` +`distrobox-list {{[-v|--verbose]}}` diff --git a/pages/linux/distrobox-rm.md b/pages/linux/distrobox-rm.md index 481f0a550f..762a0d347f 100644 --- a/pages/linux/distrobox-rm.md +++ b/pages/linux/distrobox-rm.md @@ -9,4 +9,4 @@ - Remove a Distrobox container forcefully: -`distrobox-rm {{container_name}} --force` +`distrobox-rm {{container_name}} {{[-f|--force]}}` diff --git a/pages/linux/distrobox-stop.md b/pages/linux/distrobox-stop.md index 168b01fe64..0c43b4381c 100644 --- a/pages/linux/distrobox-stop.md +++ b/pages/linux/distrobox-stop.md @@ -9,4 +9,4 @@ - Stop a Distrobox container non-interactively (without confirmation): -`distrobox-stop --name {{container_name}} --yes` +`distrobox-stop {{[-n|--name]}} {{container_name}} {{[-Y|--yes]}}` diff --git a/pages/linux/distrobox-upgrade.md b/pages/linux/distrobox-upgrade.md index d9c1d6ea4f..3cf4feaec1 100644 --- a/pages/linux/distrobox-upgrade.md +++ b/pages/linux/distrobox-upgrade.md @@ -9,7 +9,7 @@ - Upgrade all containers using the container's native package managers: -`distrobox-upgrade --all` +`distrobox-upgrade {{[-a|--all]}}` - Upgrade specific containers via the container's native package manager: diff --git a/pages/linux/dkms.md b/pages/linux/dkms.md index cfac3cba66..f3cf2d820e 100644 --- a/pages/linux/dkms.md +++ b/pages/linux/dkms.md @@ -1,7 +1,7 @@ # dkms > A framework that allows for dynamic building of kernel modules. -> More information: . +> More information: . - List currently installed modules: diff --git a/pages/linux/dmesg.md b/pages/linux/dmesg.md index a3150e5c5d..70d54389c4 100644 --- a/pages/linux/dmesg.md +++ b/pages/linux/dmesg.md @@ -11,7 +11,7 @@ `sudo dmesg {{[-l|--level]}} err` -- Show kernel messages and keep reading new ones, similar to `tail -f` (available in kernels 3.5.0 and newer): +- Show kernel messages and keep reading new ones, similar to `tail --follow` (available in kernels 3.5.0 and newer): `sudo dmesg {{[-w|--follow]}}` diff --git a/pages/linux/dmidecode.md b/pages/linux/dmidecode.md index 0bd2b612b4..19734c2c1a 100644 --- a/pages/linux/dmidecode.md +++ b/pages/linux/dmidecode.md @@ -10,20 +10,20 @@ - Show the BIOS version: -`sudo dmidecode -s bios-version` +`sudo dmidecode {{[-s|--string]}} bios-version` - Show the system's serial number: -`sudo dmidecode -s system-serial-number` +`sudo dmidecode {{[-s|--string]}} system-serial-number` - Show BIOS information: -`sudo dmidecode -t bios` +`sudo dmidecode {{[-t|--type]}} bios` - Show CPU information: -`sudo dmidecode -t processor` +`sudo dmidecode {{[-t|--type]}} processor` - Show memory information: -`sudo dmidecode -t memory` +`sudo dmidecode {{[-t|--type]}} memory` diff --git a/pages/linux/dnsrecon.md b/pages/linux/dnsrecon.md index a15d35a151..d53133d632 100644 --- a/pages/linux/dnsrecon.md +++ b/pages/linux/dnsrecon.md @@ -5,28 +5,28 @@ - Scan a domain and save the results to an SQLite database: -`dnsrecon --domain {{example.com}} --db {{path/to/database.sqlite}}` +`dnsrecon {{[-d|--domain]}} {{example.com}} --db {{path/to/database.sqlite}}` - Scan a domain, specifying the nameserver and performing a zone transfer: -`dnsrecon --domain {{example.com}} --name_server {{nameserver.example.com}} --type axfr` +`dnsrecon {{[-d|--domain]}} {{example.com}} {{[-n|--name_server]}} {{nameserver.example.com}} {{[-t|--type]}} axfr` - Scan a domain, using a brute-force attack and a dictionary of subdomains and hostnames: -`dnsrecon --domain {{example.com}} --dictionary {{path/to/dictionary.txt}} --type brt` +`dnsrecon {{[-d|--domain]}} {{example.com}} {{[-D|--dictionary]}} {{path/to/dictionary.txt}} {{[-t|--type]}} brt` - Scan a domain, performing a reverse lookup of IP ranges from the SPF record and saving the results to a JSON file: -`dnsrecon --domain {{example.com}} -s --json` +`dnsrecon {{[-d|--domain]}} {{example.com}} -s {{[-j|--json]}}` - Scan a domain, performing a Google enumeration and saving the results to a CSV file: -`dnsrecon --domain {{example.com}} -g --csv` +`dnsrecon {{[-d|--domain]}} {{example.com}} -g {{[-c|--csv]}}` - Scan a domain, performing DNS cache snooping: -`dnsrecon --domain {{example.com}} --type snoop --name_server {{nameserver.example.com}} --dictionary {{path/to/dictionary.txt}}` +`dnsrecon {{[-d|--domain]}} {{example.com}} {{[-t|--type]}} snoop {{[-n|--name_server]}} {{nameserver.example.com}} {{[-D|--dictionary]}} {{path/to/dictionary.txt}}` - Scan a domain, performing zone walking: -`dnsrecon --domain {{example.com}} --type zonewalk` +`dnsrecon {{[-d|--domain]}} {{example.com}} {{[-t|--type]}} zonewalk` diff --git a/pages/linux/dpkg.md b/pages/linux/dpkg.md index d537c1aa11..3540eda76b 100644 --- a/pages/linux/dpkg.md +++ b/pages/linux/dpkg.md @@ -7,28 +7,28 @@ - Install a package: -`dpkg -i {{path/to/file.deb}}` +`dpkg {{[-i|--install]}} {{path/to/file.deb}}` - Remove a package: -`dpkg -r {{package}}` +`dpkg {{[-r|--remove]}} {{package}}` - List installed packages: -`dpkg -l {{pattern}}` +`dpkg {{[-l|--list]}} {{pattern}}` - List a package's contents: -`dpkg -L {{package}}` +`dpkg {{[-L|--listfiles]}} {{package}}` - List contents of a local package file: -`dpkg -c {{path/to/file.deb}}` +`dpkg {{[-c|--contents]}} {{path/to/file.deb}}` - Find out which package owns a file: -`dpkg -S {{path/to/file}}` +`dpkg {{[-S|--search]}} {{path/to/file}}` - Purge an installed or already removed package, including configuration: -`dpkg -P {{package}}` +`dpkg {{[-P|--purge]}} {{package}}` diff --git a/pages/linux/dstat.md b/pages/linux/dstat.md index 622e09e62b..d719d8a5fd 100644 --- a/pages/linux/dstat.md +++ b/pages/linux/dstat.md @@ -13,7 +13,7 @@ - Display CPU and memory statistics only: -`dstat --cpu --mem` +`dstat {{[-c|--cpu]}} {{[-m|--mem]}}` - List all available dstat plugins: diff --git a/pages/linux/dunstify.md b/pages/linux/dunstify.md index 92a08f0a8b..419e4992fc 100644 --- a/pages/linux/dunstify.md +++ b/pages/linux/dunstify.md @@ -10,12 +10,12 @@ - Show a notification with specified urgency: -`dunstify "{{Title}}" "{{Message}}" -u {{low|normal|critical}}` +`dunstify "{{Title}}" "{{Message}}" {{[-u|--urgency]}} {{low|normal|critical}}` - Specify a message ID (overwrites any previous messages with the same ID): -`dunstify "{{Title}}" "{{Message}}" -r {{123}}` +`dunstify "{{Title}}" "{{Message}}" {{[-r|--replace]}} {{123}}` - Display help: -`dunstify --help` +`dunstify {{[-?|--help]}}` diff --git a/pages/linux/eclean-kernel.md b/pages/linux/eclean-kernel.md new file mode 100644 index 0000000000..7c5be7ec2b --- /dev/null +++ b/pages/linux/eclean-kernel.md @@ -0,0 +1,16 @@ +# eclean-kernel + +> Remove old kernels in Gentoo. +> More information: . + +- List all kernel files: + +`sudo eclean-kernel {{[-l|--list-kernels]}}` + +- Remove all kernels except for the two newest ones: + +`sudo eclean-kernel {{[-n|--num]}} 2` + +- Remove all kernels except for the two newest ones and ask before removal: + +`sudo eclean-kernel {{[-a|--all]}} {{[-n|--num]}} 2` diff --git a/pages/linux/edquota.md b/pages/linux/edquota.md index 9931a4386f..09c5596fcd 100644 --- a/pages/linux/edquota.md +++ b/pages/linux/edquota.md @@ -6,24 +6,24 @@ - Edit quota of the current user: -`edquota --user $(whoami)` +`edquota {{[-u|--user]}} $(whoami)` - Edit quota of a specific user: -`sudo edquota --user {{username}}` +`sudo edquota {{[-u|--user]}} {{username}}` - Edit quota for a group: -`sudo edquota --group {{group}}` +`sudo edquota {{[-g|--group]}} {{group}}` - Restrict operations to a given filesystem (by default edquota operates on all filesystems with quotas): -`sudo edquota --file-system {{filesystem}}` +`sudo edquota {{[-f|--file-system]}} {{filesystem}}` - Edit the default grace period: -`sudo edquota -t` +`sudo edquota {{[-t|--edit-period]}}` - Duplicate a quota to other users: -`sudo edquota -p {{reference_user}} {{destination_user1}} {{destination_user2}}` +`sudo edquota {{[-p|--prototype]}} {{reference_user}} {{destination_user1}} {{destination_user2}}` diff --git a/pages/linux/envycontrol.md b/pages/linux/envycontrol.md index b31e99053d..acad4fccab 100644 --- a/pages/linux/envycontrol.md +++ b/pages/linux/envycontrol.md @@ -5,7 +5,7 @@ - Switch between different GPU modes: -`sudo envycontrol -s {{nvidia|integrated|hybrid}}` +`sudo envycontrol {{[-s|--switch]}} {{nvidia|integrated|hybrid}}` - Specify your display manager manually: @@ -13,7 +13,7 @@ - Check current GPU mode: -`sudo envycontrol --query` +`sudo envycontrol {{[-q|--query]}}` - Reset settings: @@ -21,8 +21,8 @@ - Display help: -`envycontrol --help` +`envycontrol {{[-h|--help]}}` - Display version: -`envycontrol --version` +`envycontrol {{[-v|--version]}}` diff --git a/pages/linux/ethtool.md b/pages/linux/ethtool.md index 33754a8215..ecf178555c 100644 --- a/pages/linux/ethtool.md +++ b/pages/linux/ethtool.md @@ -9,20 +9,20 @@ - Display the driver information for an interface: -`ethtool --driver {{eth0}}` +`ethtool {{[-i|--driver]}} {{eth0}}` - Display all supported features for an interface: -`ethtool --show-features {{eth0}}` +`ethtool {{[-k|--show-features]}} {{eth0}}` - Display the network usage statistics for an interface: -`ethtool --statistics {{eth0}}` +`ethtool {{[-S|--statistics]}} {{eth0}}` - Blink one or more LEDs on an interface for 10 seconds: -`ethtool --identify {{eth0}} {{10}}` +`ethtool {{[-p|--identify]}} {{eth0}} {{10}}` - Set the link speed, duplex mode, and parameter auto-negotiation for a given interface: -`ethtool -s {{eth0}} speed {{10|100|1000}} duplex {{half|full}} autoneg {{on|off}}` +`ethtool {{[-s|--change]}} {{eth0}} speed {{10|100|1000}} duplex {{half|full}} autoneg {{on|off}}` diff --git a/pages/linux/eww.md b/pages/linux/eww.md index 504ca872d1..93cee32b77 100644 --- a/pages/linux/eww.md +++ b/pages/linux/eww.md @@ -9,11 +9,11 @@ - Open a widget: -`eww -c {{path/to/source_code_directory}} open {{window_name}}` +`eww {{[-c|--config]}} {{path/to/source_code_directory}} open {{window_name}}` - Close a widget: -`eww -c {{path/to/source_code_directory}} close {{window_name}}` +`eww {{[-c|--config]}} {{path/to/source_code_directory}} close {{window_name}}` - Reload the configuration: diff --git a/pages/linux/exif.md b/pages/linux/exif.md index 3dfb1240d2..5c7a11232e 100644 --- a/pages/linux/exif.md +++ b/pages/linux/exif.md @@ -1,7 +1,7 @@ # exif > Show and change EXIF information in JPEG files. -> More information: . +> More information: . - Show all recognized EXIF information in an image: @@ -9,16 +9,16 @@ - Show a table listing known EXIF tags and whether each one exists in an image: -`exif --list-tags --no-fixup {{image.jpg}}` +`exif {{[-l|--list-tags]}} --no-fixup {{path/to/image.jpg}}` -- Extract the image thumbnail into the file `thumbnail.jpg`: +- Extract the image thumbnail into a separate file: -`exif --extract-thumbnail --output={{thumbnail.jpg}} {{image.jpg}}` +`exif {{[-e|--extract-thumbnail]}} {{[-o|--output]}} {{path/to/thumbnail.jpg}} {{path/to/image.jpg}}` - Show the raw contents of the "Model" tag in the given image: -`exif --ifd={{0}} --tag={{Model}} --machine-readable {{image.jpg}}` +`exif --ifd {{0}} {{[-t|--tag]}} "Model" {{[-m|--machine-readable]}} {{path/to/image.jpg}}` - Change the value of the "Artist" tag to John Smith and save to `new.jpg`: -`exif --output={{new.jpg}} --ifd={{0}} --tag="{{Artist}}" --set-value="{{John Smith}}" --no-fixup {{image.jpg}}` +`exif {{[-o|--output]}} {{path/to/new.jpg}} --ifd {{0}} {{[-t|--tag]}} "Artist" --set-value "John Smith" --no-fixup {{path/to/image.jpg}}` diff --git a/pages/linux/expac.md b/pages/linux/expac.md index 73ac47e71d..b1d775e0ff 100644 --- a/pages/linux/expac.md +++ b/pages/linux/expac.md @@ -6,20 +6,20 @@ - List the dependencies of a package: -`expac -S '%D' {{package}}` +`expac {{[-S|--sync]}} '%D' {{package}}` - List the optional dependencies of a package: -`expac -S "%o" {{package}}` +`expac {{[-S|--sync]}} "%o" {{package}}` - List the download size of packages in MiB: -`expac -S -H M '%k\t%n' {{package1 package2 ...}}` +`expac {{[-S|--sync]}} {{[-H|--humansize]}} M '%k\t%n' {{package1 package2 ...}}` - List packages marked for upgrade with their download size: -`expac -S -H M '%k\t%n' $(pacman -Qqu) | sort -sh` +`expac {{[-S|--sync]}} {{[-H|--humansize]}} M '%k\t%n' $(pacman -Qqu) | sort {{[-sh|--sort --human-numeric-sort]}}` - List explicitly-installed packages with their optional dependencies: -`expac -d '\n\n' -l '\n\t' -Q '%n\n\t%O' $(pacman -Qeq)` +`expac {{[-d|--delim]}} '\n\n' {{[-l|listdelim]}} '\n\t' {{[-Q|--query]}} '%n\n\t%O' $(pacman -Qeq)` diff --git a/pages/linux/fail2ban-client.md b/pages/linux/fail2ban-client.md index f43625ade4..a31cd7f06e 100644 --- a/pages/linux/fail2ban-client.md +++ b/pages/linux/fail2ban-client.md @@ -1,7 +1,7 @@ # fail2ban-client > Configure and control fail2ban server. -> More information: . +> More information: . - Retrieve current status of the jail service: diff --git a/pages/linux/fakeroot.md b/pages/linux/fakeroot.md index 5c4e92c25f..579a4c0f7c 100644 --- a/pages/linux/fakeroot.md +++ b/pages/linux/fakeroot.md @@ -21,8 +21,8 @@ - Run a command keeping the real ownership of files instead of pretending they are owned by root: -`fakeroot --unknown-is-real -- {{command}} {{command_arguments}}` +`fakeroot {{[-u|--unknown-is-real]}} -- {{command}} {{command_arguments}}` - Display help: -`fakeroot --help` +`fakeroot {{[-h|--help]}}` diff --git a/pages/linux/fcrackzip.md b/pages/linux/fcrackzip.md index bb41eb44bb..bd3c052027 100644 --- a/pages/linux/fcrackzip.md +++ b/pages/linux/fcrackzip.md @@ -5,24 +5,24 @@ - Brute-force a password with a length of 4 to 8 characters, and contains only alphanumeric characters (order matters): -`fcrackzip --brute-force --length 4-8 --charset aA1 {{archive}}` +`fcrackzip {{[-b|--brute-force]}} {{[-l|--length]}} 4-8 {{[-c|--charset]}} aA1 {{archive}}` - Brute-force a password in verbose mode with a length of 3 characters that only contains lowercase characters, `$` and `%`: -`fcrackzip -v --brute-force --length 3 --charset a:$% {{archive}}` +`fcrackzip {{[-v|--verbose]}} {{[-b|--brute-force]}} {{[-l|--length]}} 3 {{[-c|--charset]}} a:$% {{archive}}` - Brute-force a password that contains only lowercase and special characters: -`fcrackzip --brute-force --length 4 --charset a! {{archive}}` +`fcrackzip {{[-b|--brute-force]}} {{[-l|--length]}} 4 {{[-c|--charset]}} a! {{archive}}` - Brute-force a password containing only digits, starting from the password `12345`: -`fcrackzip --brute-force --length 5 --charset 1 --init-password 12345 {{archive}}` +`fcrackzip {{[-b|--brute-force]}} {{[-l|--length]}} 5 {{[-c|--charset]}} 1 {{[-p|--init-password]}} 12345 {{archive}}` - Crack a password using a wordlist: -`fcrackzip --use-unzip --dictionary --init-password {{wordlist}} {{archive}}` +`fcrackzip {{[-u|--use-unzip]}} {{[-D|--dictionary]}} {{[-p|--init-password]}} {{wordlist}} {{archive}}` - Benchmark cracking performance: -`fcrackzip --benchmark` +`fcrackzip {{[-B|--benchmark]}}` diff --git a/pages/linux/fdisk.md b/pages/linux/fdisk.md index e84e3d063f..1ea8a59ab3 100644 --- a/pages/linux/fdisk.md +++ b/pages/linux/fdisk.md @@ -6,7 +6,7 @@ - List partitions: -`sudo fdisk -l` +`sudo fdisk {{[-l|--list]}}` - Start the partition manipulator: diff --git a/pages/linux/file-rename.md b/pages/linux/file-rename.md index a80d05e231..6deba918ed 100644 --- a/pages/linux/file-rename.md +++ b/pages/linux/file-rename.md @@ -10,11 +10,11 @@ - Dry-run - display which renames would occur without performing them: -`rename -n {{'s/foo/bar/'}} {{*}}` +`rename {{[-n|--nono]}} {{'s/foo/bar/'}} {{*}}` - Force renaming even if the operation would remove existing destination files: -`rename -f {{'s/foo/bar/'}} {{*}}` +`rename {{[-f|--force]}} {{'s/foo/bar/'}} {{*}}` - Convert filenames to lower case (use `-f` in case-insensitive filesystems to prevent "already exists" errors): diff --git a/pages/linux/findfs.md b/pages/linux/findfs.md index 0c396b4feb..b6d512fb55 100644 --- a/pages/linux/findfs.md +++ b/pages/linux/findfs.md @@ -1,7 +1,7 @@ # findfs > Finds a filesystem by label or UUID. -> More information: . +> More information: . - Search block devices by filesystem label: diff --git a/pages/linux/flashrom.md b/pages/linux/flashrom.md index b316a92265..a73ab68d83 100644 --- a/pages/linux/flashrom.md +++ b/pages/linux/flashrom.md @@ -5,20 +5,20 @@ - Probe the chip, ensuring the wiring is correct: -`flashrom --programmer {{programmer}}` +`flashrom {{[-p|--programmer]}} {{programmer}}` - Read flash and save it to a file: -`flashrom -p {{programmer}} --read {{path/to/file}}` +`flashrom {{[-p|--programmer]}} {{programmer}} {{[-r|--read]}} {{path/to/file}}` - Write a file to the flash: -`flashrom -p {{programmer}} --write {{path/to/file}}` +`flashrom {{[-p|--programmer]}} {{programmer}} {{[-w|--write]}} {{path/to/file}}` - Verify the flash against a file: -`flashrom -p {{programmer}} --verify {{path/to/file}}` +`flashrom {{[-p|--programmer]}} {{programmer}} {{[-v|--verify]}} {{path/to/file}}` - Probe the chip using Raspberry Pi: -`flashrom -p {{linux_spi:dev=/dev/spidev0.0}}` +`flashrom {{[-p|--programmer]}} {{linux_spi:dev=/dev/spidev0.0}}` diff --git a/pages/linux/foreman.md b/pages/linux/foreman.md index 288c64c684..ddcfda1c2c 100644 --- a/pages/linux/foreman.md +++ b/pages/linux/foreman.md @@ -9,7 +9,7 @@ - Start an application with a specified Procfile: -`foreman start -f {{Procfile}}` +`foreman start {{[-f|--procfile]}} {{Procfile}}` - Start a specific application: @@ -25,4 +25,4 @@ - Start all processes except the one named "worker": -`foreman start -m all=1,{{worker}}=0` +`foreman start {{[-m|--formation]}} all=1,{{worker}}=0` diff --git a/pages/linux/fuzzel.md b/pages/linux/fuzzel.md index 43269df725..0af030b81f 100644 --- a/pages/linux/fuzzel.md +++ b/pages/linux/fuzzel.md @@ -25,9 +25,9 @@ - Reset apps usage count (default cache directory: `$XDG_CACHE_HOME/fuzzel`): -`rm -v $HOME/.cache/fuzzel` +`rm {{[-v|--verbose]}} $HOME/.cache/fuzzel` -- Launch `fuzzel` on a specific monitor, see `wlr-randr` or `swaymsg -t get_outputs`: +- Launch `fuzzel` on a specific monitor, see `wlr-randr` or `swaymsg --type get_outputs`: `fuzzel {{[-o|--output]}} "{{DP-1}}"` diff --git a/pages/linux/genie.md b/pages/linux/genie.md index 4cf90caddb..799bdd3711 100644 --- a/pages/linux/genie.md +++ b/pages/linux/genie.md @@ -6,12 +6,12 @@ - Initialize the bottle (run once, at start): -`genie -i` +`genie {{[-i|--initialize]}}` - Run a login shell inside the bottle: -`genie -s` +`genie {{[-s|--shell]}}` - Run a specified command inside the bottle: -`genie -c {{command}}` +`genie {{[-c|--command]}} {{command}}` diff --git a/pages/linux/getfattr.md b/pages/linux/getfattr.md index e5fc312228..cceca59541 100644 --- a/pages/linux/getfattr.md +++ b/pages/linux/getfattr.md @@ -5,8 +5,8 @@ - Retrieve all extended attributes of a file and display them in a detailed format: -`getfattr -d {{path/to/file}}` +`getfattr {{[-d|--dump]}} {{path/to/file}}` - Get a specific attribute of a file: -`getfattr -n user.{{attribute_name}} {{path/to/file}}` +`getfattr {{[-n|--name]}} user.{{attribute_name}} {{path/to/file}}` diff --git a/pages/linux/goaccess.md b/pages/linux/goaccess.md index a5ee6e6045..42e53d9b0c 100644 --- a/pages/linux/goaccess.md +++ b/pages/linux/goaccess.md @@ -13,8 +13,8 @@ - Analyze a log from `stdin`: -`tail -f {{path/to/logfile}} | goaccess -` +`tail {{[-f|--follow]}} {{path/to/logfile}} | goaccess -` - Analyze a log and write it to an HTML file in real-time: -`goaccess {{path/to/logfile}} --output {{path/to/file.html}} --real-time-html` +`goaccess {{path/to/logfile}} {{[-o|--output]}} {{path/to/file.html}} --real-time-html` diff --git a/pages/linux/hardinfo.md b/pages/linux/hardinfo.md index e2b55c8020..71ff797f4b 100644 --- a/pages/linux/hardinfo.md +++ b/pages/linux/hardinfo.md @@ -9,8 +9,8 @@ - Print report to `stdout`: -`hardinfo -r` +`hardinfo {{[-r|--generate-report]}}` - Save report to HTML file: -`hardinfo -r -f html > hardinfo.html` +`hardinfo {{[-r|--generate-report]}} {{[-f|--report-format]}} html > hardinfo.html` diff --git a/pages/linux/hollywood.md b/pages/linux/hollywood.md index f07b10a1ae..653d23b05b 100644 --- a/pages/linux/hollywood.md +++ b/pages/linux/hollywood.md @@ -13,4 +13,4 @@ - Display help: -`hollywood -h` +`hollywood {{[-h|--help]}}` diff --git a/pages/linux/ifdown.md b/pages/linux/ifdown.md index be05c5bd92..3d70908a28 100644 --- a/pages/linux/ifdown.md +++ b/pages/linux/ifdown.md @@ -9,4 +9,4 @@ - Disable all interfaces which are enabled: -`ifdown -a` +`ifdown {{[-a|--all]}}` diff --git a/pages/linux/ifup.md b/pages/linux/ifup.md index 714857f718..86d99953b5 100644 --- a/pages/linux/ifup.md +++ b/pages/linux/ifup.md @@ -9,4 +9,4 @@ - Enable all the interfaces defined with "auto" in `/etc/network/interfaces`: -`ifup -a` +`ifup {{[-a|--all]}}` diff --git a/pages/linux/imgp.md b/pages/linux/imgp.md index 17ca4c07d7..806a17404a 100644 --- a/pages/linux/imgp.md +++ b/pages/linux/imgp.md @@ -5,12 +5,12 @@ - Convert single images and/or whole directories containing valid image formats: -`imgp -x {{1366x1000}} {{path/to/directory}} {{path/to/file}}` +`imgp {{[-x|--res]}} {{1366x1000}} {{path/to/directory}} {{path/to/file}}` - Scale an image by 75% and overwrite the source image to a target resolution: -`imgp -x {{75}} -w {{path/to/file}}` +`imgp {{[-x|--res]}} {{75}} z-w {{path/to/file}}` - Rotate an image clockwise by 90 degrees: -`imgp -o {{90}} {{path/to/file}}` +`imgp {{[-o|--rotate]}} {{90}} {{path/to/file}}` diff --git a/pages/linux/iostat.md b/pages/linux/iostat.md index 0c2cf3546f..4efa034bef 100644 --- a/pages/linux/iostat.md +++ b/pages/linux/iostat.md @@ -13,7 +13,7 @@ - Display CPU statistics: -`iostat {{[-c|--compact]}}` +`iostat -c` - Display disk statistics with disk names (including LVM): diff --git a/pages/linux/ipcalc.md b/pages/linux/ipcalc.md deleted file mode 100644 index 0752f41fe3..0000000000 --- a/pages/linux/ipcalc.md +++ /dev/null @@ -1,24 +0,0 @@ -# ipcalc - -> Perform simple operations and calculations on IP addresses and networks. -> More information: . - -- Show information about an address or network with a given subnet mask: - -`ipcalc {{1.2.3.4}} {{255.255.255.0}}` - -- Show information about an address or network in CIDR notation: - -`ipcalc {{1.2.3.4}}/{{24}}` - -- Show the broadcast address of an address or network: - -`ipcalc -b {{1.2.3.4}}/{{30}}` - -- Show the network address of provided IP address and netmask: - -`ipcalc -n {{1.2.3.4}}/{{24}}` - -- Display geographic information about a given IP address: - -`ipcalc -g {{1.2.3.4}}` diff --git a/pages/linux/kexec.md b/pages/linux/kexec.md index 1ae09438b2..6b6850ab19 100644 --- a/pages/linux/kexec.md +++ b/pages/linux/kexec.md @@ -5,16 +5,16 @@ - Load a new kernel: -`kexec -l {{path/to/kernel}} --initrd={{path/to/initrd}} --command-line={{arguments}}` +`kexec {{[-l|--load]}} {{path/to/kernel}} --initrd={{path/to/initrd}} --command-line={{arguments}}` - Load a new kernel with current boot parameters: -`kexec -l {{path/to/kernel}} --initrd={{path/to/initrd}} --reuse-cmdline` +`kexec {{[-l|--load]}} {{path/to/kernel}} --initrd={{path/to/initrd}} --reuse-cmdline` - Execute a currently loaded kernel: -`kexec -e` +`kexec {{[-e|--exec]}}` - Unload current kexec target kernel: -`kexec -u` +`kexec {{[-u|--unload]}}` diff --git a/pages/linux/knock.md b/pages/linux/knock.md index 51ddb4a13d..f6a3efacb1 100644 --- a/pages/linux/knock.md +++ b/pages/linux/knock.md @@ -9,7 +9,7 @@ - Knock on port using UDP: -`knock -u {{hostname}} {{portnumber}}` +`knock {{[-u|--udp]}} {{hostname}} {{portnumber}}` - Force usage of IPv4/IPv6: @@ -17,4 +17,4 @@ - Display errors and details of connection: -`knock -v {{hostname}} {{portnumber}}` +`knock {{[-v|--verbose]}} {{hostname}} {{portnumber}}` diff --git a/pages/linux/knockd.md b/pages/linux/knockd.md index 58085f7053..a04824942c 100644 --- a/pages/linux/knockd.md +++ b/pages/linux/knockd.md @@ -5,8 +5,8 @@ - Start knockd system daemon: -`knockd -d` +`knockd {{[-d|--daemon]}}` - Use specified configuration file for knockd: -`knockd -c {{path/to/file}}.configuration` +`knockd {{[-c|--config]}} {{path/to/file}}.configuration` diff --git a/pages/linux/konsave.md b/pages/linux/konsave.md index 47441c63b5..68744fee26 100644 --- a/pages/linux/konsave.md +++ b/pages/linux/konsave.md @@ -5,28 +5,28 @@ - Save the current configuration as a profile: -`konsave --save {{profile_name}}` +`konsave {{[-s|--save]}} {{profile_name}}` - Apply a profile: -`konsave --apply {{profile_name}}` +`konsave {{[-a|--apply]}} {{profile_name}}` - Save the current configuration as a profile, overwriting existing profiles if they exist with the same name: -`konsave -s {{profile_name}} --force` +`konsave {{[-s|--save]}} {{profile_name}} {{[-f|--force]}}` - List all profiles: -`konsave --list` +`konsave {{[-l|--list]}}` - Remove a profile: -`konsave --remove {{profile_name}}` +`konsave {{[-r|--remove]}} {{profile_name}}` - Export a profile as a `.knsv` to the home directory: -`konsave --export-profile {{profile_name}}` +`konsave {{[-e|--export-profile]}} {{profile_name}}` - Import a `.knsv` profile: -`konsave --import-profile {{path/to/profile_name.knsv}}` +`konsave {{[-i|--import-profile]}} {{path/to/profile_name.knsv}}` diff --git a/pages/linux/ldconfig.md b/pages/linux/ldconfig.md index ffb770a917..c387384626 100644 --- a/pages/linux/ldconfig.md +++ b/pages/linux/ldconfig.md @@ -13,4 +13,4 @@ - Print the libraries in the cache and check whether a given library is present: -`ldconfig -p | grep {{library_name}}` +`ldconfig {{[-p|--print-cache]}} | grep {{library_name}}` diff --git a/pages/linux/logger.md b/pages/linux/logger.md index 1cbc7fcff9..0b4bb98c50 100644 --- a/pages/linux/logger.md +++ b/pages/linux/logger.md @@ -1,6 +1,6 @@ # logger -> Add messages to syslog (/var/log/syslog). +> Add messages to the system log. > More information: . - Log a message to syslog: diff --git a/pages/linux/lsb_release.md b/pages/linux/lsb_release.md index 9f980c478f..2895cee17c 100644 --- a/pages/linux/lsb_release.md +++ b/pages/linux/lsb_release.md @@ -5,16 +5,16 @@ - Print all available information: -`lsb_release -a` +`lsb_release {{[-a|--all]}}` - Print a description (usually the full name) of the operating system: -`lsb_release -d` +`lsb_release {{[-d|--description]}}` - Print only the operating system name (ID), suppressing the field name: -`lsb_release -i -s` +`lsb_release {{[-is|--id --short]}}` - Print the release number and codename of the distribution, suppressing the field names: -`lsb_release -rcs` +`lsb_release {{[-rcs|--release --codename --short]}}` diff --git a/pages/linux/lsfd.md b/pages/linux/lsfd.md index dff2a71af3..03868023b7 100644 --- a/pages/linux/lsfd.md +++ b/pages/linux/lsfd.md @@ -17,7 +17,7 @@ - List open IPv4 or IPv6 sockets: -`lsfd -i{{4|6}}` +`lsfd {{-i4|-i6}}` - Display help: diff --git a/pages/linux/lsscsi.md b/pages/linux/lsscsi.md index 20a51bea5e..08962f18be 100644 --- a/pages/linux/lsscsi.md +++ b/pages/linux/lsscsi.md @@ -1,7 +1,7 @@ # lsscsi > List SCSI devices (or hosts) and their attributes. -> More information: . +> More information: . - List all SCSI devices: @@ -9,8 +9,8 @@ - List all SCSI devices with detailed attributes: -`lsscsi -L` +`lsscsi {{[-L|--list]}}` - List all SCSI devices with human-readable disk capacity: -`lsscsi -s` +`lsscsi {{[-s|--size]}}` diff --git a/pages/linux/ltrace.md b/pages/linux/ltrace.md index 00b040790e..1fc963b192 100644 --- a/pages/linux/ltrace.md +++ b/pages/linux/ltrace.md @@ -17,4 +17,4 @@ - Write to file instead of terminal: -`ltrace -o {{file}} {{path/to/program}}` +`ltrace {{[-o|--output]}} {{file}} {{path/to/program}}` diff --git a/pages/linux/lvcreate.md b/pages/linux/lvcreate.md index 3b93e9f6c1..ae4f1908c1 100644 --- a/pages/linux/lvcreate.md +++ b/pages/linux/lvcreate.md @@ -6,16 +6,16 @@ - Create a logical volume of 10 gigabytes in the volume group vg1: -`lvcreate -L {{10G}} {{vg1}}` +`lvcreate {{[-L|--size]}} {{10G}} {{vg1}}` - Create a 1500 megabyte linear logical volume named mylv in the volume group vg1: -`lvcreate -L {{1500}} -n {{mylv}} {{vg1}}` +`lvcreate {{[-L|--size]}} {{1500}} {{[-n|--name]}} {{mylv}} {{vg1}}` - Create a logical volume called mylv that uses 60% of the total space in volume group vg1: -`lvcreate -l {{60%VG}} -n {{mylv}} {{vg1}}` +`lvcreate {{[-l|--extents]}} {{60%VG}} {{[-n|--name]}} {{mylv}} {{vg1}}` - Create a logical volume called mylv that uses all the unallocated space in the volume group vg1: -`lvcreate -l {{100%FREE}} -n {{mylv}} {{vg1}}` +`lvcreate {{[-l|--extents]}} {{100%FREE}} {{[-n|--name]}} {{mylv}} {{vg1}}` diff --git a/pages/linux/lvextend.md b/pages/linux/lvextend.md index 5b97b0e804..00927c66bc 100644 --- a/pages/linux/lvextend.md +++ b/pages/linux/lvextend.md @@ -6,12 +6,16 @@ - Increase a volume's size to 120 GB: -`lvextend --size {{120G}} {{logical_volume}}` +`sudo lvextend {{[-L|--size]}} {{120G}} {{logical_volume}}` - Increase a volume's size by 40 GB as well as the underlying filesystem: -`lvextend --size +{{40G}} -r {{logical_volume}}` +`sudo lvextend {{[-L|--size]}} +{{40G}} {{[-r|--resizefs]}} {{logical_volume}}` - Increase a volume's size to 100% of the free physical volume space: -`lvextend --size +{{100}}%FREE {{logical_volume}}` +`sudo lvextend {{[-l|--extents]}} +{{100}}%FREE {{logical_volume}}` + +- Increase a volume's size to 100% of the free physical volume space and resize the underlying filesystem: + +`sudo lvextend {{[-l|--extents]}} +{{100}}%FREE {{[-r|--resizefs]}} {{logical_volume}}` diff --git a/pages/linux/lvreduce.md b/pages/linux/lvreduce.md index 10bc7c48e0..b91dfe7fa7 100644 --- a/pages/linux/lvreduce.md +++ b/pages/linux/lvreduce.md @@ -6,8 +6,8 @@ - Reduce a volume's size to 120 GB: -`lvreduce --size {{120G}} {{logical_volume}}` +`lvreduce {{[-L|--size]}} {{120G}} {{logical_volume}}` - Reduce a volume's size by 40 GB as well as the underlying filesystem: -`lvreduce --size -{{40G}} -r {{logical_volume}}` +`lvreduce {{[-L|--size]}} -{{40G}} {{[-r|--resizefs]}} {{logical_volume}}` diff --git a/pages/linux/lvs.md b/pages/linux/lvs.md index 22b7afe33d..f1da94f601 100644 --- a/pages/linux/lvs.md +++ b/pages/linux/lvs.md @@ -10,19 +10,19 @@ - Display all logical volumes: -`lvs -a` +`lvs {{[-a|--all]}}` - Change default display to show more details: -`lvs -v` +`lvs {{[-v|--verbose]}}` - Display only specific fields: -`lvs -o {{field_name_1}},{{field_name_2}}` +`lvs {{[-o|--options]}} {{field_name_1}},{{field_name_2}}` - Append field to default display: -`lvs -o +{{field_name}}` +`lvs {{[-o|--options]}} +{{field_name}}` - Suppress heading line: diff --git a/pages/linux/lxterminal.md b/pages/linux/lxterminal.md index 7dadd2444d..e1fc71f91d 100644 --- a/pages/linux/lxterminal.md +++ b/pages/linux/lxterminal.md @@ -9,7 +9,7 @@ - Open an LXTerminal window, run a command, and then exit: -`lxterminal -e "{{command}}"` +`lxterminal {{[-e|--command]}} "{{command}}"` - Open an LXTerminal window with multiple tabs: diff --git a/pages/linux/maim.md b/pages/linux/maim.md index 3a6693ee9c..a9fc5664a3 100644 --- a/pages/linux/maim.md +++ b/pages/linux/maim.md @@ -1,7 +1,7 @@ # maim > Screenshot utility. -> More information: . +> More information: . - Capture a screenshot and save it to the given path: @@ -9,12 +9,12 @@ - Capture a screenshot of the selected region: -`maim --select {{path/to/screenshot.png}}` +`maim {{[-s|--select]}} {{path/to/screenshot.png}}` - Capture a screenshot of the selected region and save it in the clipboard (requires `xclip`): -`maim --select | xclip -selection clipboard -target image/png` +`maim {{[-s|--select]}} | xclip {{[-se|-selection]}} {{[c|clipboard]}} {{[-t|-target]}} image/png` - Capture a screenshot of the current active window (requires `xdotool`): -`maim --window $(xdotool getactivewindow) {{path/to/screenshot.png}}` +`maim {{[-i|--window]}} $(xdotool getactivewindow) {{path/to/screenshot.png}}` diff --git a/pages/linux/mangohud.md b/pages/linux/mangohud.md index 73363630b5..2e744ae966 100644 --- a/pages/linux/mangohud.md +++ b/pages/linux/mangohud.md @@ -6,3 +6,15 @@ - Use `mangohud` on top of an application: `mangohud {{command}}` + +- Change overlay position: + +`` + +- Change overlay verbosity: + +`` + +- Toggle overlay visibility: + +`` diff --git a/pages/linux/mkfs.bcachefs.md b/pages/linux/mkfs.bcachefs.md index 6d79998360..413d80534c 100644 --- a/pages/linux/mkfs.bcachefs.md +++ b/pages/linux/mkfs.bcachefs.md @@ -1,12 +1,13 @@ # mkfs.bcachefs > Create a `bcachefs` filesystem inside a partition. +> See also: `bcachefs`. > More information: . -- Create a `bcachefs` filesystem inside partition 1 on a device (`X`): +- Create a `bcachefs` filesystem inside partition `Y` on a device `X`: -`sudo mkfs.bcachefs {{/dev/sdX1}}` +`sudo mkfs.bcachefs {{/dev/sdXY}}` - Create a `bcachefs` filesystem with a volume label: -`sudo mkfs.bcachefs {{[-L|--fs_label]}} {{volume_label}} {{/dev/sdX1}}` +`sudo mkfs.bcachefs {{[-L|--fs_label]}} {{volume_label}} {{/dev/sdXY}}` diff --git a/pages/linux/mkfs.btrfs.md b/pages/linux/mkfs.btrfs.md index 6baa440d48..0b691c89eb 100644 --- a/pages/linux/mkfs.btrfs.md +++ b/pages/linux/mkfs.btrfs.md @@ -6,12 +6,12 @@ - Create a btrfs filesystem on a single device: -`sudo mkfs.btrfs --metadata single --data single {{/dev/sda}}` +`sudo mkfs.btrfs {{[-m|--metadata]}} single {{[-d|--data]}} single {{/dev/sdX}}` - Create a btrfs filesystem on multiple devices with raid1: -`sudo mkfs.btrfs --metadata raid1 --data raid1 {{/dev/sda}} {{/dev/sdb}} {{/dev/sdN}}` +`sudo mkfs.btrfs {{[-m|--metadata]}} raid1 {{[-d|--data]}} raid1 {{/dev/sdX /dev/sdY /dev/sdZ ...}}` - Set a label for the filesystem: -`sudo mkfs.btrfs --label "{{label}}" {{/dev/sda}} [{{/dev/sdN}}]` +`sudo mkfs.btrfs {{[-L|--label]}} "{{label}}" {{/dev/sdX /dev/sdY ...}}` diff --git a/pages/linux/mkfs.cramfs.md b/pages/linux/mkfs.cramfs.md index 0fa2b6dcf6..24935fceaa 100644 --- a/pages/linux/mkfs.cramfs.md +++ b/pages/linux/mkfs.cramfs.md @@ -3,10 +3,10 @@ > Create a ROM filesystem inside a partition. > More information: . -- Create a ROM filesystem inside partition 1 on device b (`sdb1`): +- Create a ROM filesystem inside partition Y on device X: -`mkfs.cramfs {{/dev/sdb1}}` +`mkfs.cramfs {{/dev/sdXY}}` - Create a ROM filesystem with a volume-name: -`mkfs.cramfs -n {{volume_name}} {{/dev/sdb1}}` +`mkfs.cramfs -n {{volume_name}} {{/dev/sdXY}}` diff --git a/pages/linux/mkfs.exfat.md b/pages/linux/mkfs.exfat.md index 464b8d6c1c..36e4d2de73 100644 --- a/pages/linux/mkfs.exfat.md +++ b/pages/linux/mkfs.exfat.md @@ -3,14 +3,14 @@ > Create an exfat filesystem inside a partition. > More information: . -- Create an exfat filesystem inside partition 1 on device b (`sdb1`): +- Create an exfat filesystem inside partition Y on device X: -`mkfs.exfat {{/dev/sdb1}}` +`mkfs.exfat {{/dev/sdXY}}` - Create filesystem with a volume-name: -`mkfs.exfat -n {{volume_name}} {{/dev/sdb1}}` +`mkfs.exfat {{[-L|--volume-label]}} {{volume_name}} {{/dev/sdXY}}` - Create filesystem with a volume-id: -`mkfs.exfat -i {{volume_id}} {{/dev/sdb1}}` +`mkfs.exfat {{[-U|--volume-guid]}} {{volume_id}} {{/dev/sdXY}}` diff --git a/pages/linux/mkfs.ext4.md b/pages/linux/mkfs.ext4.md index 190eb86d50..c2ca91cc8e 100644 --- a/pages/linux/mkfs.ext4.md +++ b/pages/linux/mkfs.ext4.md @@ -3,10 +3,10 @@ > Create an ext4 filesystem inside a partition. > More information: . -- Create an ext4 filesystem inside partition 1 on device b (`sdb1`): +- Create an ext4 filesystem inside partition Y on device X: -`sudo mkfs.ext4 {{/dev/sdb1}}` +`sudo mkfs.ext4 {{/dev/sdXY}}` - Create an ext4 filesystem with a volume-label: -`sudo mkfs.ext4 -L {{volume_label}} {{/dev/sdb1}}` +`sudo mkfs.ext4 -L {{volume_label}} {{/dev/sdXY}}` diff --git a/pages/linux/mkfs.f2fs.md b/pages/linux/mkfs.f2fs.md index b320882d68..7a903fcdef 100644 --- a/pages/linux/mkfs.f2fs.md +++ b/pages/linux/mkfs.f2fs.md @@ -3,10 +3,10 @@ > Create an F2FS filesystem inside a partition. > More information: . -- Create an F2FS filesystem inside partition 1 on device b (`sdb1`): +- Create an F2FS filesystem inside partition Y on device X: -`sudo mkfs.f2fs {{/dev/sdb1}}` +`sudo mkfs.f2fs {{/dev/sdXY}}` - Create an F2FS filesystem with a volume label: -`sudo mkfs.f2fs -l {{volume_label}} {{/dev/sdb1}}` +`sudo mkfs.f2fs -l {{volume_label}} {{/dev/sdXY}}` diff --git a/pages/linux/mkfs.fat.md b/pages/linux/mkfs.fat.md index 8e483e40a0..dee34d17f3 100644 --- a/pages/linux/mkfs.fat.md +++ b/pages/linux/mkfs.fat.md @@ -3,18 +3,18 @@ > Create an MS-DOS filesystem inside a partition. > More information: . -- Create a fat filesystem inside partition 1 on device b (`sdb1`): +- Create a fat filesystem inside partition `Y` on device `X`: -`mkfs.fat {{/dev/sdb1}}` +`mkfs.fat {{/dev/sdXY}}` - Create filesystem with a volume-name: -`mkfs.fat -n {{volume_name}} {{/dev/sdb1}}` +`mkfs.fat -n {{volume_name}} {{/dev/sdXY}}` - Create filesystem with a volume-id: -`mkfs.fat -i {{volume_id}} {{/dev/sdb1}}` +`mkfs.fat -i {{volume_id}} {{/dev/sdXY}}` - Use 5 instead of 2 file allocation tables: -`mkfs.fat -f 5 {{/dev/sdb1}}` +`mkfs.fat -f 5 {{/dev/sdXY}}` diff --git a/pages/linux/mkfs.md b/pages/linux/mkfs.md index c08d3e14ce..013e109fbf 100644 --- a/pages/linux/mkfs.md +++ b/pages/linux/mkfs.md @@ -6,12 +6,12 @@ - Build a Linux ext2 filesystem on a partition: -`mkfs {{path/to/partition}}` +`mkfs {{/dev/sdXY}}` - Build a filesystem of a specified type: -`mkfs {{[-t|--type]}} {{ext4}} {{path/to/partition}}` +`mkfs {{[-t|--type]}} {{ext4}} {{/dev/sdXY}}` - Build a filesystem of a specified type and check for bad blocks: -`mkfs -c {{[-t|--type]}} {{ntfs}} {{path/to/partition}}` +`mkfs -c {{[-t|--type]}} {{ntfs}} {{/dev/sdXY}}` diff --git a/pages/linux/mkfs.minix.md b/pages/linux/mkfs.minix.md index ba3905052d..27ec67efc4 100644 --- a/pages/linux/mkfs.minix.md +++ b/pages/linux/mkfs.minix.md @@ -3,6 +3,6 @@ > Create a Minix filesystem inside a partition. > More information: . -- Create a Minix filesystem inside partition 1 on device b (`sdb1`): +- Create a Minix filesystem inside partition Y on device X: -`mkfs.minix {{/dev/sdb1}}` +`mkfs.minix {{/dev/sdXY}}` diff --git a/pages/linux/mkfs.ntfs.md b/pages/linux/mkfs.ntfs.md index a725842052..38133ecc0c 100644 --- a/pages/linux/mkfs.ntfs.md +++ b/pages/linux/mkfs.ntfs.md @@ -3,14 +3,14 @@ > Create a NTFS filesystem inside a partition. > More information: . -- Create a NTFS filesystem inside partition 1 on device b (`sdb1`): +- Create a NTFS filesystem inside partition Y on device X: -`mkfs.ntfs {{/dev/sdb1}}` +`mkfs.ntfs {{/dev/sdXY}}` - Create filesystem with a volume-label: -`mkfs.ntfs -L {{volume_label}} {{/dev/sdb1}}` +`mkfs.ntfs {{[-L|--label]}} {{volume_label}} {{/dev/sdXY}}` - Create filesystem with specific UUID: -`mkfs.ntfs -U {{UUID}} {{/dev/sdb1}}` +`mkfs.ntfs {{[-U|--with-uuid]}} {{UUID}} {{/dev/sdXY}}` diff --git a/pages/linux/mkfs.vfat.md b/pages/linux/mkfs.vfat.md index 22bd41d1c3..62b00856fb 100644 --- a/pages/linux/mkfs.vfat.md +++ b/pages/linux/mkfs.vfat.md @@ -1,20 +1,7 @@ # mkfs.vfat -> Create an MS-DOS filesystem inside a partition. -> More information: . +> This command is an alias of `mkfs.fat`. -- Create a vfat filesystem inside partition 1 on device b (`sdb1`): +- View documentation for the original command: -`mkfs.vfat {{/dev/sdb1}}` - -- Create filesystem with a volume-name: - -`mkfs.vfat -n {{volume_name}} {{/dev/sdb1}}` - -- Create filesystem with a volume-id: - -`mkfs.vfat -i {{volume_id}} {{/dev/sdb1}}` - -- Use 5 instead of 2 file allocation tables: - -`mkfs.vfat -f 5 {{/dev/sdb1}}` +`tldr mkfs.fat` diff --git a/pages/linux/mkfs.xfs.md b/pages/linux/mkfs.xfs.md index 91c15cf779..19fae4d2c9 100644 --- a/pages/linux/mkfs.xfs.md +++ b/pages/linux/mkfs.xfs.md @@ -3,10 +3,10 @@ > Create an XFS filesystem inside a partition. > More information: . -- Create an XFS filesystem inside partition 1 on a device (`X`): +- Create an XFS filesystem inside partition Y on device X: -`sudo mkfs.xfs {{/dev/sdX1}}` +`sudo mkfs.xfs {{/dev/sdXY}}` - Create an XFS filesystem with a volume label: -`sudo mkfs.xfs -L {{volume_label}} {{/dev/sdX1}}` +`sudo mkfs.xfs -L {{volume_label}} {{/dev/sdXY}}` diff --git a/pages/linux/mopac.md b/pages/linux/mopac.md index b752e260bc..0b9343702e 100644 --- a/pages/linux/mopac.md +++ b/pages/linux/mopac.md @@ -9,4 +9,4 @@ - Minimal working example with HF that writes to the current directory and streams the output file: -`touch test.out; echo "PM7\n#comment\n\nH 0.95506 0.05781 -0.03133\nF 1.89426 0.05781 -0.03133" > test.mop; mopac test.mop & tail -f test.out` +`touch test.out; echo "PM7\n#comment\n\nH 0.95506 0.05781 -0.03133\nF 1.89426 0.05781 -0.03133" > test.mop; mopac test.mop & tail {{[-f|--follow]}} test.out` diff --git a/pages/linux/ncat.md b/pages/linux/ncat.md index 248354c358..a24e690568 100644 --- a/pages/linux/ncat.md +++ b/pages/linux/ncat.md @@ -6,11 +6,11 @@ - Listen for input on the specified port and write it to the specified file: -`ncat -l {{port}} > {{path/to/file}}` +`ncat {{[-l|--listen]}} {{port}} > {{path/to/file}}` - Accept multiple connections and keep ncat open after they have been closed: -`ncat -lk {{port}}` +`ncat {{[-lk|--listen --keep-open]}} {{port}}` - Write output of specified file to the specified host on the specified port: @@ -18,7 +18,7 @@ - Accept multiple incoming connections on an encrypted channel evading detection of traffic content: -`ncat --ssl -k -l {{port}}` +`ncat --ssl {{[-k|--keep-open]}} {{[-l|--listen]}} {{port}}` - Connect to an open `ncat` connection over SSL: @@ -26,4 +26,4 @@ - Check connectivity to a remote host on a particular port with timeout: -`ncat -w {{seconds}} -vz {{host}} {{port}}` +`ncat {{[-w|--wait]}} {{seconds}} {{[-vz|--verbose -z]}} {{host}} {{port}}` diff --git a/pages/linux/netselect-apt.md b/pages/linux/netselect-apt.md index 8c353f6ce2..acfa29cb98 100644 --- a/pages/linux/netselect-apt.md +++ b/pages/linux/netselect-apt.md @@ -13,8 +13,8 @@ - Include non-free section: -`sudo netselect-apt --non-free` +`sudo netselect-apt {{[-n|--non-free]}}` - Specify a country for the mirror list lookup: -`sudo netselect-apt -c {{India}}` +`sudo netselect-apt {{[-c|--country]}} {{India}}` diff --git a/pages/linux/netselect.md b/pages/linux/netselect.md index 83b39431c5..2f9b4a741e 100644 --- a/pages/linux/netselect.md +++ b/pages/linux/netselect.md @@ -5,19 +5,19 @@ - Choose the server with the lowest latency: -`sudo netselect {{host_1}} {{host_2}}` +`sudo netselect {{host_1 host_2 ...}}` - Display nameserver resolution and statistics: -`sudo netselect -vv {{host_1}} {{host_2}}` +`sudo netselect -vv {{host_1 host_2 ...}}` - Define maximum TTL (time to live): -`sudo netselect -m {{10}} {{host_1}} {{host_2}}` +`sudo netselect -m {{10}} {{host_1 host_2 ...}}` - Print `n` fastest servers among the hosts: -`sudo netselect -s {{n}} {{host_1}} {{host_2}} {{host_3}}` +`sudo netselect -s {{n}} {{host_1 host_2 host_3 ...}}` - Display help: diff --git a/pages/linux/nixos-option.md b/pages/linux/nixos-option.md index 161979226d..60b41cbddf 100644 --- a/pages/linux/nixos-option.md +++ b/pages/linux/nixos-option.md @@ -25,4 +25,4 @@ - Show recursively all values of a user: -`nixos-option -r users.users.{{user}}` +`nixos-option {{[-r|--recursive]}} users.users.{{user}}` diff --git a/pages/linux/nixos-rebuild.md b/pages/linux/nixos-rebuild.md index 02a80aa3c7..800107e616 100644 --- a/pages/linux/nixos-rebuild.md +++ b/pages/linux/nixos-rebuild.md @@ -9,7 +9,7 @@ - Build and switch to the new configuration, making it the boot default and naming the boot entry: -`sudo nixos-rebuild switch -p {{name}}` +`sudo nixos-rebuild switch {{[-p|--profile-name]}} {{name}}` - Build and switch to the new configuration, making it the boot default and installing updates: diff --git a/pages/linux/notify-send.md b/pages/linux/notify-send.md index 9a353331e5..cf040600fe 100644 --- a/pages/linux/notify-send.md +++ b/pages/linux/notify-send.md @@ -9,12 +9,12 @@ - Show a notification with a custom icon: -`notify-send -i {{icon.png}} "{{Test}}" "{{This is a test}}"` +`notify-send {{[-i|--icon]}} {{icon.png}} "{{Test}}" "{{This is a test}}"` - Show a notification for 5 seconds: -`notify-send -t 5000 "{{Test}}" "{{This is a test}}"` +`notify-send {{[-t|--expire-time]}} 5000 "{{Test}}" "{{This is a test}}"` - Show a notification with an app's icon and name: -`notify-send "{{Test}}" --icon={{google-chrome}} --app-name="{{Google Chrome}}"` +`notify-send "{{Test}}" {{[-i|--icon]}} {{google-chrome}} {{[-a|--app-name]}} "{{Google Chrome}}"` diff --git a/pages/linux/nsxiv.md b/pages/linux/nsxiv.md index d838f876de..956e09b397 100644 --- a/pages/linux/nsxiv.md +++ b/pages/linux/nsxiv.md @@ -13,7 +13,7 @@ - Search directories recursively for images to view: -`nsxiv -r {{path/to/directory1 path/to/directory2 ...}}` +`nsxiv {{[-r|--recursive]}} {{path/to/directory1 path/to/directory2 ...}}` - Quit nsxiv: diff --git a/pages/linux/ntpq.md b/pages/linux/ntpq.md index 2ce51dec1c..970a3f47fb 100644 --- a/pages/linux/ntpq.md +++ b/pages/linux/ntpq.md @@ -1,24 +1,24 @@ # ntpq > Query the Network Time Protocol (NTP) daemon. -> More information: . +> More information: . - Start `ntpq` in interactive mode: -`ntpq --interactive` +`ntpq` - Print a list of NTP peers: -`ntpq --peers` +`ntpq {{[-p|--peers]}}` - Print a list of NTP peers without resolving hostnames from IP addresses: -`ntpq --numeric --peers` +`ntpq {{[-n|--numeric]}} {{[-p|--peers]}}` - Use `ntpq` in debugging mode: -`ntpq --debug-level` +`ntpq {{[-d|--debug-level]}}` - Print NTP system variables values: -`ntpq --command={{rv}}` +`ntpq {{[-c|--command]}} {{rv}}` diff --git a/pages/linux/openfortivpn.md b/pages/linux/openfortivpn.md index 00fbb3fc19..437db47b21 100644 --- a/pages/linux/openfortivpn.md +++ b/pages/linux/openfortivpn.md @@ -1,15 +1,15 @@ # openfortivpn > A VPN client, for Fortinet's proprietary PPP+SSL VPN solution. -> More information: . +> More information: . - Connect to a VPN with a username and password: -`openfortivpn --username={{username}} --password={{password}}` +`openfortivpn {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}}` - Connect to a VPN using a specific configuration file (defaults to `/etc/openfortivpn/config`): -`sudo openfortivpn --config={{path/to/config}}` +`sudo openfortivpn {{[-c|--config]}} {{path/to/config}}` - Connect to a VPN by specifying the host and port: @@ -17,4 +17,4 @@ - Trust a given gateway by passing in its certificate's sha256 sum: -`openfortivpn --trusted-cert={{sha256_sum}}` +`openfortivpn --trusted-cert {{sha256_sum}}` diff --git a/pages/linux/paccache.md b/pages/linux/paccache.md index 5ba9697c29..3dedefd6f8 100644 --- a/pages/linux/paccache.md +++ b/pages/linux/paccache.md @@ -5,16 +5,16 @@ - Remove all but the 3 most recent package versions from the `pacman` cache: -`paccache -r` +`paccache {{[-r|--remove]}}` - Set the number of package versions to keep: -`paccache -rk {{num_versions}}` +`paccache {{[-rk|--remove --keep]}} {{num_versions}}` - Perform a dry-run and show the number of candidate packages for deletion: -`paccache -d` +`paccache {{[-d|--dryrun]}}` - Move candidate packages to a directory instead of deleting them: -`paccache -m {{path/to/directory}}` +`paccache {{[-m|--move]}} {{path/to/directory}}` diff --git a/pages/linux/pacdiff.md b/pages/linux/pacdiff.md index 4bf5e88bc6..9a2e0f89ec 100644 --- a/pages/linux/pacdiff.md +++ b/pages/linux/pacdiff.md @@ -9,11 +9,11 @@ - Use sudo and sudoedit to remove and merge files: -`pacdiff --sudo` +`pacdiff {{[-s|--sudo]}}` - Review files needing maintenance, creating `.bak`ups of the original if you `(O)verwrite`: -`pacdiff --sudo --backup` +`pacdiff {{[-s|--sudo]}} {{[-b|--backup]}}` - Use a specific editor to view and merge configuration files (default is `vim -d`): @@ -21,8 +21,8 @@ - Scan for configuration files with `locate` instead of using `pacman` database: -`pacdiff --locate` +`pacdiff {{[-l|--locate]}}` - Display help: -`pacdiff --help` +`pacdiff {{[-h|--help]}}` diff --git a/pages/linux/pasuspender.md b/pages/linux/pasuspender.md index 60a3f86280..2236fb9513 100644 --- a/pages/linux/pasuspender.md +++ b/pages/linux/pasuspender.md @@ -5,4 +5,4 @@ - Suspend PulseAudio while running `jackd`: -`pasuspender -- {{jackd -d alsa --device hw:0}}` +`pasuspender -- {{jackd {{[-d|--driver]}} alsa {{[-d|--device]}} hw:0}}` diff --git a/pages/linux/paxs.md b/pages/linux/paxs.md index 96ed0e67b1..be235280f1 100644 --- a/pages/linux/paxs.md +++ b/pages/linux/paxs.md @@ -10,20 +10,20 @@ - Upgrade all packages: -`paxs -u` +`paxs {{[-u|--upgrade-all]}}` - Install a package (prompting for the source): -`paxs -i {{package}}` +`paxs {{[-i|--install]}} {{package}}` - Remove a package (prompting for the source): -`paxs -r {{package}}` +`paxs {{[-r|--remove]}} {{package}}` - Check for updates across all package managers: -`paxs -c` +`paxs {{[-c|--check-update]}}` - Display help: -`paxs -h` +`paxs {{[-h|--help]}}` diff --git a/pages/linux/pdfattach.md b/pages/linux/pdfattach.md index 063847fcb4..b7f4ac69a7 100644 --- a/pages/linux/pdfattach.md +++ b/pages/linux/pdfattach.md @@ -14,7 +14,7 @@ - Display help: -`pdfattach -h` +`pdfattach {{[-h|--help]}}` - Display version: diff --git a/pages/linux/pdfxup.md b/pages/linux/pdfxup.md index b73ccbee1b..96a6f65423 100644 --- a/pages/linux/pdfxup.md +++ b/pages/linux/pdfxup.md @@ -6,12 +6,12 @@ - Create a 2-up PDF: -`pdfxup -o {{path/to/output.pdf}} {{path/to/input.pdf}}` +`pdfxup {{[-o|--output]}} {{path/to/output.pdf}} {{path/to/input.pdf}}` - Create a PDF with 3 columns and 2 lines per page: -`pdfxup -x {{3}} -y {{2}} -o {{path/to/output.pdf}} {{path/to/input.pdf}}` +`pdfxup {{[-x|--columns]}} {{3}} {{[-y|--rows]}} {{2}} {{[-o|--output]}} {{path/to/output.pdf}} {{path/to/input.pdf}}` - Create a PDF in booklet mode (2-up, and pages are sorted to form a book when folded): -`pdfxup -b -o {{path/to/output.pdf}} {{path/to/input.pdf}}` +`pdfxup {{[-b|--booklet]}} {{[-o|--output]}} {{path/to/output.pdf}} {{path/to/input.pdf}}` diff --git a/pages/linux/perf.md b/pages/linux/perf.md index c9babf1165..f3f2a440c0 100644 --- a/pages/linux/perf.md +++ b/pages/linux/perf.md @@ -17,7 +17,7 @@ - Record the profile of an existing process into `perf.data`: -`sudo perf record -p {{pid}}` +`sudo perf record {{[-p|--pid]}} {{pid}}` - Read `perf.data` (created by `perf record`) and display the profile: diff --git a/pages/linux/perl-rename.md b/pages/linux/perl-rename.md index f4b745332e..77e6f9d421 100644 --- a/pages/linux/perl-rename.md +++ b/pages/linux/perl-rename.md @@ -10,7 +10,7 @@ - Dry-run - display which renames would occur without performing them: -`rename -n {{'s/foo/bar/'}} {{*}}` +`rename {{[-n|--no-act]}} {{'s/foo/bar/'}} {{*}}` - Force renaming even if the operation would remove existing destination files: diff --git a/pages/linux/photorec.md b/pages/linux/photorec.md index b2d6c2e3e3..1dafd2da0b 100644 --- a/pages/linux/photorec.md +++ b/pages/linux/photorec.md @@ -2,7 +2,7 @@ > Deleted file recovery tool. > It is recommended to write recovered files to a disk separate to the one being recovered from. -> More information: . +> More information: . - Run PhotoRec on a specific device: diff --git a/pages/linux/picom.md b/pages/linux/picom.md index afef0879f1..983c4c3260 100644 --- a/pages/linux/picom.md +++ b/pages/linux/picom.md @@ -9,7 +9,7 @@ - Start `picom` as a background process: -`picom -b` +`picom {{[-b|--daemon]}}` - Use a custom configuration file: diff --git a/pages/linux/pinout.md b/pages/linux/pinout.md index f3cad108b2..03bf470489 100644 --- a/pages/linux/pinout.md +++ b/pages/linux/pinout.md @@ -9,4 +9,4 @@ - Open in the default browser: -`pinout -x` +`pinout {{[-x|--xyz]}}` diff --git a/pages/linux/pkginfo.md b/pages/linux/pkginfo.md index df429a0673..026f96885b 100644 --- a/pages/linux/pkginfo.md +++ b/pages/linux/pkginfo.md @@ -5,15 +5,15 @@ - List installed packages and their versions: -`pkginfo -i` +`pkginfo {{[-i|--installed]}}` - List files owned by a package: -`pkginfo -l {{package}}` +`pkginfo {{[-l|--list]}} {{package}}` - List the owner(s) of files matching a pattern: -`pkginfo -o {{pattern}}` +`pkginfo {{[-o|--owner]}} {{pattern}}` - Print the footprint of a file: diff --git a/pages/linux/pmount.md b/pages/linux/pmount.md index c5c1ec3cf1..c6f995f32b 100644 --- a/pages/linux/pmount.md +++ b/pages/linux/pmount.md @@ -9,15 +9,15 @@ - Mount a device with a specific filesystem type to `/media/label`: -`pmount --type {{filesystem}} {{/dev/to/block/device}} {{label}}` +`pmount {{[-t|--type]}} {{filesystem}} {{/dev/to/block/device}} {{label}}` - Mount a CD-ROM (filesystem type ISO9660) in read-only mode: -`pmount --type {{iso9660}} --read-only {{/dev/cdrom}}` +`pmount {{[-t|--type]}} iso9660 {{[-r|--read-only]}} {{/dev/cdrom}}` - Mount an NTFS-formatted disk, forcing read-write access: -`pmount --type {{ntfs}} --read-write {{/dev/sdX}}` +`pmount {{[-t|--type]}} ntfs {{[-w|--read-write]}} {{/dev/sdX}}` - Display all mounted removable devices: diff --git a/pages/linux/prename.md b/pages/linux/prename.md index 04835f4e72..75f8888853 100644 --- a/pages/linux/prename.md +++ b/pages/linux/prename.md @@ -10,11 +10,11 @@ - Dry-run - display which renames would occur without performing them: -`rename -n {{'s/foo/bar/'}} {{*}}` +`rename {{[-n|--nono]}} {{'s/foo/bar/'}} {{*}}` - Force renaming even if the operation would remove existing destination files: -`rename -f {{'s/foo/bar/'}} {{*}}` +`rename {{[-f|--force]}} {{'s/foo/bar/'}} {{*}}` - Convert filenames to lower case (use `-f` in case-insensitive filesystems to prevent "already exists" errors): diff --git a/pages/linux/pridecat.md b/pages/linux/pridecat.md index ccbf3c70c7..f1b573ef85 100644 --- a/pages/linux/pridecat.md +++ b/pages/linux/pridecat.md @@ -1,6 +1,6 @@ # pridecat -> Like cat but more colorful :). +> Like cat but more colorful. > More information: . - Print the contents of a file in pride colors to `stdout`: @@ -9,15 +9,15 @@ - Print contents of a file in trans colors: -`pridecat {{path/to/file}} --{{transgender|trans}}` +`pridecat {{path/to/file}} {{[--trans|--transgender]}}` - Alternate between lesbian and bisexual pride flags: -`pridecat {{path/to/file}} --lesbian --bi` +`pridecat {{path/to/file}} --lesbian {{[--bi|--bisexual]}}` - Print contents of a file with the background colors changed: -`pridecat {{path/to/file}} -b` +`pridecat {{path/to/file}} {{[-b|--background]}}` - List directory contents in pride flag colors: diff --git a/pages/linux/protonvpn-connect.md b/pages/linux/protonvpn-connect.md index 5fa3232d67..e8f56d8865 100644 --- a/pages/linux/protonvpn-connect.md +++ b/pages/linux/protonvpn-connect.md @@ -25,4 +25,4 @@ - Display help: -`protonvpn connect --help` +`protonvpn {{[c|connect]}} --help` diff --git a/pages/linux/pvs.md b/pages/linux/pvs.md index 5236b8b40c..ef6a9978ae 100644 --- a/pages/linux/pvs.md +++ b/pages/linux/pvs.md @@ -10,19 +10,19 @@ - Display non-physical volumes: -`pvs -a` +`pvs {{[-a|--all]}}` - Change default display to show more details: -`pvs -v` +`pvs {{[-v|--verbose]}}` - Display only specific fields: -`pvs -o {{field_name_1}},{{field_name_2}}` +`pvs {{[-o|--options]}} {{field_name_1}},{{field_name_2}}` - Append field to default display: -`pvs -o +{{field_name}}` +`pvs {{[-o|--options]}} +{{field_name}}` - Suppress heading line: diff --git a/pages/linux/pw-cat.md b/pages/linux/pw-cat.md index 089dbc6446..3face83ece 100644 --- a/pages/linux/pw-cat.md +++ b/pages/linux/pw-cat.md @@ -5,19 +5,19 @@ - Play a WAV file over the default target: -`pw-cat --playback {{path/to/file.wav}}` +`pw-cat {{[-p|--playback]}} {{path/to/file.wav}}` - Play a WAV file with a specified resampler quality (4 by default): -`pw-cat --quality {{0..15}} --playback {{path/to/file.wav}}` +`pw-cat {{[-q|--quality]}} {{0..15}} {{[-p|--playback]}} {{path/to/file.wav}}` - Record a sample recording at a volume level of 125%: -`pw-cat --record --volume {{1.25}} {{path/to/file.wav}}` +`pw-cat {{[-r|--record]}} --volume {{1.25}} {{path/to/file.wav}}` - Record a sample recording using a different sample rate: -`pw-cat --record --rate {{6000}} {{path/to/file.wav}}` +`pw-cat {{[-r|--record]}} --rate {{6000}} {{path/to/file.wav}}` - Display help: diff --git a/pages/linux/pw-loopback.md b/pages/linux/pw-loopback.md index a35288dfd8..d4d81d435d 100644 --- a/pages/linux/pw-loopback.md +++ b/pages/linux/pw-loopback.md @@ -9,20 +9,20 @@ - Create a loopback device that automatically connects to the speakers: -`pw-loopback -m '{{[FL FR]}}' --capture-props='{{media.class=Audio/Sink}}'` +`pw-loopback {{[-m|--channel-map]}} '{{[FL FR]}}' {{[-i|--capture-props]}} '{{media.class=Audio/Sink}}'` - Create a loopback device that automatically connects to the microphone: -`pw-loopback -m '{{[FL FR]}}' --playback-props='{{media.class=Audio/Source}}'` +`pw-loopback {{[-m|--channel-map]}} '{{[FL FR]}}' {{[-o|--playback-props]}} '{{media.class=Audio/Source}}'` - Create a dummy loopback device that doesn't automatically connect to anything: -`pw-loopback -m '{{[FL FR]}}' --capture-props='{{media.class=Audio/Sink}}' --playback-props='{{media.class=Audio/Source}}'` +`pw-loopback {{[-m|--channel-map]}} '{{[FL FR]}}' {{[-i|--capture-props]}} '{{media.class=Audio/Sink}}' {{[-o|--playback-props]}} '{{media.class=Audio/Source}}'` - Create a loopback device that automatically connects to the speakers and swaps the left and right channels between the sink and source: -`pw-loopback --capture-props='{{media.class=Audio/Sink audio.position=[FL FR]}}' --playback-props='{{audio.position=[FR FL]}}'` +`pw-loopback {{[-i|--capture-props]}} '{{media.class=Audio/Sink audio.position=[FL FR]}}' {{[-o|--playback-props]}} '{{audio.position=[FR FL]}}'` - Create a loopback device that automatically connects to the microphone and swaps the left and right channels between the sink and source: -`pw-loopback --capture-props='{{audio.position=[FR FL]}}' --playback-props='{{media.class=Audio/Source audio.position=[FL FR]}}'` +`pw-loopback {{[-i|--capture-props]}} '{{audio.position=[FR FL]}}' {{[-o|--playback-props]}} '{{media.class=Audio/Source audio.position=[FL FR]}}'` diff --git a/pages/linux/pw-mon.md b/pages/linux/pw-mon.md index c4351c95ee..60b3cfa96e 100644 --- a/pages/linux/pw-mon.md +++ b/pages/linux/pw-mon.md @@ -9,12 +9,12 @@ - Monitor a specific remote instance: -`pw-mon --remote={{remote_name}}` +`pw-mon {{[-r|--remote]}} {{remote_name}}` - Monitor the default instance specifying a color configuration: -`pw-mon --color={{never|always|auto}}` +`pw-mon {{[-N|--color]}} {{never|always|auto}}` - Display help: -`pw-mon --help` +`pw-mon {{[-h|--help]}}` diff --git a/pages/linux/pw-top.md b/pages/linux/pw-top.md index 68ed8f574e..7c82999d04 100644 --- a/pages/linux/pw-top.md +++ b/pages/linux/pw-top.md @@ -10,12 +10,12 @@ - Monitor a remote instance: -`pw-top --remote {{remote_name}}` +`pw-top {{[-r|--remote]}} {{remote_name}}` - Print information periodically instead of running in interactive mode: -`pw-top --batch-mode` +`pw-top {{[-b|--batch-mode]}}` - Print information periodically for a specific number of times: -`pw-top --batch-mode --iterations {{3}}` +`pw-top {{[-b|--batch-mode]}} {{[-n|--iterations]}} {{3}}` diff --git a/pages/linux/rankmirrors.md b/pages/linux/rankmirrors.md index beabb093d6..dcf1379000 100644 --- a/pages/linux/rankmirrors.md +++ b/pages/linux/rankmirrors.md @@ -14,12 +14,12 @@ - Be verbose when generating the mirrorlist: -`rankmirrors -v {{/etc/pacman.d/mirrorlist}}` +`rankmirrors {{[-v|--verbose]}} {{/etc/pacman.d/mirrorlist}}` - Test only a specific URL: -`rankmirrors --url {{url}}` +`rankmirrors {{[-u|--url]}} {{url}}` - Output only the response times instead of a full mirrorlist: -`rankmirrors --times {{/etc/pacman.d/mirrorlist}}` +`rankmirrors {{[-t|--times]}} {{/etc/pacman.d/mirrorlist}}` diff --git a/pages/linux/reportbug.md b/pages/linux/reportbug.md index 4fe8f1a7f9..bddc38b7e3 100644 --- a/pages/linux/reportbug.md +++ b/pages/linux/reportbug.md @@ -13,4 +13,4 @@ - Write the bug report to a file instead of sending it by e-mail: -`reportbug -o {{filename}} {{package}}` +`reportbug {{[-o|--output]}} {{filename}} {{package}}` diff --git a/pages/linux/repquota.md b/pages/linux/repquota.md index 083adbb653..5395373b02 100644 --- a/pages/linux/repquota.md +++ b/pages/linux/repquota.md @@ -5,24 +5,24 @@ - Report stats for all quotas in use: -`sudo repquota -all` +`sudo repquota {{[-a|--all]}}` - Report quota stats for all users, even those who aren't using any of their quota: -`sudo repquota -v {{filesystem}}` +`sudo repquota {{[-v|--verbose]}} {{filesystem}}` - Report on quotas for users only: -`repquota --user {{filesystem}}` +`repquota {{[-u|--user]}} {{filesystem}}` - Report on quotas for groups only: -`sudo repquota --group {{filesystem}}` +`sudo repquota {{[-g|--group]}} {{filesystem}}` - Report on used quota and limits in a human-readable format: -`sudo repquota --human-readable {{filesystem}}` +`sudo repquota {{[-s|--human-readable]}} {{filesystem}}` - Report on all quotas for users and groups in a human-readable format: -`sudo repquota -augs` +`sudo repquota {{[-augs|--all --user --group --human-readable]}}` diff --git a/pages/linux/resolveip.md b/pages/linux/resolveip.md index 32e55be9ba..5c1f622ec6 100644 --- a/pages/linux/resolveip.md +++ b/pages/linux/resolveip.md @@ -11,6 +11,6 @@ `resolveip {{1.1.1.1}}` -- Silent mode. Produces less output: +- Resolve a hostname to an IP address with less output: -`resolveip --silent {{example.org}}` +`resolveip {{[-s|--silent]}} {{example.org}}` diff --git a/pages/linux/rpcclient.md b/pages/linux/rpcclient.md index 50ef9f3ed1..193193ece1 100644 --- a/pages/linux/rpcclient.md +++ b/pages/linux/rpcclient.md @@ -5,19 +5,19 @@ - Connect to a remote host: -`rpcclient --user {{domain}}\{{username}}%{{password}} {{ip}}` +`rpcclient {{[-U|--user]}} {{domain}}\{{username}}%{{password}} {{ip}}` - Connect to a remote host on a domain without a password: -`rpcclient --user {{username}} --workgroup {{domain}} --no-pass {{ip}}` +`rpcclient {{[-U|--user]}} {{username}} {{[-W|--workgroup]}} {{domain}} {{[-N|--no-pass]}} {{ip}}` - Connect to a remote host, passing the password hash: -`rpcclient --user {{domain}}\{{username}} --pw-nt-hash {{ip}}` +`rpcclient {{[-U|--user]}} {{domain}}\{{username}} --pw-nt-hash {{ip}}` - Execute shell commands on a remote host: -`rpcclient --user {{domain}}\{{username}}%{{password}} --command {{semicolon_separated_commands}} {{ip}}` +`rpcclient {{[-U|--user]}} {{domain}}\{{username}}%{{password}} {{[-c|--command]}} {{semicolon_separated_commands}} {{ip}}` - Display domain users: diff --git a/pages/linux/rpicam-hello.md b/pages/linux/rpicam-hello.md index d815435447..51f9ac5ad3 100644 --- a/pages/linux/rpicam-hello.md +++ b/pages/linux/rpicam-hello.md @@ -5,7 +5,7 @@ - Display a camera preview stream for a specific amount of time (in milliseconds): -`rpicam-hello -t {{time}}` +`rpicam-hello {{[-t|--timeout]}} {{time}}` - Tune the configuration for a particular camera sensor: diff --git a/pages/linux/rpicam-jpeg.md b/pages/linux/rpicam-jpeg.md index 5a735d3118..e0712a4ee5 100644 --- a/pages/linux/rpicam-jpeg.md +++ b/pages/linux/rpicam-jpeg.md @@ -5,12 +5,12 @@ - Capture an image and name the file: -`rpicam-jpeg -o {{path/to/file.jpg}}` +`rpicam-jpeg {{[-o|--output]}} {{path/to/file.jpg}}` - Capture an image with set dimensions: -`rpicam-jpeg -o {{path/to/file.jpg}} --width {{1920}} --height {{1080}}` +`rpicam-jpeg {{[-o|--output]}} {{path/to/file.jpg}} --width {{1920}} --height {{1080}}` - Capture an image with an exposure of 20 seconds and a gain of 150%: -`rpicam-jpeg -o {{path/to/file.jpg}} --shutter 20000 --gain 1.5` +`rpicam-jpeg {{[-o|--output]}} {{path/to/file.jpg}} --shutter 20000 --gain 1.5` diff --git a/pages/linux/rpicam-raw.md b/pages/linux/rpicam-raw.md index 9b4fe5c5c9..cbcc3a8d00 100644 --- a/pages/linux/rpicam-raw.md +++ b/pages/linux/rpicam-raw.md @@ -5,8 +5,8 @@ - Capture a video for a specific amount of seconds: -`rpicam-raw -t {{2000}} -o {{path/to/file.raw}}` +`rpicam-raw {{[-t|--timeout]}} {{2000}} {{[-o|--output]}} {{path/to/file.raw}}` - Change video dimensions and framerate: -`rpicam-raw -t {{5000}} --width {{4056}} --height {{3040}} -o {{path/to/file.raw}} --framerate {{8}}` +`rpicam-raw {{[-t|--timeout]}} {{5000}} --width {{4056}} --height {{3040}} {{[-o|--output]}} {{path/to/file.raw}} --framerate {{8}}` diff --git a/pages/linux/rpicam-still.md b/pages/linux/rpicam-still.md index d82d6ae36f..5154958645 100644 --- a/pages/linux/rpicam-still.md +++ b/pages/linux/rpicam-still.md @@ -5,12 +5,12 @@ - Capture a photo with different encoding: -`rpicam-still -e {{bmp|png|rgb|yuv420}} -o {{path/to/file.{{bmp|png|rgb|yuv420}}}}` +`rpicam-still {{[-e|--encoding]}} {{bmp|png|rgb|yuv420}} {{[-o|--output]}} {{path/to/file.{{bmp|png|rgb|yuv420}}}}` - Capture a raw image: -`rpicam-still -r -o {{path/to/file.jpg}}` +`rpicam-still {{[-r|--raw]}} {{[-o|--output]}} {{path/to/file.jpg}}` - Capture a 100 second exposure image: -`rpicam-still -o {{path/to/file.jpg}} --shutter 100000` +`rpicam-still {{[-o|--output]}} {{path/to/file.jpg}} --shutter 100000` diff --git a/pages/linux/rpicam-vid.md b/pages/linux/rpicam-vid.md index ba4f23f09e..f5a2a00f8d 100644 --- a/pages/linux/rpicam-vid.md +++ b/pages/linux/rpicam-vid.md @@ -6,4 +6,4 @@ - Capture a 10 second video: -`rpicam-vid -t 10000 -o {{path/to/file.h264}}` +`rpicam-vid {{[-t|--timeout]}} 10000 {{[-o|--output]}} {{path/to/file.h264}}` diff --git a/pages/linux/rusnapshot.md b/pages/linux/rusnapshot.md index c1ef9f7648..10d54fc499 100644 --- a/pages/linux/rusnapshot.md +++ b/pages/linux/rusnapshot.md @@ -5,24 +5,24 @@ - Create a snapshot using a configuration file: -`sudo rusnapshot --config {{path/to/config.toml}} --cr` +`sudo rusnapshot {{[-c|--config]}} {{path/to/config.toml}} --cr` - List created snapshots: -`sudo rusnapshot -c {{path/to/config.toml}} --list` +`sudo rusnapshot {{[-c|--config]}} {{path/to/config.toml}} {{[-l|--list]}}` - Delete a snapshot by ID or the name of the snapshot: -`sudo rusnapshot -c {{path/to/config.toml}} --del --id {{snapshot_id}}` +`sudo rusnapshot {{[-c|--config]}} {{path/to/config.toml}} --del --id {{snapshot_id}}` - Delete all `hourly` snapshots: -`sudo rusnapshot -c {{path/to/config.toml}} --list --keep {{0}} --clean --kind {{hourly}}` +`sudo rusnapshot {{[-c|--config]}} {{path/to/config.toml}} {{[-l|--list]}} {{[-k|--keep]}} {{0}} --clean --kind {{hourly}}` - Create a read-write snapshot: -`sudo rusnapshot -c {{path/to/config.toml}} --cr --rw` +`sudo rusnapshot {{[-c|--config]}} {{path/to/config.toml}} --cr {{[-r|--rw]}}` - Restore a snapshot: -`sudo rusnapshot -c {{path/to/config.toml}} --id {{snapshot_id}} --restore` +`sudo rusnapshot {{[-c|--config]}} {{path/to/config.toml}} --id {{snapshot_id}} {{[-r|--restore]}}` diff --git a/pages/linux/sacct.md b/pages/linux/sacct.md index 639da463e2..93b8520bf9 100644 --- a/pages/linux/sacct.md +++ b/pages/linux/sacct.md @@ -9,20 +9,20 @@ - Display job ID, job state, job exit code for recent jobs: -`sacct --brief` +`sacct {{[-b|--brief]}}` - Display the allocations of a job: -`sacct --jobs {{job_id}} --allocations` +`sacct {{[-j|--jobs]}} {{job_id}} {{[-X|--allocations]}}` - Display elapsed time, job name, number of requested CPUs, and memory requested of a job: -`sacct --jobs {{job_id}} --format=Elapsed,JobName,ReqCPUS,ReqMem` +`sacct {{[-j|--jobs]}} {{job_id}} {{[-o|--format]}} Elapsed,JobName,ReqCPUS,ReqMem` - Display recent jobs that occurred from one week ago up to the present day: -`sacct --starttime=$(date -d "1 week ago" +'%F')` +`sacct {{[-S|--starttime]}} $(date {{[-d|--date]}} "1 week ago" +'%F')` - Output a larger number of characters for an attribute: -`sacct --format=JobID,JobName%100` +`sacct {{[-o|--format]}} JobID,JobName%100` diff --git a/pages/linux/salloc.md b/pages/linux/salloc.md index cd5d71ead7..d11ae4deaf 100644 --- a/pages/linux/salloc.md +++ b/pages/linux/salloc.md @@ -9,8 +9,8 @@ - Execute the specified command synchronously on a node in the cluster: -`salloc {{ls -a}}` +`salloc {{ls --all}}` - Only allocate nodes fulfilling the specified constraints: -`salloc --constraint={{(amd|intel)&gpu}}` +`salloc {{[-C|--constraint]}} {{(amd|intel)&gpu}}` diff --git a/pages/linux/sam.md b/pages/linux/sam.md index 5b1e996f95..ee5e72ba18 100644 --- a/pages/linux/sam.md +++ b/pages/linux/sam.md @@ -1,7 +1,7 @@ # sam > AWS Serverless Application Model (SAM) CLI. -> More information: . +> More information: . - Initialize a serverless application: @@ -9,7 +9,7 @@ - Initialize a serverless application with a specific runtime: -`sam init --runtime {{python3.7}}` +`sam init {{[-r|--runtime]}} {{python3.7}}` - Package a SAM application: diff --git a/pages/linux/scanimage.md b/pages/linux/scanimage.md index 6f374fc806..2aa3d2f56c 100644 --- a/pages/linux/scanimage.md +++ b/pages/linux/scanimage.md @@ -5,8 +5,8 @@ - List available scanners to ensure the target device is connected and recognized: -`scanimage -L` +`scanimage {{[-L|--list-devices]}}` - Scan an image and save it to a file: -`scanimage --format={{pnm|tiff|png|jpeg}} > {{path/to/new_image}}` +`scanimage --format {{pnm|tiff|png|jpeg}} > {{path/to/new_image}}` diff --git a/pages/linux/screenkey.md b/pages/linux/screenkey.md index 225a679e25..6e77fa090d 100644 --- a/pages/linux/screenkey.md +++ b/pages/linux/screenkey.md @@ -9,7 +9,7 @@ - Display keys and mouse buttons which are currently being pressed on the screen: -`screenkey --mouse` +`screenkey {{[-M|--mouse]}}` - Launch the settings menu of screenkey: @@ -17,7 +17,7 @@ - Launch screenkey at a specific position: -`screenkey --position {{top|center|bottom|fixed}}` +`screenkey {{[-p|--position]}} {{top|center|bottom|fixed}}` - Change the format of the key modifiers displayed on screen: @@ -25,8 +25,8 @@ - Change the appearance of screenkey: -`screenkey --bg-color "{{#a1b2c3}}" --font {{Hack}} --font-color {{yellow}} --opacity {{0.8}}` +`screenkey --bg-color "{{#a1b2c3}}" {{[-f|--font]}} {{Hack}} --font-color {{yellow}} --opacity {{0.8}}` - Drag and select a window on screen to display screenkey: -`screenkey --position fixed --geometry {{$(slop -n -f '%g')}}` +`screenkey {{[-p|--position]}} fixed {{[-g|--geometry]}} {{$(slop {{[-n|--nodecorations]}} {{[-f|--format]}} '%g')}}` diff --git a/pages/linux/sdiag.md b/pages/linux/sdiag.md index 5f5df241ac..4d74e1fab6 100644 --- a/pages/linux/sdiag.md +++ b/pages/linux/sdiag.md @@ -5,16 +5,16 @@ - Show all performance counters related to the execution of `slurmctld`: -`sdiag --all` +`sdiag {{[-a|--all]}}` - Reset performance counters related to the execution of `slurmctld`: -`sdiag --reset` +`sdiag {{[-r|--reset]}}` - Specify the output format: -`sdiag --all --{{json|yaml}}` +`sdiag {{[-a|--all]}} --{{json|yaml}}` - Specify the cluster to send commands to: -`sdiag --all --cluster={{cluster_name}}` +`sdiag {{[-a|--all]}} {{[-M|--cluster]}} {{cluster_name}}` diff --git a/pages/linux/semanage-fcontext.md b/pages/linux/semanage-fcontext.md index c795707040..7a17ffe198 100644 --- a/pages/linux/semanage-fcontext.md +++ b/pages/linux/semanage-fcontext.md @@ -6,19 +6,19 @@ - List all file labelling rules: -`sudo semanage fcontext --list` +`sudo semanage fcontext {{[-l|--list]}}` - List all user-defined file labelling rules without headings: -`sudo semanage fcontext --list --locallist --noheading` +`sudo semanage fcontext {{[-l|--list]}} {{[-C|--locallist]}} {{[-n|--noheading]}}` - Add a user-defined rule that labels any path which matches a PCRE regex: -`sudo semanage fcontext --add --type {{samba_share_t}} {{'/mnt/share(/.*)?'}}` +`sudo semanage fcontext {{[-a|--add]}} {{[-t|--type]}} {{samba_share_t}} {{'/mnt/share(/.*)?'}}` - Delete a user-defined rule using its PCRE regex: -`sudo semanage fcontext --delete {{'/mnt/share(/.*)?'}}` +`sudo semanage fcontext {{[-d|--delete]}} {{'/mnt/share(/.*)?'}}` - Relabel a directory recursively by applying the new rules: diff --git a/pages/linux/setfattr.md b/pages/linux/setfattr.md index e9581df120..2eeb70d298 100644 --- a/pages/linux/setfattr.md +++ b/pages/linux/setfattr.md @@ -5,12 +5,12 @@ - Set name of attribute for file: -`setfattr -n user.{{attribute_name}} {{path/to/file}}` +`setfattr {{[-n|--name]}} user.{{attribute_name}} {{path/to/file}}` - Set a user-defined value of an extended attribute on a file: -`setfattr -n user.{{attribute_name}} -v "{{value}}" {{path/to/file}}` +`setfattr {{[-n|--name]}} user.{{attribute_name}} {{[-v|--value]}} "{{value}}" {{path/to/file}}` - Remove a specific attribute of a file: -`setfattr -x user.{{attribute_name}} {{path/to/file}}` +`setfattr {{[-x|--remove]}} user.{{attribute_name}} {{path/to/file}}` diff --git a/pages/linux/sh5util.md b/pages/linux/sh5util.md index 50dc25a216..1c7f50d81c 100644 --- a/pages/linux/sh5util.md +++ b/pages/linux/sh5util.md @@ -5,12 +5,12 @@ - Merge HDF5 files produced on each allocated node for the specified job or step: -`sh5util --jobs={{job_id|job_id.step_id}}` +`sh5util {{[-j|--jobs]}} {{job_id|job_id.step_id}}` - Extract one or more data series from a merged job file: -`sh5util --jobs={{job_id|job_id.step_id}} --extract -i {{path/to/file.h5}} --series={{Energy|Filesystem|Network|Task}}` +`sh5util {{[-j|--jobs]}} {{job_id|job_id.step_id}} {{[-E|--extract]}} {{[-i|--input]}} {{path/to/file.h5}} {{[-s|--series]}} {{Energy|Filesystem|Network|Task}}` - Extract one data item from all nodes in a merged job file: -`sh5util --jobs={{job_id|job_id.step_id}} --item-extract --series={{Energy|Filesystem|Network|Task}} --data={{data_item}}` +`sh5util {{[-j|--jobs]}} {{job_id|job_id.step_id}} {{[-I|--item-extract]}} {{[-s|--series]}} {{Energy|Filesystem|Network|Task}} {{[-d|--data]}} {{data_item}}` diff --git a/pages/linux/sic.md b/pages/linux/sic.md index 3482ebf355..9d08b65a28 100644 --- a/pages/linux/sic.md +++ b/pages/linux/sic.md @@ -2,7 +2,7 @@ > Simple IRC client. > Part of the suckless tools. -> More information: . +> More information: . - Connect to the default host (irc.ofct.net) with the nickname set in the `$USER` environment variable: diff --git a/pages/linux/sinfo.md b/pages/linux/sinfo.md index 8a19136b96..6053ad0fcf 100644 --- a/pages/linux/sinfo.md +++ b/pages/linux/sinfo.md @@ -6,7 +6,7 @@ - Show a quick summary overview of the cluster: -`sinfo --summarize` +`sinfo {{[-s|--summarize]}}` - View the detailed status of all partitions across the entire cluster: @@ -14,16 +14,16 @@ - View the detailed status of a specific partition: -`sinfo --partition {{partition_name}}` +`sinfo {{[-p|--partition]}} {{partition_name}}` - View information about idle nodes: -`sinfo --states {{idle}}` +`sinfo {{[-t|--states]}} {{idle}}` - Summarise dead nodes: -`sinfo --dead` +`sinfo {{[-d|--dead]}}` - List dead nodes and the reasons why: -`sinfo --list-reasons` +`sinfo {{[-R|--list-reasons]}}` diff --git a/pages/linux/slop.md b/pages/linux/slop.md index 923427f3c0..8b42aa7155 100644 --- a/pages/linux/slop.md +++ b/pages/linux/slop.md @@ -9,16 +9,16 @@ - Double click, rather than click and drag, to draw a selection: -`slop -D` +`slop {{[-D|--nodrag]}}` - Highlight the selection rather than outlining it: -`slop -l` +`slop {{[-l|--highlight]}}` - Specify the output format: -`slop -f {{format_string}}` +`slop {{[-f|--format]}} {{format_string}}` - Specify the selection rectangle's color: -`slop -c {{red}},{{green}},{{blue}},{{alpha}}` +`slop {{[-c|--color]}} {{red}},{{green}},{{blue}},{{alpha}}` diff --git a/pages/linux/slurmrestd.md b/pages/linux/slurmrestd.md index d43bce6a45..accb828a56 100644 --- a/pages/linux/slurmrestd.md +++ b/pages/linux/slurmrestd.md @@ -5,7 +5,7 @@ - Change the group ID (and drop supplemental groups) before processing client requests: -`slurmrestd --g {{group_id}} {{[host]:port | unix:/path/to/socket}}` +`slurmrestd -g {{group_id}} {{[host]:port | unix:/path/to/socket}}` - Comma-delimited list of authentication plugins to load: diff --git a/pages/linux/sm.md b/pages/linux/sm.md index 192310d82e..1103ad25e9 100644 --- a/pages/linux/sm.md +++ b/pages/linux/sm.md @@ -9,19 +9,19 @@ - Display a message with inverted colors: -`sm -i "{{Hello World!}}"` +`sm {{[-i|--invert]}} "{{Hello World!}}"` - Display a message with a custom foreground color: -`sm -f {{blue}} "{{Hello World!}}"` +`sm {{[-f|--foreground]}} {{blue}} "{{Hello World!}}"` - Display a message with a custom background color: -`sm -b {{#008888}} "{{Hello World!}}"` +`sm {{[-b|--background]}} {{#008888}} "{{Hello World!}}"` - Display a message rotated 3 times (in steps of 90 degrees, counterclockwise): -`sm -r {{3}} "{{Hello World!}}"` +`sm {{[-r|--rotate]}} {{3}} "{{Hello World!}}"` - Display a message using the output from another command: diff --git a/pages/linux/smbget.md b/pages/linux/smbget.md index ed60024117..d2b83cca6c 100644 --- a/pages/linux/smbget.md +++ b/pages/linux/smbget.md @@ -13,8 +13,8 @@ - Connect with a username and password: -`smbget {{smb://server/share/file}} --user {{username%password}}` +`smbget {{smb://server/share/file}} {{[-U|--user]}} {{username%password}}` - Require encrypted transfers: -`smbget {{smb://server/share/file}} --encrypt` +`smbget {{smb://server/share/file}} {{[-e|--encrypt]}}` diff --git a/pages/linux/snapper.md b/pages/linux/snapper.md index f4e95d41c0..3d14006ba0 100644 --- a/pages/linux/snapper.md +++ b/pages/linux/snapper.md @@ -9,20 +9,20 @@ - Create snapper config: -`snapper -c {{config}} create-config {{path/to/directory}}` +`snapper {{[-c|--config]}} {{config}} create-config {{path/to/directory}}` - Create a snapshot with a description: -`snapper -c {{config}} create -d "{{snapshot_description}}"` +`snapper {{[-c|--config]}} {{config}} create {{[-d|--description]}} "{{snapshot_description}}"` - List snapshots for a config: -`snapper -c {{config}} list` +`snapper {{[-c|--config]}} {{config}} list` - Delete a snapshot: -`snapper -c {{config}} delete {{snapshot_number}}` +`snapper {{[-c|--config]}} {{config}} delete {{snapshot_number}}` - Delete a range of snapshots: -`snapper -c {{config}} delete {{snapshot1}}-{{snapshot2}}` +`snapper {{[-c|--config]}} {{config}} delete {{snapshot1}}-{{snapshot2}}` diff --git a/pages/linux/sport.md b/pages/linux/sport.md index 3ce0eb29de..db10403e6a 100644 --- a/pages/linux/sport.md +++ b/pages/linux/sport.md @@ -5,7 +5,7 @@ - Pull the list of SlackBuilds to run `sport` for the first time: -`sudo mkdir -p /usr/ports && sudo rsync -av rsync://slackbuilds.org /slackbuilds/$(awk '{print $2}' /etc/slackware-version)/ /usr/ports/` +`sudo mkdir {{[-p|--parents]}} /usr/ports && sudo rsync {{[-av|--archive --verbose]}} rsync://slackbuilds.org /slackbuilds/$(awk '{print $2}' /etc/slackware-version)/ /usr/ports/` - Pull in any updates to the system's tree via `rsync`: diff --git a/pages/linux/sprio.md b/pages/linux/sprio.md index aafcdcda7b..859564a73a 100644 --- a/pages/linux/sprio.md +++ b/pages/linux/sprio.md @@ -9,16 +9,16 @@ - View the factors determining the specified job's scheduling priority: -`sprio --jobs={{job_id_1,job_id_2,...}}` +`sprio {{[-j|--jobs]}} {{job_id_1,job_id_2,...}}` - Output additional information: -`sprio --long` +`sprio {{[-l|--long]}}` - View information for the jobs of specified users: -`sprio --user={{user_name_1,user_name_2,...}}` +`sprio {{[-u|--user]}} {{user_name_1,user_name_2,...}}` - Print the weights for each factor determining job scheduling priority: -`sprio --weights` +`sprio {{[-w|--weights]}}` diff --git a/pages/linux/squeue.md b/pages/linux/squeue.md index 4f777b8dcc..6e900d0f24 100644 --- a/pages/linux/squeue.md +++ b/pages/linux/squeue.md @@ -9,11 +9,11 @@ - View jobs queued by a specific user: -`squeue -u {{username}}` +`squeue {{[-u|--user]}} {{username}}` - View the queue and refresh every 5 seconds: -`squeue -i {{5}}` +`squeue {{[-i|--iterate]}} {{5}}` - View the queue with expected start times: diff --git a/pages/linux/sreport.md b/pages/linux/sreport.md index 8d9387f5be..899c58d4ea 100644 --- a/pages/linux/sreport.md +++ b/pages/linux/sreport.md @@ -5,7 +5,7 @@ - Show pipe delimited cluster utilization data: -`sreport --parsable cluster utilization` +`sreport {{[-p|--parsable]}} cluster utilization` - Show number of jobs run: diff --git a/pages/linux/srun.md b/pages/linux/srun.md index 141ecc6cf7..74623a337a 100644 --- a/pages/linux/srun.md +++ b/pages/linux/srun.md @@ -9,8 +9,8 @@ - Submit an interactive job with different attributes: -`srun --ntasks-per-node={{num_cores}} --mem-per-cpu={{memory_MB}} --pty /bin/bash` +`srun --ntasks-per-node {{num_cores}} --mem-per-cpu {{memory_MB}} --pty /bin/bash` - Connect to a worker node with a job running: -`srun --jobid={{job_id}} --pty /bin/bash` +`srun --jobid {{job_id}} --pty /bin/bash` diff --git a/pages/linux/sshare.md b/pages/linux/sshare.md index b85682d925..044f5592c6 100644 --- a/pages/linux/sshare.md +++ b/pages/linux/sshare.md @@ -13,8 +13,8 @@ - Control the fields to display: -`sshare --format={{format_string}}` +`sshare {{[-o|--format]}} {{format_string}}` - Display information for the specified users only: -`sshare --users={{user_id_1,user_id_2,...}}` +`sshare {{[-u|--users]}} {{user_id_1,user_id_2,...}}` diff --git a/pages/linux/sstat.md b/pages/linux/sstat.md index 308bb42d85..9bd18b411c 100644 --- a/pages/linux/sstat.md +++ b/pages/linux/sstat.md @@ -5,12 +5,12 @@ - Display status information of a comma-separated list of jobs: -`sstat --jobs={{job_id}}` +`sstat {{[-j|--jobs]}} {{job_id}}` - Display job ID, average CPU and average virtual memory size of a comma-separated list of jobs, with pipes as column delimiters: -`sstat --parsable --jobs={{job_id}} --format={{JobID,AveCPU,AveVMSize}}` +`sstat {{[-p|--parsable]}} {{[-j|--jobs]}} {{job_id}} {{[-o|--format]}} {{JobID,AveCPU,AveVMSize}}` - Display list of fields available: -`sstat --helpformat` +`sstat {{[-e|--helpformat]}}` diff --git a/pages/linux/stress.md b/pages/linux/stress.md index 573508a972..dfc6b4bca3 100644 --- a/pages/linux/stress.md +++ b/pages/linux/stress.md @@ -5,16 +5,16 @@ - Spawn 4 workers to stress test CPU: -`stress -c {{4}}` +`stress {{[-c|--cpu]}} {{4}}` - Spawn 2 workers to stress test IO and timeout after 5 seconds: -`stress -i {{2}} -t {{5}}` +`stress {{[-i|--io]}} {{2}} {{[-t|--timeout]}} {{5}}` - Spawn 2 workers to stress test memory (each worker allocates 256M bytes): -`stress -m {{2}} --vm-bytes {{256M}}` +`stress {{[-m|--vm]}} {{2}} --vm-bytes {{256M}}` - Spawn 2 workers spinning on write()/unlink() (each worker writes 1G bytes): -`stress -d {{2}} --hdd-bytes {{1GB}}` +`stress {{[-d|--hdd]}} {{2}} --hdd-bytes {{1GB}}` diff --git a/pages/linux/strigger.md b/pages/linux/strigger.md index 629e3500e3..f4cecd1cc3 100644 --- a/pages/linux/strigger.md +++ b/pages/linux/strigger.md @@ -6,11 +6,11 @@ - Register a new trigger. Execute the specified program when the specified event occurs: -`strigger --set --{{primary_database_failure|primary_slurmdbd_failure|primary_slurmctld_acct_buffer_full|primary_slurmctld_failure|...}} --program={{path/to/executable}}` +`strigger --set --{{primary_database_failure|primary_slurmdbd_failure|primary_slurmctld_acct_buffer_full|primary_slurmctld_failure|...}} {{[-p|--program]}} {{path/to/executable}}` - Execute the specified program when the specified job terminated: -`strigger --set --jobid={{job_id}} --fini --program="{{path/to/executable}} {{argument1 argument2 ...}}"` +`strigger --set {{[-j|--jobid]}} {{job_id}} {{[-f|--fini]}} {{[-p|--program]}} "{{path/to/executable}} {{argument1 argument2 ...}}"` - View active triggers: @@ -18,7 +18,7 @@ - View active triggers regarding the specified job: -`strigger --get --jobid={{job_id}}` +`strigger --get {{[-j|--jobid]}} {{job_id}}` - Clear the specified trigger: diff --git a/pages/linux/strip.md b/pages/linux/strip.md index ddab4a92d2..c6e1a19913 100644 --- a/pages/linux/strip.md +++ b/pages/linux/strip.md @@ -13,4 +13,4 @@ - Strip debug symbols only: -`strip --strip-debug {{path/to/file.o}}` +`strip {{[-d|--strip-debug]}} {{path/to/file.o}}` diff --git a/pages/linux/swaks.md b/pages/linux/swaks.md index 8ea0c90332..6459744cc9 100644 --- a/pages/linux/swaks.md +++ b/pages/linux/swaks.md @@ -5,20 +5,20 @@ - Deliver a standard test email to `user@example.com` on port 25 of `test-server.example.net`: -`swaks --to {{user@example.com}} --server {{test-server.example.net}}` +`swaks {{[-t|--to]}} {{user@example.com}} {{[-s|--server]}} {{test-server.example.net}}` - Deliver a standard test email, requiring CRAM-MD5 authentication as user `me@example.com`. An "X-Test" header will be added to the email body: -`swaks --to {{user@example.com}} --from {{me@example.com}} --auth {{CRAM-MD5}} --auth-user {{me@example.com}} --header-X-Test "{{test_email}}"` +`swaks {{[-t|--to]}} {{user@example.com}} {{[-f|--from]}} {{me@example.com}} {{[-a|--auth]}} {{CRAM-MD5}} {{[-au|--auth-user]}} {{me@example.com}} --header-X-Test "{{test_email}}"` - Test a virus scanner using EICAR in an attachment. Don't show the message DATA part: -`swaks -t {{user@example.com}} --attach - --server {{test-server.example.com}} --suppress-data {{path/to/eicar.txt}}` +`swaks {{[-t|--to]}} {{user@example.com}} --attach - {{[-s|--server]}} {{test-server.example.com}} {{[-n|--suppress-data]}} {{path/to/eicar.txt}}` - Test a spam scanner using GTUBE in the body of an email, routed via the MX records for `example.com`: -`swaks --to {{user@example.com}} --body {{path/to/gtube_file}}` +`swaks {{[-t|--to]}} {{user@example.com}} --body {{path/to/gtube_file}}` - Deliver a standard test email to `user@example.com` using the LMTP protocol via a UNIX domain socket file: -`swaks --to {{user@example.com}} --socket {{/var/lda.sock}} --protocol {{LMTP}}` +`swaks {{[-t|--to]}} {{user@example.com}} --socket {{/var/lda.sock}} --protocol {{LMTP}}` diff --git a/pages/linux/swww.md b/pages/linux/swww.md index 22a4df5cd6..ea55cd1ae5 100644 --- a/pages/linux/swww.md +++ b/pages/linux/swww.md @@ -8,9 +8,9 @@ `swww img {{path/to/image}}` -- Set wallpaper to specified [o]utputs: +- Set wallpaper to specified outputs: -`swww img -o {{output1,output2,...}} {{path/to/image}}` +`swww img {{[-o|--outputs]}} {{output1,output2,...}} {{path/to/image}}` - Restore last wallpaper: diff --git a/pages/linux/sysctl.md b/pages/linux/sysctl.md index d9eb53074f..4b7b36b556 100644 --- a/pages/linux/sysctl.md +++ b/pages/linux/sysctl.md @@ -5,11 +5,11 @@ - Show all available variables and their values: -`sysctl -a` +`sysctl {{[-a|--all]}}` - Set a changeable kernel state variable: -`sysctl -w {{section.tunable}}={{value}}` +`sysctl {{[-w|--write]}} {{section.tunable}}={{value}}` - Get currently open file handlers: @@ -21,4 +21,4 @@ - Apply changes from `/etc/sysctl.conf`: -`sysctl -p` +`sysctl {{[-p|--load]}}` diff --git a/pages/linux/sysdig.md b/pages/linux/sysdig.md index 8607f8c212..660921e59f 100644 --- a/pages/linux/sysdig.md +++ b/pages/linux/sysdig.md @@ -10,11 +10,11 @@ - Capture all the events from the live system and save them to disk: -`sysdig -w {{path/to/file}}.scap` +`sysdig {{[-w|--write]}} {{path/to/file}}.scap` - Read events from a file and print them to screen: -`sysdig -r {{path/to/file}}.scap` +`sysdig {{[-r|--read]}} {{path/to/file}}.scap` - Filter and Print all the open system calls invoked by cat: @@ -26,8 +26,8 @@ - List the available chisels: -`sysdig -cl` +`sysdig {{[-cl|--list-chisels]}}` - Use the spy_ip chisel to look at the data exchanged with ip address: -`sysdig -c spy_ip {{ip_address}}` +`sysdig {{[-c|--chisel]}} spy_ip {{ip_address}}` diff --git a/pages/linux/systemd-socket-activate.md b/pages/linux/systemd-socket-activate.md index b3d7334cbc..282245a904 100644 --- a/pages/linux/systemd-socket-activate.md +++ b/pages/linux/systemd-socket-activate.md @@ -21,4 +21,4 @@ - Activate a service with a specified port: -`systemd-socket-activate {{path/to/socket.service}} -l {{8080}}` +`systemd-socket-activate {{path/to/socket.service}} {{{[-l|--listen]}}} {{8080}}` diff --git a/pages/linux/tcptraceroute.md b/pages/linux/tcptraceroute.md index 56d750c0e2..141d4fe2e5 100644 --- a/pages/linux/tcptraceroute.md +++ b/pages/linux/tcptraceroute.md @@ -1,7 +1,7 @@ # tcptraceroute > A traceroute implementation using TCP packets. -> More information: . +> More information: . - Trace the route to a host: diff --git a/pages/linux/tic.md b/pages/linux/tic.md index daf307e7f4..4dbeda37b8 100644 --- a/pages/linux/tic.md +++ b/pages/linux/tic.md @@ -1,7 +1,7 @@ # tic > Compile terminfo and install for ncurses. -> More information: . +> More information: . - Compile and install terminfo for a terminal: diff --git a/pages/linux/timeshift.md b/pages/linux/timeshift.md index 0d33617c9b..bca54463b0 100644 --- a/pages/linux/timeshift.md +++ b/pages/linux/timeshift.md @@ -1,7 +1,7 @@ # timeshift > System restore utility. -> More information: . +> More information: . - List snapshots: diff --git a/pages/linux/tlp.md b/pages/linux/tlp.md index 6c43b43b58..ef923741c0 100644 --- a/pages/linux/tlp.md +++ b/pages/linux/tlp.md @@ -2,7 +2,7 @@ > Advanced power management for Linux. > See also `tlp-stat`. -> More information: . +> More information: . - Apply settings (according to the actual power source): diff --git a/pages/linux/toilet.md b/pages/linux/toilet.md index 4e4b84cea1..d052d55b49 100644 --- a/pages/linux/toilet.md +++ b/pages/linux/toilet.md @@ -9,12 +9,12 @@ - Generate ASCII art using a custom font file: -`toilet {{input_text}} -f {{font_filename}}` +`toilet {{input_text}} {{[-f|--font]}} {{font_filename}}` - Generate ASCII art using a filter: -`toilet {{input_text}} --filter {{filter_name}}` +`toilet {{input_text}} {{[-F|--filter]}} {{filter_name}}` - Show available toilet filters: -`toilet --filter list` +`toilet {{[-F|--filter]}} list` diff --git a/pages/linux/ttyplot.md b/pages/linux/ttyplot.md index db8881acdb..34592c72a3 100644 --- a/pages/linux/ttyplot.md +++ b/pages/linux/ttyplot.md @@ -3,13 +3,13 @@ > A realtime plotting utility for the command-line with data input from `stdin`. > More information: . -- Plot the values `1`, `2` and `3` (`cat` prevents ttyplot to exit): +- Plot the values `1`, `2` and `3` (Note: `cat` prevents `ttyplot` from exiting): -`{ echo {{1 2 3}}; cat } | ttyplot` +`{ echo {{1 2 3}}; cat; } | ttyplot` - Set a specific title and unit: -`{ echo {{1 2 3}}; cat } | ttyplot -t {{title}} -u {{unit}}` +`{ echo {{1 2 3}}; cat; } | ttyplot -t {{title}} -u {{unit}}` - Use a while loop to continuously plot random values: diff --git a/pages/linux/turbostat.md b/pages/linux/turbostat.md index a9f31180b5..f34d626d1d 100644 --- a/pages/linux/turbostat.md +++ b/pages/linux/turbostat.md @@ -9,7 +9,7 @@ - Display statistics every specified amount of seconds: -`sudo turbostat -i {{n_seconds}}` +`sudo turbostat {{[-i|--interval]}} {{n_seconds}}` - Do not decode and print the system configuration header information: @@ -17,7 +17,7 @@ - Display useful information about CPU every 1 second, without header information: -`sudo turbostat --quiet --interval 1 --cpu 0-{{CPU_thread_count}} --show "PkgWatt","Busy%","Core","CoreTmp","Thermal"` +`sudo turbostat --quiet {{[-i|--interval]}} 1 --cpu 0-{{CPU_thread_count}} --show "PkgWatt","Busy%","Core","CoreTmp","Thermal"` - Display help: diff --git a/pages/linux/unshadow.md b/pages/linux/unshadow.md index 5100f6fabd..67f9ff8ec1 100644 --- a/pages/linux/unshadow.md +++ b/pages/linux/unshadow.md @@ -1,7 +1,7 @@ # unshadow > Utility provided by the John the Ripper project to obtain the traditional Unix password file if the system uses shadow passwords. -> More information: . +> More information: . - Combine the `/etc/shadow` and `/etc/passwd` of the current system: diff --git a/pages/linux/unsquashfs.md b/pages/linux/unsquashfs.md index 2975a6b269..5cdb2fdc61 100644 --- a/pages/linux/unsquashfs.md +++ b/pages/linux/unsquashfs.md @@ -9,20 +9,20 @@ - Extract a squashfs filesystem to the specified directory: -`unsquashfs -dest {{path/to/directory}} {{filesystem.squashfs}}` +`unsquashfs {{[-d|-dest]}} {{path/to/directory}} {{filesystem.squashfs}}` - Display the names of files as they are extracted: -`unsquashfs -info {{filesystem.squashfs}}` +`unsquashfs {{[-i|-info]}} {{filesystem.squashfs}}` - Display the names of files and their attributes as they are extracted: -`unsquashfs -linfo {{filesystem.squashfs}}` +`unsquashfs {{[-li|-linfo]}} {{filesystem.squashfs}}` - List files inside the squashfs filesystem (without extracting): -`unsquashfs -ls {{filesystem.squashfs}}` +`unsquashfs {{[-l|-ls]}} {{filesystem.squashfs}}` - List files and their attributes inside the squashfs filesystem (without extracting): -`unsquashfs -lls {{filesystem.squashfs}}` +`unsquashfs {{[-ll|-lls]}} {{filesystem.squashfs}}` diff --git a/pages/linux/updpkgsums.md b/pages/linux/updpkgsums.md index 975e11a518..5836fd271e 100644 --- a/pages/linux/updpkgsums.md +++ b/pages/linux/updpkgsums.md @@ -10,8 +10,8 @@ - Display help: -`updpkgsums -h` +`updpkgsums {{[-h|--help]}}` - Display version: -`updpkgsums -v` +`updpkgsums {{[-v|--version]}}` diff --git a/pages/linux/urpme.md b/pages/linux/urpme.md index 2498732fe9..d88a2213c4 100644 --- a/pages/linux/urpme.md +++ b/pages/linux/urpme.md @@ -2,7 +2,7 @@ > Uninstall packages in Mageia. > See also: `urpmi`, `urpmi.update`, `urpmi.addmedia`, `urpmi.removemedia`, `urpmf`, `urpmq`. -> More information: . +> More information: . - Uninstall a package: diff --git a/pages/linux/urpmf.md b/pages/linux/urpmf.md index 61ec6926ad..ffb31dbf69 100644 --- a/pages/linux/urpmf.md +++ b/pages/linux/urpmf.md @@ -2,7 +2,7 @@ > Find files in packages and query information about them in Mageia. > See also: `urpmi`, `urpme`, `urpmi.addmedia`, `urpmi.removemedia`, `urpmi.update`, `urpmq`. -> More information: . +> More information: . - Search for packages that contain a file: diff --git a/pages/linux/urpmi.addmedia.md b/pages/linux/urpmi.addmedia.md index 5ecb2e0fa7..d59a8a44cc 100644 --- a/pages/linux/urpmi.addmedia.md +++ b/pages/linux/urpmi.addmedia.md @@ -3,7 +3,7 @@ > Add media in Mageia. > Note: Mageia documentation uses medium and repository as synonymous. > See also: `urpmi`, `urpmi.update`, `urpme`, `urpmi.removemedia`, `urpmf`, `urpmq`. -> More information: . +> More information: . - Add a medium: diff --git a/pages/linux/urpmi.md b/pages/linux/urpmi.md index ab77945497..e901b80ac7 100644 --- a/pages/linux/urpmi.md +++ b/pages/linux/urpmi.md @@ -2,7 +2,7 @@ > Install packages in Mageia. > See also: `urpm.update`, `urpme`, `urpmi.addmedia`, `urpmi.removemedia`, `urpmf`, `urpmq`. -> More information: . +> More information: . - Install a package from the repository or from a local RPM file: diff --git a/pages/linux/urpmi.removemedia.md b/pages/linux/urpmi.removemedia.md index 7b9c761c33..e00739d157 100644 --- a/pages/linux/urpmi.removemedia.md +++ b/pages/linux/urpmi.removemedia.md @@ -3,13 +3,13 @@ > Remove media in Mageia. > Note: Mageia documentation uses medium and repository as synonymous. > See also: `urpmi`, `urpme`, `urpmi.addmedia`, `urpmi.update`, `urpmf`, `urpmq`. -> More information: . +> More information: . - Remove a medium: `sudo urpmi.removemedia {{medium}}` -- Remove all media: +- Remove [a]ll media: `sudo urpmi.removemedia -a` diff --git a/pages/linux/urpmi.update.md b/pages/linux/urpmi.update.md index 86935ecbbc..24216b16f9 100644 --- a/pages/linux/urpmi.update.md +++ b/pages/linux/urpmi.update.md @@ -3,7 +3,7 @@ > Update the list of packages from a package repository in Mageia. > Note: Mageia documentation uses medium and repository as synonymous. > See also: `urpmi`, `urpme`, `urpmi.addmedia`, `urpmi.removemedia`, `urpmf`, `urpmq`. -> More information: . +> More information: . - Update all enabled media: diff --git a/pages/linux/urpmq.md b/pages/linux/urpmq.md index 5af1210fcb..ae4c768464 100644 --- a/pages/linux/urpmq.md +++ b/pages/linux/urpmq.md @@ -2,7 +2,7 @@ > Query information about packages and media in Mageia. > See also: `urpmi`, `urpmi.update`, `urpmi.addmedia`, `urpmi.removemedia`, `urpmf`, `urpme`. -> More information: . +> More information: . - Display information about an installable package: @@ -14,11 +14,11 @@ - Display direct and indirect dependencies of a package: -`urpmq --requires-recursive {{package}}` +`urpmq {{[-d|--requires-recursive]}} {{package}}` - List the not installed packages needed for an RPM file with their sources: -`sudo urpmq --requires-recursive -m --sources {{path/to/file.rpm}}` +`sudo urpmq {{[-d|--requires-recursive]}} -m --sources {{path/to/file.rpm}}` - List all configured media with their URLs, including inactive media: @@ -26,7 +26,7 @@ - Search for a package printing [g]roup, version and [r]elease: -`urpmq -g -r --fuzzy {{keyword}}` +`urpmq -g -r {{[-y|--fuzzy]}} {{keyword}}` - Search for a package with using its exact name: diff --git a/pages/linux/usbip.md b/pages/linux/usbip.md index c09d23d71b..7ecc4c959a 100644 --- a/pages/linux/usbip.md +++ b/pages/linux/usbip.md @@ -5,7 +5,7 @@ - List all local USB devices and their bus ID's: -`usbip list --local` +`usbip list {{[-l|--local]}}` - Start a `usbip` daemon on the server: @@ -13,7 +13,7 @@ - Bind a USB device to `usbip` on the server: -`sudo usbip bind --busid {{bus_id}}` +`sudo usbip bind {{[-b|--busid]}} {{bus_id}}` - Load the kernel module required by `usbip` on the client: @@ -21,7 +21,7 @@ - Attach to the `usbip` device on the client (bus ID is the same as on the server): -`sudo usbip attach -r {{ip_address}} --busid {{bus_id}}` +`sudo usbip attach {{[-r|--remote]}} {{ip_address}} {{[-b|--busid]}} {{bus_id}}` - List attached devices: @@ -29,8 +29,8 @@ - Detach from a device: -`sudo usbip detach --port {{port}}` +`sudo usbip detach {{[-p|--port]}} {{port}}` - Unbind a device: -`usbip unbind --busid {{bus_id}}` +`usbip unbind {{[-b|--busid]}} {{bus_id}}` diff --git a/pages/linux/uvcdynctrl.md b/pages/linux/uvcdynctrl.md index bdd32a384f..94ab9c1c57 100644 --- a/pages/linux/uvcdynctrl.md +++ b/pages/linux/uvcdynctrl.md @@ -5,28 +5,28 @@ - List all available cameras: -`uvcdynctrl -l` +`uvcdynctrl {{[-l|--list]}}` - Use a specific device (defaults to `video0`): -`uvcdynctrl -d {{device_name}}` +`uvcdynctrl {{[-d|--device]}} {{device_name}}` - List available controls: -`uvcdynctrl -c` +`uvcdynctrl {{[-c|--clist]}}` - Set a new control value (for negative values, use `-- -value`): -`uvcdynctrl -s {{control_name}} {{value}}` +`uvcdynctrl {{[-s|--set]}} {{control_name}} {{value}}` - Get the current control value: -`uvcdynctrl -g {{control_name}}` +`uvcdynctrl {{[-g|--get]}} {{control_name}}` - Save the state of the current controls to a file: -`uvcdynctrl -W {{filename}}` +`uvcdynctrl {{[-W|--save]}} {{filename}}` - Load the state of the controls from a file: -`uvcdynctrl -L {{filename}}` +`uvcdynctrl {{[-L|--load]}} {{filename}}` diff --git a/pages/linux/veracrypt.md b/pages/linux/veracrypt.md index cee9806610..170f212286 100644 --- a/pages/linux/veracrypt.md +++ b/pages/linux/veracrypt.md @@ -1,20 +1,20 @@ # veracrypt > Free and open source disk encryption software. -> More information: . +> More information: . - Create a new volume through a text user interface and use `/dev/urandom` as a source of random data: -`veracrypt --text --create --random-source={{/dev/urandom}}` +`veracrypt {{[-t|--text]}} {{[-c|--create]}} --random-source={{/dev/urandom}}` - Decrypt a volume interactively through a text user interface and mount it to a directory: -`veracrypt --text {{path/to/volume}} {{path/to/mount_point}}` +`veracrypt {{[-t|--text]}} {{path/to/volume}} {{path/to/mount_point}}` - Decrypt a partition using a keyfile and mount it to a directory: -`veracrypt --keyfiles={{path/to/keyfile}} {{/dev/sdXN}} {{path/to/mount_point}}` +`veracrypt {{[-k|--keyfiles]}} {{path/to/keyfile}} {{/dev/sdXN}} {{path/to/mount_point}}` - Dismount a volume on the directory it is mounted to: -`veracrypt --dismount {{path/to/mounted_point}}` +`veracrypt {{[-d|--dismount]}} {{path/to/mounted_point}}` diff --git a/pages/linux/vgs.md b/pages/linux/vgs.md index b09921167e..a75f64e660 100644 --- a/pages/linux/vgs.md +++ b/pages/linux/vgs.md @@ -10,19 +10,19 @@ - Display all volume groups: -`vgs -a` +`vgs {{[-a|--all]}}` - Change default display to show more details: -`vgs -v` +`vgs {{[-v|--verbose]}}` - Display only specific fields: -`vgs -o {{field_name_1}},{{field_name_2}}` +`vgs {{[-o|--options]}} {{field_name_1}},{{field_name_2}}` - Append field to default display: -`vgs -o +{{field_name}}` +`vgs {{[-o|--options]}} +{{field_name}}` - Suppress heading line: diff --git a/pages/linux/virt-viewer.md b/pages/linux/virt-viewer.md index 46ecc96424..f213748ec1 100644 --- a/pages/linux/virt-viewer.md +++ b/pages/linux/virt-viewer.md @@ -1,7 +1,7 @@ # virt-viewer > Minimal graphical interface for a virtual machine (VM). -> Note: 'domain' refers to the name, UUID or ID for the existing VMs (See: tldr virsh). +> Note: 'domain' refers to the name, UUID or ID for the existing VMs (See: `tldr virsh`). > More information: . - Launch `virt-viewer` with a prompt to select running virtual machines: diff --git a/pages/linux/virt-xml.md b/pages/linux/virt-xml.md index af831c7efb..80b5f30610 100644 --- a/pages/linux/virt-xml.md +++ b/pages/linux/virt-xml.md @@ -1,7 +1,7 @@ # virt-xml > Edit libvirt Domain XML files with explicit command-line options. -> Note: 'domain' refers to the name, UUID or ID for the existing VMs (See: tldr virsh). +> Note: 'domain' refers to the name, UUID or ID for the existing VMs (See: `tldr virsh`). > More information: . - List all the suboptions for a specific option: @@ -24,6 +24,6 @@ `virt-xml {{domain}} --edit --boot bootmenu={{on|off}}` -- Attach host USB hub to a running VM (See: tldr lsusb): +- Attach host USB hub to a running VM (See: `tldr lsusb`): `virt-xml {{domain}} --update --add-device --hostdev {{bus}}.{{device}}` diff --git a/pages/linux/vnstat.md b/pages/linux/vnstat.md index 230fddc458..7c655b4029 100644 --- a/pages/linux/vnstat.md +++ b/pages/linux/vnstat.md @@ -9,16 +9,16 @@ - Display traffic summary for a specific network interface: -`vnstat -i {{network_interface}}` +`vnstat {{[-i|--iface]}} {{network_interface}}` - Display live stats for a specific network interface: -`vnstat -l -i {{network_interface}}` +`vnstat {{[-l|--live]}} {{[-i|--iface]}} {{network_interface}}` - Show traffic statistics on an hourly basis for the last 24 hours using a bar graph: -`vnstat -hg` +`vnstat {{[-hg|--hoursgraph]}}` - Measure and show average traffic for 30 seconds: -`vnstat -tr {{30}}` +`vnstat {{[-tr|--traffic]}} {{30}}` diff --git a/pages/linux/wf-recorder.md b/pages/linux/wf-recorder.md index 129d781612..7d73f407ec 100644 --- a/pages/linux/wf-recorder.md +++ b/pages/linux/wf-recorder.md @@ -6,12 +6,12 @@ - Record storing to an MP4 file: -`wf-recorder --file={{output.mp4}}` +`wf-recorder {{[-f|--file]}} {{output.mp4}}` - Record including audio, both with mic and system sounds: -`wf-recorder --audio --file={{/path/to/file_with_audio.webm}}` +`wf-recorder {{[-a|--audio]}} {{[-f|--file]}} {{/path/to/file_with_audio.webm}}` - Select and record a portion of the screen using `slurp`, outputting to default `recording.mp4`: -`wf-recorder -g "$(slurp)"` +`wf-recorder {{[-g|--geometry]}} "$(slurp)"` diff --git a/pages/linux/wg-quick.md b/pages/linux/wg-quick.md index f663eefa95..81717cb171 100644 --- a/pages/linux/wg-quick.md +++ b/pages/linux/wg-quick.md @@ -1,7 +1,7 @@ # wg-quick > Quickly set up WireGuard tunnels based on config files. -> More information: . +> More information: . - Set up a VPN tunnel: diff --git a/pages/linux/xbacklight.md b/pages/linux/xbacklight.md index d8053354b0..45dc7f3993 100644 --- a/pages/linux/xbacklight.md +++ b/pages/linux/xbacklight.md @@ -1,7 +1,7 @@ # xbacklight > Utility to adjust backlight brightness using the RandR extension. -> More information: . +> More information: . - Get the current screen brightness as a percentage: diff --git a/pages/linux/xclip.md b/pages/linux/xclip.md index 6a57367a21..8cb9d92524 100644 --- a/pages/linux/xclip.md +++ b/pages/linux/xclip.md @@ -11,28 +11,28 @@ - Copy the output from a command to a given X11 selection area: -`echo 123 | xclip -selection {{primary|secondary|clipboard}}` +`echo 123 | xclip {{[-se|-selection]}} {{primary|secondary|clipboard}}` - Copy the output from a command to the system clipboard, using short notation: -`echo 123 | xclip -sel clip` +`echo 123 | xclip {{[-se|-selection]}} {{[c|clipboard]}}` - Copy the contents of a file into the system clipboard: -`xclip -sel clip {{input_file.txt}}` +`xclip {{[-se|-selection]}} {{[c|clipboard]}} {{input_file.txt}}` - Copy the contents of a PNG into the system clipboard (can be pasted in other programs correctly): -`xclip -sel clip -t image/png {{input_file.png}}` +`xclip {{[-se|-selection]}} {{[c|clipboard]}} {{[-t|-target]}} image/png {{input_file.png}}` - Copy the user input in the console into the system clipboard: -`xclip -i` +`xclip {{[-i|-in]}}` - Paste the contents of the X11 primary selection area to the console: -`xclip -o` +`xclip {{[-o|-out]}}` - Paste the contents of the system clipboard to the console: -`xclip -o -sel clip` +`xclip {{[-o|-out]}} {{[-se|-selection]}} {{[c|clipboard]}}` diff --git a/pages/linux/xrdb.md b/pages/linux/xrdb.md index 6b1f0ac166..e10c9d4937 100644 --- a/pages/linux/xrdb.md +++ b/pages/linux/xrdb.md @@ -1,7 +1,7 @@ # xrdb > X window server's resource database utility for Unix-like systems. -> More information: . +> More information: . - Start `xrdb` in interactive mode: diff --git a/pages/linux/xvfb-run.md b/pages/linux/xvfb-run.md index 01638a6f01..09a551c81f 100644 --- a/pages/linux/xvfb-run.md +++ b/pages/linux/xvfb-run.md @@ -1,7 +1,7 @@ # xvfb-run > Run a command in a virtual X server environment. -> More information: . +> More information: . - Run the specified command in a virtual X server: @@ -9,8 +9,8 @@ - Try to get a free server number, if the default (99) is not available: -`xvfb-run --auto-servernum {{command}}` +`xvfb-run {{[-a|--auto-servernum]}} {{command}}` - Pass arguments to the Xvfb server: -`xvfb-run --server-args "{{-screen 0 1024x768x24}}" {{command}}` +`xvfb-run {{[-s|--server-args]}} "{{-screen 0 1024x768x24}}" {{command}}` diff --git a/pages/linux/yay.md b/pages/linux/yay.md index 902a17c7b3..f0e0f59a9c 100644 --- a/pages/linux/yay.md +++ b/pages/linux/yay.md @@ -16,9 +16,9 @@ `yay -Sua` -- Install a new package from the repos and AUR: +- Install a new package from the repos and AUR and do not ask to confirm transactions: -`yay -S {{package}}` +`yay -S {{package}} --noconfirm` - Remove an installed package and both its dependencies and configuration files: diff --git a/pages/linux/yum.md b/pages/linux/yum.md index e5dd6322d8..1c38d9942f 100644 --- a/pages/linux/yum.md +++ b/pages/linux/yum.md @@ -10,7 +10,7 @@ - Install a new package and assume yes to all questions (also works with update, great for automated updates): -`yum -y install {{package}}` +`yum {{[-y|--assumeyes]}} install {{package}}` - Find the package that provides a particular command: diff --git a/pages/linux/znc.md b/pages/linux/znc.md new file mode 100644 index 0000000000..1f85887a5b --- /dev/null +++ b/pages/linux/znc.md @@ -0,0 +1,20 @@ +# znc + +> IRC bouncer. +> More information: . + +- Run the initial setup: + +`znc {{[-c|--makeconf]}}` + +- Start the IRC bouncer daemon: + +`znc` + +- Setup `znc` for systemd: + +`sudo {{[-u|--user]}} znc znc {{[-c|--makeconf]}} {{[-d|--datadir]}} /var/lib/znc` + +- Enable `znc` to start on boot and start it now: + +`systemctl enable znc --now` diff --git a/pages/netbsd/chpass.md b/pages/netbsd/chpass.md index 4b36cf34a3..c088d88783 100644 --- a/pages/netbsd/chpass.md +++ b/pages/netbsd/chpass.md @@ -2,7 +2,7 @@ > Add or change user database information, including login shell and password. > See also: `passwd`. -> More information: . +> More information: . - Set a specific login shell for the current user interactively: @@ -14,7 +14,7 @@ - Set a login [s]hell for a specific user: -`chpass chsh -s {{path/to/shell}} {{username}}` +`chpass -s {{path/to/shell}} {{username}}` - Specify a user database entry in the `passwd` file format: diff --git a/pages/openbsd/chpass.md b/pages/openbsd/chpass.md index ddd64cb223..28e4c1a1bb 100644 --- a/pages/openbsd/chpass.md +++ b/pages/openbsd/chpass.md @@ -2,20 +2,20 @@ > Add or change user database information, including login shell and password. > See also: `passwd`. -> More information: . +> More information: . - Set a specific login shell for the current user interactively: -`doas chsh` +`doas chpass` - Set a specific login [s]hell for the current user: -`doas chsh -s {{path/to/shell}}` +`doas chpass -s {{path/to/shell}}` - Set a login [s]hell for a specific user: -`doas chsh -s {{path/to/shell}} {{username}}` +`doas chpass -s {{path/to/shell}} {{username}}` - Specify a user database entry in the `passwd` file format: -`doas chsh -a {{username:encrypted_password:uid:gid:...}}` +`doas chpass -a {{username:encrypted_password:uid:gid:...}}` diff --git a/pages/osx/g[.md b/pages/osx/g[.md index eedf473dcc..c6abc75be4 100644 --- a/pages/osx/g[.md +++ b/pages/osx/g[.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux [` +`tldr {{[-p|--platform]}} linux [` diff --git a/pages/osx/gb2sum.md b/pages/osx/gb2sum.md index 19009418e7..b2c9af16bd 100644 --- a/pages/osx/gb2sum.md +++ b/pages/osx/gb2sum.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux b2sum` +`tldr {{[-p|--platform]}} linux b2sum` diff --git a/pages/osx/gbase32.md b/pages/osx/gbase32.md index 2a67837219..a7b6309bb2 100644 --- a/pages/osx/gbase32.md +++ b/pages/osx/gbase32.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux base32` +`tldr {{[-p|--platform]}} linux base32` diff --git a/pages/osx/gbase64.md b/pages/osx/gbase64.md index 04b5c7b8aa..152bfab459 100644 --- a/pages/osx/gbase64.md +++ b/pages/osx/gbase64.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux base64` +`tldr {{[-p|--platform]}} linux base64` diff --git a/pages/osx/gbasename.md b/pages/osx/gbasename.md index aa7e2b47fe..7f88fd3dd0 100644 --- a/pages/osx/gbasename.md +++ b/pages/osx/gbasename.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux basename` +`tldr {{[-p|--platform]}} linux basename` diff --git a/pages/osx/gbasenc.md b/pages/osx/gbasenc.md index d0f25f7e76..c65d0d7bac 100644 --- a/pages/osx/gbasenc.md +++ b/pages/osx/gbasenc.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux basenc` +`tldr {{[-p|--platform]}} linux basenc` diff --git a/pages/osx/gcat.md b/pages/osx/gcat.md index 44044260b6..1618f205a9 100644 --- a/pages/osx/gcat.md +++ b/pages/osx/gcat.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux cat` +`tldr {{[-p|--platform]}} linux cat` diff --git a/pages/osx/gchcon.md b/pages/osx/gchcon.md index 8170390bc4..04dbba6824 100644 --- a/pages/osx/gchcon.md +++ b/pages/osx/gchcon.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux chcon` +`tldr {{[-p|--platform]}} linux chcon` diff --git a/pages/osx/gchgrp.md b/pages/osx/gchgrp.md index 19a0161771..7e94cc1011 100644 --- a/pages/osx/gchgrp.md +++ b/pages/osx/gchgrp.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux chgrp` +`tldr {{[-p|--platform]}} linux chgrp` diff --git a/pages/osx/gchmod.md b/pages/osx/gchmod.md index dc5c3ca7ad..875366e1aa 100644 --- a/pages/osx/gchmod.md +++ b/pages/osx/gchmod.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux chmod` +`tldr {{[-p|--platform]}} linux chmod` diff --git a/pages/osx/gchown.md b/pages/osx/gchown.md index 3a81673f7d..d9d59f8465 100644 --- a/pages/osx/gchown.md +++ b/pages/osx/gchown.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux chown` +`tldr {{[-p|--platform]}} linux chown` diff --git a/pages/osx/gchroot.md b/pages/osx/gchroot.md index 4838e6f646..15fc62fbfc 100644 --- a/pages/osx/gchroot.md +++ b/pages/osx/gchroot.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux chroot` +`tldr {{[-p|--platform]}} linux chroot` diff --git a/pages/osx/gcksum.md b/pages/osx/gcksum.md index 870e641049..53b2038a02 100644 --- a/pages/osx/gcksum.md +++ b/pages/osx/gcksum.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux cksum` +`tldr {{[-p|--platform]}} linux cksum` diff --git a/pages/osx/gcomm.md b/pages/osx/gcomm.md index 1518490651..a4bf442045 100644 --- a/pages/osx/gcomm.md +++ b/pages/osx/gcomm.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux comm` +`tldr {{[-p|--platform]}} linux comm` diff --git a/pages/osx/gcp.md b/pages/osx/gcp.md index 726812a78c..59f0b7964f 100644 --- a/pages/osx/gcp.md +++ b/pages/osx/gcp.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux cp` +`tldr {{[-p|--platform]}} linux cp` diff --git a/pages/osx/gcsplit.md b/pages/osx/gcsplit.md index 5ba3541bc4..37b3ef940b 100644 --- a/pages/osx/gcsplit.md +++ b/pages/osx/gcsplit.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux csplit` +`tldr {{[-p|--platform]}} linux csplit` diff --git a/pages/osx/gcut.md b/pages/osx/gcut.md index 06e0407821..da3ce92199 100644 --- a/pages/osx/gcut.md +++ b/pages/osx/gcut.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux cut` +`tldr {{[-p|--platform]}} linux cut` diff --git a/pages/osx/gdate.md b/pages/osx/gdate.md index 5027fceb02..0593d997fe 100644 --- a/pages/osx/gdate.md +++ b/pages/osx/gdate.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux date` +`tldr {{[-p|--platform]}} linux date` diff --git a/pages/osx/gdd.md b/pages/osx/gdd.md index 7c8ee20e8c..ca460fcfec 100644 --- a/pages/osx/gdd.md +++ b/pages/osx/gdd.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux dd` +`tldr {{[-p|--platform]}} linux dd` diff --git a/pages/osx/gdf.md b/pages/osx/gdf.md index 097106cfed..099acdd6b8 100644 --- a/pages/osx/gdf.md +++ b/pages/osx/gdf.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux df` +`tldr {{[-p|--platform]}} linux df` diff --git a/pages/osx/gdir.md b/pages/osx/gdir.md index 5e474af6ba..f0dd0098d1 100644 --- a/pages/osx/gdir.md +++ b/pages/osx/gdir.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux dir` +`tldr {{[-p|--platform]}} linux dir` diff --git a/pages/osx/gdircolors.md b/pages/osx/gdircolors.md index b829c11c80..670c5aa9fc 100644 --- a/pages/osx/gdircolors.md +++ b/pages/osx/gdircolors.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux dircolors` +`tldr {{[-p|--platform]}} linux dircolors` diff --git a/pages/osx/gdirname.md b/pages/osx/gdirname.md index 56692ce5c7..b385a93f43 100644 --- a/pages/osx/gdirname.md +++ b/pages/osx/gdirname.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux dirname` +`tldr {{[-p|--platform]}} linux dirname` diff --git a/pages/osx/gdnsdomainname.md b/pages/osx/gdnsdomainname.md index 34dae3f26d..5b69a05e9e 100644 --- a/pages/osx/gdnsdomainname.md +++ b/pages/osx/gdnsdomainname.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux dnsdomainname` +`tldr {{[-p|--platform]}} linux dnsdomainname` diff --git a/pages/osx/gecho.md b/pages/osx/gecho.md index a3948cf22f..49ef0a0bc6 100644 --- a/pages/osx/gecho.md +++ b/pages/osx/gecho.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux echo` +`tldr {{[-p|--platform]}} linux echo` diff --git a/pages/osx/ged.md b/pages/osx/ged.md index a6eccda92b..d6b752bc02 100644 --- a/pages/osx/ged.md +++ b/pages/osx/ged.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux ed` +`tldr {{[-p|--platform]}} linux ed` diff --git a/pages/osx/gegrep.md b/pages/osx/gegrep.md index 2e50032ca8..275b795be1 100644 --- a/pages/osx/gegrep.md +++ b/pages/osx/gegrep.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux egrep` +`tldr {{[-p|--platform]}} linux egrep` diff --git a/pages/osx/genv.md b/pages/osx/genv.md index 4d99206d2a..8c6af929af 100644 --- a/pages/osx/genv.md +++ b/pages/osx/genv.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux env` +`tldr {{[-p|--platform]}} linux env` diff --git a/pages/osx/gexpand.md b/pages/osx/gexpand.md index 1f72cd159e..75f4e590ad 100644 --- a/pages/osx/gexpand.md +++ b/pages/osx/gexpand.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux expand` +`tldr {{[-p|--platform]}} linux expand` diff --git a/pages/osx/gexpr.md b/pages/osx/gexpr.md index 38a17b54fa..e62aed6674 100644 --- a/pages/osx/gexpr.md +++ b/pages/osx/gexpr.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux expr` +`tldr {{[-p|--platform]}} linux expr` diff --git a/pages/osx/gfactor.md b/pages/osx/gfactor.md index 3a5bde40dd..7b5dd0d748 100644 --- a/pages/osx/gfactor.md +++ b/pages/osx/gfactor.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux factor` +`tldr {{[-p|--platform]}} linux factor` diff --git a/pages/osx/gfalse.md b/pages/osx/gfalse.md index 9bf3d23671..79f39c59e1 100644 --- a/pages/osx/gfalse.md +++ b/pages/osx/gfalse.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux false` +`tldr {{[-p|--platform]}} linux false` diff --git a/pages/osx/gfgrep.md b/pages/osx/gfgrep.md index ffbf829958..7280949b10 100644 --- a/pages/osx/gfgrep.md +++ b/pages/osx/gfgrep.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux fgrep` +`tldr {{[-p|--platform]}} linux fgrep` diff --git a/pages/osx/gfind.md b/pages/osx/gfind.md index 8dd6664bf6..e23467d3cb 100644 --- a/pages/osx/gfind.md +++ b/pages/osx/gfind.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux find` +`tldr {{[-p|--platform]}} linux find` diff --git a/pages/osx/gfmt.md b/pages/osx/gfmt.md index 10c8617c12..a3691515ed 100644 --- a/pages/osx/gfmt.md +++ b/pages/osx/gfmt.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux fmt` +`tldr {{[-p|--platform]}} linux fmt` diff --git a/pages/osx/gfold.md b/pages/osx/gfold.md index a90f4d4569..422a40577a 100644 --- a/pages/osx/gfold.md +++ b/pages/osx/gfold.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux fold` +`tldr {{[-p|--platform]}} linux fold` diff --git a/pages/osx/gftp.md b/pages/osx/gftp.md index 590677cd57..a6e623a9c3 100644 --- a/pages/osx/gftp.md +++ b/pages/osx/gftp.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux ftp` +`tldr {{[-p|--platform]}} linux ftp` diff --git a/pages/osx/ggrep.md b/pages/osx/ggrep.md index 46c87b52cf..c839ca6afe 100644 --- a/pages/osx/ggrep.md +++ b/pages/osx/ggrep.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux grep` +`tldr {{[-p|--platform]}} linux grep` diff --git a/pages/osx/ggroups.md b/pages/osx/ggroups.md index ec92f3aaf3..6007535b28 100644 --- a/pages/osx/ggroups.md +++ b/pages/osx/ggroups.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux groups` +`tldr {{[-p|--platform]}} linux groups` diff --git a/pages/osx/ghead.md b/pages/osx/ghead.md index 9120480dda..186e95f066 100644 --- a/pages/osx/ghead.md +++ b/pages/osx/ghead.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux head` +`tldr {{[-p|--platform]}} linux head` diff --git a/pages/osx/ghostid.md b/pages/osx/ghostid.md index aa135413f4..81a8feb416 100644 --- a/pages/osx/ghostid.md +++ b/pages/osx/ghostid.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux hostid` +`tldr {{[-p|--platform]}} linux hostid` diff --git a/pages/osx/ghostname.md b/pages/osx/ghostname.md index 4161b75399..5b7ef3091c 100644 --- a/pages/osx/ghostname.md +++ b/pages/osx/ghostname.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux hostname` +`tldr {{[-p|--platform]}} linux hostname` diff --git a/pages/osx/gid.md b/pages/osx/gid.md index e2668f0f3a..19cf08735e 100644 --- a/pages/osx/gid.md +++ b/pages/osx/gid.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux id` +`tldr {{[-p|--platform]}} linux id` diff --git a/pages/osx/gifconfig.md b/pages/osx/gifconfig.md index 7dfe9e29cc..38b4b8fd5b 100644 --- a/pages/osx/gifconfig.md +++ b/pages/osx/gifconfig.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux ifconfig` +`tldr {{[-p|--platform]}} linux ifconfig` diff --git a/pages/osx/gindent.md b/pages/osx/gindent.md index 5be586f4de..f5f09d97a7 100644 --- a/pages/osx/gindent.md +++ b/pages/osx/gindent.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux indent` +`tldr {{[-p|--platform]}} linux indent` diff --git a/pages/osx/ginstall.md b/pages/osx/ginstall.md index 18d9759d94..262169fc0f 100644 --- a/pages/osx/ginstall.md +++ b/pages/osx/ginstall.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux install` +`tldr {{[-p|--platform]}} linux install` diff --git a/pages/osx/gjoin.md b/pages/osx/gjoin.md index 995f29e504..7f42a4cb84 100644 --- a/pages/osx/gjoin.md +++ b/pages/osx/gjoin.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux join` +`tldr {{[-p|--platform]}} linux join` diff --git a/pages/osx/gkill.md b/pages/osx/gkill.md index c8d30bea44..8ad60744de 100644 --- a/pages/osx/gkill.md +++ b/pages/osx/gkill.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux kill` +`tldr {{[-p|--platform]}} linux kill` diff --git a/pages/osx/glibtool.md b/pages/osx/glibtool.md index 7eb159b55d..e7c54b6045 100644 --- a/pages/osx/glibtool.md +++ b/pages/osx/glibtool.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux libtool` +`tldr {{[-p|--platform]}} linux libtool` diff --git a/pages/osx/glibtoolize.md b/pages/osx/glibtoolize.md index e9136235e5..2d2346869c 100644 --- a/pages/osx/glibtoolize.md +++ b/pages/osx/glibtoolize.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux libtoolize` +`tldr {{[-p|--platform]}} linux libtoolize` diff --git a/pages/osx/glink.md b/pages/osx/glink.md index 55355110c6..aaeb2a7222 100644 --- a/pages/osx/glink.md +++ b/pages/osx/glink.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux link` +`tldr {{[-p|--platform]}} linux link` diff --git a/pages/osx/gln.md b/pages/osx/gln.md index cdcc107df0..dc151beb85 100644 --- a/pages/osx/gln.md +++ b/pages/osx/gln.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux ln` +`tldr {{[-p|--platform]}} linux ln` diff --git a/pages/osx/glocate.md b/pages/osx/glocate.md index d56c40bff3..74c8ef21d5 100644 --- a/pages/osx/glocate.md +++ b/pages/osx/glocate.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux locate` +`tldr {{[-p|--platform]}} linux locate` diff --git a/pages/osx/glogger.md b/pages/osx/glogger.md index 87e73d0d32..48907d7dbe 100644 --- a/pages/osx/glogger.md +++ b/pages/osx/glogger.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux logger` +`tldr {{[-p|--platform]}} linux logger` diff --git a/pages/osx/glogname.md b/pages/osx/glogname.md index 84c528e354..2283c8c9c4 100644 --- a/pages/osx/glogname.md +++ b/pages/osx/glogname.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux logname` +`tldr {{[-p|--platform]}} linux logname` diff --git a/pages/osx/gls.md b/pages/osx/gls.md index 43a5350cf8..79be1296ed 100644 --- a/pages/osx/gls.md +++ b/pages/osx/gls.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux ls` +`tldr {{[-p|--platform]}} linux ls` diff --git a/pages/osx/gmake.md b/pages/osx/gmake.md index b6f43f8b44..662656d5b2 100644 --- a/pages/osx/gmake.md +++ b/pages/osx/gmake.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux make` +`tldr {{[-p|--platform]}} linux make` diff --git a/pages/osx/gmd5sum.md b/pages/osx/gmd5sum.md index 015dfa4e68..1bed835784 100644 --- a/pages/osx/gmd5sum.md +++ b/pages/osx/gmd5sum.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux md5sum` +`tldr {{[-p|--platform]}} linux md5sum` diff --git a/pages/osx/gmkdir.md b/pages/osx/gmkdir.md index 0564d7857f..86009ce1eb 100644 --- a/pages/osx/gmkdir.md +++ b/pages/osx/gmkdir.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux mkdir` +`tldr {{[-p|--platform]}} linux mkdir` diff --git a/pages/osx/gmkfifo.md b/pages/osx/gmkfifo.md index 62ea21cc36..24cf6ac0bb 100644 --- a/pages/osx/gmkfifo.md +++ b/pages/osx/gmkfifo.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux mkfifo` +`tldr {{[-p|--platform]}} linux mkfifo` diff --git a/pages/osx/gmknod.md b/pages/osx/gmknod.md index a5e7f17d58..e0e6b53df8 100644 --- a/pages/osx/gmknod.md +++ b/pages/osx/gmknod.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux mknod` +`tldr {{[-p|--platform]}} linux mknod` diff --git a/pages/osx/gmktemp.md b/pages/osx/gmktemp.md index be99b72aa9..d2cfa35f60 100644 --- a/pages/osx/gmktemp.md +++ b/pages/osx/gmktemp.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux mktemp` +`tldr {{[-p|--platform]}} linux mktemp` diff --git a/pages/osx/gmv.md b/pages/osx/gmv.md index 779755bc87..84ad29b573 100644 --- a/pages/osx/gmv.md +++ b/pages/osx/gmv.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux mv` +`tldr {{[-p|--platform]}} linux mv` diff --git a/pages/osx/gnice.md b/pages/osx/gnice.md index 462548209e..9871593791 100644 --- a/pages/osx/gnice.md +++ b/pages/osx/gnice.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux nice` +`tldr {{[-p|--platform]}} linux nice` diff --git a/pages/osx/gnl.md b/pages/osx/gnl.md index 6edb948387..6dec63cdf3 100644 --- a/pages/osx/gnl.md +++ b/pages/osx/gnl.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux nl` +`tldr {{[-p|--platform]}} linux nl` diff --git a/pages/osx/gnohup.md b/pages/osx/gnohup.md index 9dc722dbcf..cb45f7a71b 100644 --- a/pages/osx/gnohup.md +++ b/pages/osx/gnohup.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux nohup` +`tldr {{[-p|--platform]}} linux nohup` diff --git a/pages/osx/gnproc.md b/pages/osx/gnproc.md index a9149ea679..78c75f2b1c 100644 --- a/pages/osx/gnproc.md +++ b/pages/osx/gnproc.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux nproc` +`tldr {{[-p|--platform]}} linux nproc` diff --git a/pages/osx/god.md b/pages/osx/god.md index dfbea28a00..eb06e2dc8f 100644 --- a/pages/osx/god.md +++ b/pages/osx/god.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux od` +`tldr {{[-p|--platform]}} linux od` diff --git a/pages/osx/gpaste.md b/pages/osx/gpaste.md index 68365be575..a392d70f3d 100644 --- a/pages/osx/gpaste.md +++ b/pages/osx/gpaste.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux paste` +`tldr {{[-p|--platform]}} linux paste` diff --git a/pages/osx/gpathchk.md b/pages/osx/gpathchk.md index 0676e2e9d6..d4fe45a4cb 100644 --- a/pages/osx/gpathchk.md +++ b/pages/osx/gpathchk.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux pathchk` +`tldr {{[-p|--platform]}} linux pathchk` diff --git a/pages/osx/gping.md b/pages/osx/gping.md index 1932c2462a..911c066921 100644 --- a/pages/osx/gping.md +++ b/pages/osx/gping.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux ping` +`tldr {{[-p|--platform]}} linux ping` diff --git a/pages/osx/gping6.md b/pages/osx/gping6.md index 910d360260..1eb3041913 100644 --- a/pages/osx/gping6.md +++ b/pages/osx/gping6.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux ping6` +`tldr {{[-p|--platform]}} linux ping6` diff --git a/pages/osx/gpinky.md b/pages/osx/gpinky.md index 1a85290886..9872430f46 100644 --- a/pages/osx/gpinky.md +++ b/pages/osx/gpinky.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux pinky` +`tldr {{[-p|--platform]}} linux pinky` diff --git a/pages/osx/gpr.md b/pages/osx/gpr.md index 4059ca2706..2a1bc09631 100644 --- a/pages/osx/gpr.md +++ b/pages/osx/gpr.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux pr` +`tldr {{[-p|--platform]}} linux pr` diff --git a/pages/osx/gprintenv.md b/pages/osx/gprintenv.md index 9fc704f83c..1e44742bb0 100644 --- a/pages/osx/gprintenv.md +++ b/pages/osx/gprintenv.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux printenv` +`tldr {{[-p|--platform]}} linux printenv` diff --git a/pages/osx/gprintf.md b/pages/osx/gprintf.md index cc49c3df67..6b85766504 100644 --- a/pages/osx/gprintf.md +++ b/pages/osx/gprintf.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux printf` +`tldr {{[-p|--platform]}} linux printf` diff --git a/pages/osx/gptx.md b/pages/osx/gptx.md index ced11d521b..dec6caf617 100644 --- a/pages/osx/gptx.md +++ b/pages/osx/gptx.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux ptx` +`tldr {{[-p|--platform]}} linux ptx` diff --git a/pages/osx/gpwd.md b/pages/osx/gpwd.md index a3efce0be4..8883364349 100644 --- a/pages/osx/gpwd.md +++ b/pages/osx/gpwd.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux pwd` +`tldr {{[-p|--platform]}} linux pwd` diff --git a/pages/osx/grcp.md b/pages/osx/grcp.md index 50e49aed62..286898c2dc 100644 --- a/pages/osx/grcp.md +++ b/pages/osx/grcp.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux rcp` +`tldr {{[-p|--platform]}} linux rcp` diff --git a/pages/osx/greadlink.md b/pages/osx/greadlink.md index cca5b86fe5..9075545e12 100644 --- a/pages/osx/greadlink.md +++ b/pages/osx/greadlink.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux readlink` +`tldr {{[-p|--platform]}} linux readlink` diff --git a/pages/osx/grealpath.md b/pages/osx/grealpath.md index cba404d1f2..bf32d5e24c 100644 --- a/pages/osx/grealpath.md +++ b/pages/osx/grealpath.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux realpath` +`tldr {{[-p|--platform]}} linux realpath` diff --git a/pages/osx/grexec.md b/pages/osx/grexec.md index 22ac32385a..2d37e175cd 100644 --- a/pages/osx/grexec.md +++ b/pages/osx/grexec.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux rexec` +`tldr {{[-p|--platform]}} linux rexec` diff --git a/pages/osx/grlogin.md b/pages/osx/grlogin.md index 10f21d594c..acb695d265 100644 --- a/pages/osx/grlogin.md +++ b/pages/osx/grlogin.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux rlogin` +`tldr {{[-p|--platform]}} linux rlogin` diff --git a/pages/osx/grm.md b/pages/osx/grm.md index 40f14810be..dd7c4c24a1 100644 --- a/pages/osx/grm.md +++ b/pages/osx/grm.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux rm` +`tldr {{[-p|--platform]}} linux rm` diff --git a/pages/osx/grmdir.md b/pages/osx/grmdir.md index 8493d16c8c..cd1396656c 100644 --- a/pages/osx/grmdir.md +++ b/pages/osx/grmdir.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux rmdir` +`tldr {{[-p|--platform]}} linux rmdir` diff --git a/pages/osx/grsh.md b/pages/osx/grsh.md index bdfe348452..cf2af2b7f5 100644 --- a/pages/osx/grsh.md +++ b/pages/osx/grsh.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux rsh` +`tldr {{[-p|--platform]}} linux rsh` diff --git a/pages/osx/gruncon.md b/pages/osx/gruncon.md index 97d0b961b7..e57333ebf9 100644 --- a/pages/osx/gruncon.md +++ b/pages/osx/gruncon.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux runcon` +`tldr {{[-p|--platform]}} linux runcon` diff --git a/pages/osx/gsed.md b/pages/osx/gsed.md index bda935e4a0..046da55a64 100644 --- a/pages/osx/gsed.md +++ b/pages/osx/gsed.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux sed` +`tldr {{[-p|--platform]}} linux sed` diff --git a/pages/osx/gseq.md b/pages/osx/gseq.md index c3d37db782..685dc633b5 100644 --- a/pages/osx/gseq.md +++ b/pages/osx/gseq.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux seq` +`tldr {{[-p|--platform]}} linux seq` diff --git a/pages/osx/gsha1sum.md b/pages/osx/gsha1sum.md index 0a5f54268c..a3f4348b30 100644 --- a/pages/osx/gsha1sum.md +++ b/pages/osx/gsha1sum.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux sha1sum` +`tldr {{[-p|--platform]}} linux sha1sum` diff --git a/pages/osx/gsha224sum.md b/pages/osx/gsha224sum.md index 07d85adebb..ac21df697f 100644 --- a/pages/osx/gsha224sum.md +++ b/pages/osx/gsha224sum.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux sha224sum` +`tldr {{[-p|--platform]}} linux sha224sum` diff --git a/pages/osx/gsha256sum.md b/pages/osx/gsha256sum.md index 5c8c049bde..c3cda72245 100644 --- a/pages/osx/gsha256sum.md +++ b/pages/osx/gsha256sum.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux sha256sum` +`tldr {{[-p|--platform]}} linux sha256sum` diff --git a/pages/osx/gsha384sum.md b/pages/osx/gsha384sum.md index 91a460ccb2..4c0d5d49ae 100644 --- a/pages/osx/gsha384sum.md +++ b/pages/osx/gsha384sum.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux sha384sum` +`tldr {{[-p|--platform]}} linux sha384sum` diff --git a/pages/osx/gsha512sum.md b/pages/osx/gsha512sum.md index 6c58b0c7de..3851dc8d81 100644 --- a/pages/osx/gsha512sum.md +++ b/pages/osx/gsha512sum.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux sha512sum` +`tldr {{[-p|--platform]}} linux sha512sum` diff --git a/pages/osx/gshred.md b/pages/osx/gshred.md index 0e5496af0d..06a3d21d21 100644 --- a/pages/osx/gshred.md +++ b/pages/osx/gshred.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux shred` +`tldr {{[-p|--platform]}} linux shred` diff --git a/pages/osx/gshuf.md b/pages/osx/gshuf.md index e6abe970e7..6bfd1bc335 100644 --- a/pages/osx/gshuf.md +++ b/pages/osx/gshuf.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux shuf` +`tldr {{[-p|--platform]}} linux shuf` diff --git a/pages/osx/gsleep.md b/pages/osx/gsleep.md index 07ee636b10..1159119f4b 100644 --- a/pages/osx/gsleep.md +++ b/pages/osx/gsleep.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux sleep` +`tldr {{[-p|--platform]}} linux sleep` diff --git a/pages/osx/gsort.md b/pages/osx/gsort.md index ec9d2c0b79..2f9ce75209 100644 --- a/pages/osx/gsort.md +++ b/pages/osx/gsort.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux sort` +`tldr {{[-p|--platform]}} linux sort` diff --git a/pages/osx/gsplit.md b/pages/osx/gsplit.md index e7e5f01b70..65278c43e9 100644 --- a/pages/osx/gsplit.md +++ b/pages/osx/gsplit.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux split` +`tldr {{[-p|--platform]}} linux split` diff --git a/pages/osx/gstat.md b/pages/osx/gstat.md index b4fee069ee..c0f468f359 100644 --- a/pages/osx/gstat.md +++ b/pages/osx/gstat.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux stat` +`tldr {{[-p|--platform]}} linux stat` diff --git a/pages/osx/gstdbuf.md b/pages/osx/gstdbuf.md index 2a77cec5a1..dc4c3a204f 100644 --- a/pages/osx/gstdbuf.md +++ b/pages/osx/gstdbuf.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux stdbuf` +`tldr {{[-p|--platform]}} linux stdbuf` diff --git a/pages/osx/gstty.md b/pages/osx/gstty.md index 392df0d4b8..c0861e4b13 100644 --- a/pages/osx/gstty.md +++ b/pages/osx/gstty.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux stty` +`tldr {{[-p|--platform]}} linux stty` diff --git a/pages/osx/gsum.md b/pages/osx/gsum.md index bbc3100974..cd92fa7ed1 100644 --- a/pages/osx/gsum.md +++ b/pages/osx/gsum.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux sum` +`tldr {{[-p|--platform]}} linux sum` diff --git a/pages/osx/gsync.md b/pages/osx/gsync.md index 8e2e52002e..02870ebf8a 100644 --- a/pages/osx/gsync.md +++ b/pages/osx/gsync.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux sync` +`tldr {{[-p|--platform]}} linux sync` diff --git a/pages/osx/gtac.md b/pages/osx/gtac.md index 1b98194d65..b16fa49ffa 100644 --- a/pages/osx/gtac.md +++ b/pages/osx/gtac.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux tac` +`tldr {{[-p|--platform]}} linux tac` diff --git a/pages/osx/gtail.md b/pages/osx/gtail.md index a70ed5679a..d1366de0ae 100644 --- a/pages/osx/gtail.md +++ b/pages/osx/gtail.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux tail` +`tldr {{[-p|--platform]}} linux tail` diff --git a/pages/osx/gtalk.md b/pages/osx/gtalk.md index ac6bad7167..ca5f67100d 100644 --- a/pages/osx/gtalk.md +++ b/pages/osx/gtalk.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux talk` +`tldr {{[-p|--platform]}} linux talk` diff --git a/pages/osx/gtar.md b/pages/osx/gtar.md index 54290d4dd5..21f5d6547f 100644 --- a/pages/osx/gtar.md +++ b/pages/osx/gtar.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux tar` +`tldr {{[-p|--platform]}} linux tar` diff --git a/pages/osx/gtee.md b/pages/osx/gtee.md index e9c68c05e2..7ac3fae545 100644 --- a/pages/osx/gtee.md +++ b/pages/osx/gtee.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux tee` +`tldr {{[-p|--platform]}} linux tee` diff --git a/pages/osx/gtelnet.md b/pages/osx/gtelnet.md index f50e332d54..add81d6ec2 100644 --- a/pages/osx/gtelnet.md +++ b/pages/osx/gtelnet.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux telnet` +`tldr {{[-p|--platform]}} linux telnet` diff --git a/pages/osx/gtest.md b/pages/osx/gtest.md index bbba581d8f..23e4016b56 100644 --- a/pages/osx/gtest.md +++ b/pages/osx/gtest.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux test` +`tldr {{[-p|--platform]}} linux test` diff --git a/pages/osx/gtftp.md b/pages/osx/gtftp.md index 3cdbb6e5ab..6d2da233a4 100644 --- a/pages/osx/gtftp.md +++ b/pages/osx/gtftp.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux tftp` +`tldr {{[-p|--platform]}} linux tftp` diff --git a/pages/osx/gtime.md b/pages/osx/gtime.md index a30d77d148..1490ba4898 100644 --- a/pages/osx/gtime.md +++ b/pages/osx/gtime.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux time` +`tldr {{[-p|--platform]}} linux time` diff --git a/pages/osx/gtimeout.md b/pages/osx/gtimeout.md index 1723c65905..e30579a8eb 100644 --- a/pages/osx/gtimeout.md +++ b/pages/osx/gtimeout.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux timeout` +`tldr {{[-p|--platform]}} linux timeout` diff --git a/pages/osx/gtouch.md b/pages/osx/gtouch.md index 5d4aa649d7..566783f5d4 100644 --- a/pages/osx/gtouch.md +++ b/pages/osx/gtouch.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux touch` +`tldr {{[-p|--platform]}} linux touch` diff --git a/pages/osx/gtr.md b/pages/osx/gtr.md index e58e36de63..1a736c357f 100644 --- a/pages/osx/gtr.md +++ b/pages/osx/gtr.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux tr` +`tldr {{[-p|--platform]}} linux tr` diff --git a/pages/osx/gtraceroute.md b/pages/osx/gtraceroute.md index 08dce4b021..38010d98d8 100644 --- a/pages/osx/gtraceroute.md +++ b/pages/osx/gtraceroute.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux traceroute` +`tldr {{[-p|--platform]}} linux traceroute` diff --git a/pages/osx/gtrue.md b/pages/osx/gtrue.md index bb5d46e4f0..e36b8b5709 100644 --- a/pages/osx/gtrue.md +++ b/pages/osx/gtrue.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux true` +`tldr {{[-p|--platform]}} linux true` diff --git a/pages/osx/gtruncate.md b/pages/osx/gtruncate.md index bcd424ea40..ba1aff53f2 100644 --- a/pages/osx/gtruncate.md +++ b/pages/osx/gtruncate.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux truncate` +`tldr {{[-p|--platform]}} linux truncate` diff --git a/pages/osx/gtsort.md b/pages/osx/gtsort.md index cb38f778cb..58bfa5042d 100644 --- a/pages/osx/gtsort.md +++ b/pages/osx/gtsort.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux tsort` +`tldr {{[-p|--platform]}} linux tsort` diff --git a/pages/osx/gtty.md b/pages/osx/gtty.md index cb5732522a..3bb6a4c2dd 100644 --- a/pages/osx/gtty.md +++ b/pages/osx/gtty.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux tty` +`tldr {{[-p|--platform]}} linux tty` diff --git a/pages/osx/guname.md b/pages/osx/guname.md index 32912d04e5..1a570d97b8 100644 --- a/pages/osx/guname.md +++ b/pages/osx/guname.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux uname` +`tldr {{[-p|--platform]}} linux uname` diff --git a/pages/osx/gunexpand.md b/pages/osx/gunexpand.md index 57d09ef029..ec573def09 100644 --- a/pages/osx/gunexpand.md +++ b/pages/osx/gunexpand.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux unexpand` +`tldr {{[-p|--platform]}} linux unexpand` diff --git a/pages/osx/guniq.md b/pages/osx/guniq.md index 7c1281ef70..c1c70d062a 100644 --- a/pages/osx/guniq.md +++ b/pages/osx/guniq.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux uniq` +`tldr {{[-p|--platform]}} linux uniq` diff --git a/pages/osx/gunits.md b/pages/osx/gunits.md index a54ffe4dd4..df8b9c8241 100644 --- a/pages/osx/gunits.md +++ b/pages/osx/gunits.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux units` +`tldr {{[-p|--platform]}} linux units` diff --git a/pages/osx/gunlink.md b/pages/osx/gunlink.md index a438bfcd1b..f517059644 100644 --- a/pages/osx/gunlink.md +++ b/pages/osx/gunlink.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux unlink` +`tldr {{[-p|--platform]}} linux unlink` diff --git a/pages/osx/gupdatedb.md b/pages/osx/gupdatedb.md index b4a09236b9..25c2b32a64 100644 --- a/pages/osx/gupdatedb.md +++ b/pages/osx/gupdatedb.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux updatedb` +`tldr {{[-p|--platform]}} linux updatedb` diff --git a/pages/osx/guptime.md b/pages/osx/guptime.md index c0ed144079..1677ae3412 100644 --- a/pages/osx/guptime.md +++ b/pages/osx/guptime.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux uptime` +`tldr {{[-p|--platform]}} linux uptime` diff --git a/pages/osx/gusers.md b/pages/osx/gusers.md index a996e1a102..7fdb9dd546 100644 --- a/pages/osx/gusers.md +++ b/pages/osx/gusers.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux users` +`tldr {{[-p|--platform]}} linux users` diff --git a/pages/osx/gvdir.md b/pages/osx/gvdir.md index 2f7aabc5fb..cb40807e1a 100644 --- a/pages/osx/gvdir.md +++ b/pages/osx/gvdir.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux vdir` +`tldr {{[-p|--platform]}} linux vdir` diff --git a/pages/osx/gwc.md b/pages/osx/gwc.md index 3a937dfe2d..a3259c6de1 100644 --- a/pages/osx/gwc.md +++ b/pages/osx/gwc.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux wc` +`tldr {{[-p|--platform]}} linux wc` diff --git a/pages/osx/gwhich.md b/pages/osx/gwhich.md index aaa93b0182..911f393ea9 100644 --- a/pages/osx/gwhich.md +++ b/pages/osx/gwhich.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux which` +`tldr {{[-p|--platform]}} linux which` diff --git a/pages/osx/gwho.md b/pages/osx/gwho.md index e2e1db7dfd..6ed9830bb1 100644 --- a/pages/osx/gwho.md +++ b/pages/osx/gwho.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux who` +`tldr {{[-p|--platform]}} linux who` diff --git a/pages/osx/gwhoami.md b/pages/osx/gwhoami.md index d12f047daa..f220973db2 100644 --- a/pages/osx/gwhoami.md +++ b/pages/osx/gwhoami.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux whoami` +`tldr {{[-p|--platform]}} linux whoami` diff --git a/pages/osx/gwhois.md b/pages/osx/gwhois.md index 95a3d43176..8446ca64ff 100644 --- a/pages/osx/gwhois.md +++ b/pages/osx/gwhois.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux whois` +`tldr {{[-p|--platform]}} linux whois` diff --git a/pages/osx/gxargs.md b/pages/osx/gxargs.md index 3574a8bd6b..8b66862d3b 100644 --- a/pages/osx/gxargs.md +++ b/pages/osx/gxargs.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux xargs` +`tldr {{[-p|--platform]}} linux xargs` diff --git a/pages/osx/gyes.md b/pages/osx/gyes.md index 04dfcca86d..0be3993866 100644 --- a/pages/osx/gyes.md +++ b/pages/osx/gyes.md @@ -4,4 +4,4 @@ - View documentation for the original command: -`tldr -p linux yes` +`tldr {{[-p|--platform]}} linux yes` diff --git a/pages/windows/microsoft-edge.md b/pages/windows/microsoft-edge.md index 97b6fda8bb..f13a2e3d13 100644 --- a/pages/windows/microsoft-edge.md +++ b/pages/windows/microsoft-edge.md @@ -5,8 +5,8 @@ - View the documentation for Microsoft Edge for Windows: -`tldr -p windows msedge` +`tldr {{[-p|--platform]}} windows msedge` - View the documentation for Microsoft Edge for other platforms: -`tldr -p common microsoft-edge` +`tldr {{[-p|--platform]}} common microsoft-edge` diff --git a/pages/windows/py.md b/pages/windows/py.md new file mode 100644 index 0000000000..a6c85cfdfc --- /dev/null +++ b/pages/windows/py.md @@ -0,0 +1,21 @@ +# py + +> Python Launcher for Windows that runs with specified Python version. +> See also: `python`. +> More information: . + +- Start a REPL (interactive shell), optionally with arguments supported by `python` (like `-c`, `-m`, etc.): + +`py {{python_arguments}}` + +- Execute a specific Python file: + +`py {{path/to/file.py}}` + +- Run specific Python version. If the version is missing, and `PYLAUNCHER_ALLOW_INSTALL` environment variable is set, auto-install via Microsoft Store or Winget: + +`py {{-2|-3.7|...}}` + +- List installed Python versions: + +`py --list`