From 40122edd1551b330d3d514d6b1a8122a75dcbd8e Mon Sep 17 00:00:00 2001 From: ivuorinen Date: Tue, 24 Sep 2024 00:17:10 +0000 Subject: [PATCH] Update cheatsheets --- tldr/clang | 29 +++++++++++++++++++---------- tldr/clang++ | 26 +++++++++++++++++--------- tldr/docker-image | 2 +- tldr/g++ | 20 ++++++++++++-------- tldr/gcc | 21 +++++++++++++++------ tldr/gdal_translate | 2 +- tldr/gdaladdo | 2 +- tldr/gdaldem | 2 +- tldr/gdalwarp | 2 +- tldr/podman-compose | 2 +- 10 files changed, 69 insertions(+), 39 deletions(-) diff --git a/tldr/clang b/tldr/clang index 51731a4a..7755fbad 100644 --- a/tldr/clang +++ b/tldr/clang @@ -5,29 +5,38 @@ source: https://github.com/tldr-pages/tldr.git --- # clang -> Compiler for C, C++, and Objective-C source files. Can be used as a drop-in replacement for GCC. +> Compile C, C++, and Objective-C source files. Can be used as a drop-in replacement for GCC. +> Part of LLVM. > More information: . -- Compile a source code file into an executable binary: +- Compile multiple source files into an executable: -`clang {{input_source.c}} -o {{output_executable}}` +`clang {{path/to/source1.c path/to/source2.c ...}} {{-o|--output}} {{path/to/output_executable}}` - Activate output of all errors and warnings: -`clang {{input_source.c}} -Wall -o {{output_executable}}` +`clang {{path/to/source.c}} -Wall {{-o|--output}} {{output_executable}}` -- Include libraries located at a different path than the source file: +- Show common warnings, debug symbols in output, and optimize without affecting debugging: -`clang {{input_source.c}} -o {{output_executable}} -I{{header_path}} -L{{library_path}} -l{{library_name}}` +`clang {{path/to/source.c}} -Wall {{-g|--debug}} -Og {{-o|--output}} {{path/to/output_executable}}` + +- Include libraries from a different path: + +`clang {{path/to/source.c}} {{-o|--output}} {{path/to/output_executable}} -I{{path/to/header}} -L{{path/to/library}} -l{{library_name}}` - Compile source code into LLVM Intermediate Representation (IR): -`clang -S -emit-llvm {{file.c}} -o {{file.ll}}` +`clang {{-S|--assemble}} -emit-llvm {{path/to/source.c}} {{-o|--output}} {{path/to/output.ll}}` -- Compile source code without linking: +- Compile source code into an object file without linking: -`clang -c {{input_source.c}}` +`clang {{-c|--compile}} {{path/to/source.c}}` - Optimize the compiled program for performance: -`clang {{path/to/source.c}} -O{{1|2|3|fast}}` +`clang {{path/to/source.c}} -O{{1|2|3|fast}} {{-o|--output}} {{path/to/output_executable}}` + +- Display version: + +`clang --version` diff --git a/tldr/clang++ b/tldr/clang++ index 27c54604..d7a5800c 100644 --- a/tldr/clang++ +++ b/tldr/clang++ @@ -9,26 +9,34 @@ source: https://github.com/tldr-pages/tldr.git > Part of LLVM. > More information: . -- Compile a source code file into an executable binary: +- Compile a set of source code files into an executable binary: -`clang++ {{path/to/source.cpp}} -o {{path/to/output_executable}}` +`clang++ {{path/to/source1.cpp path/to/source2.cpp ...}} {{-o|--output}} {{path/to/output_executable}}` -- Display (almost) all errors and warnings: +- Activate output of all errors and warnings: -`clang++ {{path/to/source.cpp}} -Wall -o {{path/to/output_executable}}` +`clang++ {{path/to/source.cpp}} -Wall {{-o|--output}} {{output_executable}}` -- Choose a language standard to compile with: +- Show common warnings, debug symbols in output, and optimize without affecting debugging: -`clang++ {{path/to/source.cpp}} -std={{c++20}} -o {{path/to/output_executable}}` +`clang++ {{path/to/source.cpp}} -Wall {{-g|--debug}} -Og {{-o|--output}} {{path/to/output_executable}}` + +- Choose a language standard to compile for: + +`clang++ {{path/to/source.cpp}} -std={{c++20}} {{-o|--output}} {{path/to/output_executable}}` - Include libraries located at a different path than the source file: -`clang++ {{path/to/source.cpp}} -o {{path/to/output_executable}} -I{{path/to/header_path}} -L{{path/to/library_path}} -l{{path/to/library_name}}` +`clang++ {{path/to/source.cpp}} {{-o|--output}} {{path/to/output_executable}} -I{{path/to/header_path}} -L{{path/to/library_path}} -l{{path/to/library_name}}` - Compile source code into LLVM Intermediate Representation (IR): -`clang++ -S -emit-llvm {{path/to/source.cpp}} -o {{path/to/output.ll}}` +`clang++ {{-S|--assemble}} -emit-llvm {{path/to/source.cpp}} {{-o|--output}} {{path/to/output.ll}}` - Optimize the compiled program for performance: -`clang++ {{path/to/source.cpp}} -O{{1|2|3|fast}} -o {{path/to/output_executable}}` +`clang++ {{path/to/source.cpp}} -O{{1|2|3|fast}} {{-o|--output}} {{path/to/output_executable}}` + +- Display version: + +`clang++ --version` diff --git a/tldr/docker-image b/tldr/docker-image index 69c8b0c2..8f44fdf5 100644 --- a/tldr/docker-image +++ b/tldr/docker-image @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Manage Docker images. > See also: `docker build`, `docker import`, and `docker pull`. -> More information: . +> More information: . - List local Docker images: diff --git a/tldr/g++ b/tldr/g++ index 18d61b49..b33ee3b0 100644 --- a/tldr/g++ +++ b/tldr/g++ @@ -5,33 +5,37 @@ source: https://github.com/tldr-pages/tldr.git --- # g++ -> Compiles C++ source files. +> Compile C++ source files. > Part of GCC (GNU Compiler Collection). > More information: . - Compile a source code file into an executable binary: -`g++ {{path/to/source.cpp}} -o {{path/to/output_executable}}` +`g++ {{path/to/source1.cpp path/to/source2.cpp ...}} {{-o|--output}} {{path/to/output_executable}}` -- Display common warnings: +- Activate output of all errors and warnings: -`g++ {{path/to/source.cpp}} -Wall -o {{path/to/output_executable}}` +`g++ {{path/to/source.cpp}} -Wall {{-o|--output}} {{output_executable}}` + +- Show common warnings, debug symbols in output, and optimize without affecting debugging: + +`g++ {{path/to/source.cpp}} -Wall {{-g|--debug}} -Og {{-o|--output}} {{path/to/output_executable}}` - Choose a language standard to compile for (C++98/C++11/C++14/C++17): -`g++ {{path/to/source.cpp}} -std={{c++98|c++11|c++14|c++17}} -o {{path/to/output_executable}}` +`g++ {{path/to/source.cpp}} -std={{c++98|c++11|c++14|c++17}} {{-o|--output}} {{path/to/output_executable}}` - Include libraries located at a different path than the source file: -`g++ {{path/to/source.cpp}} -o {{path/to/output_executable}} -I{{path/to/header}} -L{{path/to/library}} -l{{library_name}}` +`g++ {{path/to/source.cpp}} {{-o|--output}} {{path/to/output_executable}} -I{{path/to/header}} -L{{path/to/library}} -l{{library_name}}` - Compile and link multiple source code files into an executable binary: -`g++ -c {{path/to/source1.cpp path/to/source2.cpp ...}} && g++ -o {{path/to/output_executable}} {{path/to/source1.o path/to/source2.o ...}}` +`g++ {{-c|--compile}} {{path/to/source1.cpp path/to/source2.cpp ...}} && g++ {{-o|--output}} {{path/to/output_executable}} {{path/to/source1.o path/to/source2.o ...}}` - Optimize the compiled program for performance: -`g++ {{path/to/source.cpp}} -O{{1|2|3|fast}} -o {{path/to/output_executable}}` +`g++ {{path/to/source.cpp}} -O{{1|2|3|fast}} {{-o|--output}} {{path/to/output_executable}}` - Display version: diff --git a/tldr/gcc b/tldr/gcc index de13201a..1f615cfe 100644 --- a/tldr/gcc +++ b/tldr/gcc @@ -6,28 +6,37 @@ source: https://github.com/tldr-pages/tldr.git # gcc > Preprocess and compile C and C++ source files, then assemble and link them together. +> Part of GCC (GNU Compiler Collection). > More information: . - Compile multiple source files into an executable: -`gcc {{path/to/source1.c path/to/source2.c ...}} -o {{path/to/output_executable}}` +`gcc {{path/to/source1.c path/to/source2.c ...}} {{-o|--output}} {{path/to/output_executable}}` + +- Activate output of all errors and warnings: + +`gcc {{path/to/source.c}} -Wall {{-o|--output}} {{output_executable}}` - Show common warnings, debug symbols in output, and optimize without affecting debugging: -`gcc {{path/to/source.c}} -Wall -g -Og -o {{path/to/output_executable}}` +`gcc {{path/to/source.c}} -Wall {{-g|--debug}} -Og {{-o|--output}} {{path/to/output_executable}}` - Include libraries from a different path: -`gcc {{path/to/source.c}} -o {{path/to/output_executable}} -I{{path/to/header}} -L{{path/to/library}} -l{{library_name}}` +`gcc {{path/to/source.c}} {{-o|--output}} {{path/to/output_executable}} -I{{path/to/header}} -L{{path/to/library}} -l{{library_name}}` - Compile source code into Assembler instructions: -`gcc -S {{path/to/source.c}}` +`gcc {{-S|--assemble}} {{path/to/source.c}}` - Compile source code into an object file without linking: -`gcc -c {{path/to/source.c}}` +`gcc {{-c|--compile}} {{path/to/source.c}}` - Optimize the compiled program for performance: -`gcc {{path/to/source.c}} -O{{1|2|3|fast}} -o {{path/to/output_executable}}` +`gcc {{path/to/source.c}} -O{{1|2|3|fast}} {{-o|--output}} {{path/to/output_executable}}` + +- Display version: + +`gcc --version` diff --git a/tldr/gdal_translate b/tldr/gdal_translate index fc4596db..b2950afe 100644 --- a/tldr/gdal_translate +++ b/tldr/gdal_translate @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gdal_translate > Convert raster data between different formats. -> More information: . +> More information: . - Convert a raster dataset to JPEG format: diff --git a/tldr/gdaladdo b/tldr/gdaladdo index 69d40d0d..f9a04d4f 100644 --- a/tldr/gdaladdo +++ b/tldr/gdaladdo @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gdaladdo > Build overview images of raster datasets. -> More information: . +> More information: . - Build overview images of a raster dataset using the "average" [r]esampling method: diff --git a/tldr/gdaldem b/tldr/gdaldem index 305f73af..498d8e28 100644 --- a/tldr/gdaldem +++ b/tldr/gdaldem @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gdaldem > Analyze and visualize digital elevation models (DEM). -> More information: . +> More information: . - Compute the hillshade of a DEM: diff --git a/tldr/gdalwarp b/tldr/gdalwarp index 4357f758..9df239ca 100644 --- a/tldr/gdalwarp +++ b/tldr/gdalwarp @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gdalwarp > Image reprojection and warping utility. -> More information: . +> More information: . - Reproject a raster dataset: diff --git a/tldr/podman-compose b/tldr/podman-compose index 52bb103f..a356ab72 100644 --- a/tldr/podman-compose +++ b/tldr/podman-compose @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Start all containers using an alternate compose file: -`podman-compose {{path/to/file}} up` +`podman-compose {{-f|--file}} {{path/to/file.yaml}} up` - Stop all running containers: