Răsfoiți Sursa

Applying the snake_case convention throughout the repo (#967)

* Applying the snake_case convention throughout the repo

- Also removing the file extension where not needed
- Adding {{ }} on a few old pages

* Addressing concerns

- Added {{ }} where they were missed out
- Removed spaces inside {{ }}
- Reverting "file" to "filename" to make it clearer

* Fixing the comments on nc page
Agniva De Sarker 8 ani în urmă
părinte
comite
3da76e4150

+ 2 - 2
pages/common/atom.md

@@ -5,8 +5,8 @@
 
 - Open a file or folder:
 
-`atom {{path/to/file/or/folder}}`
+`atom {{path/to/file_or_folder}}`
 
 - Open a file or folder in a new window:
 
-`atom -n {{path/to/file/or/folder}}`
+`atom -n {{path/to/file_or_folder}}`

+ 1 - 1
pages/common/autossh.md

@@ -25,4 +25,4 @@
 
 - Run autossh in the background with debug output logged to a file and ssh verbose output logged to a second file:
 
-`AUTOSSH_DEBUG=1 AUTOSSH_LOGFILE={{log_file}} autossh -f -M {{monitor_port}} -v -E {{ssh_logfile}} {{ssh_command}}`
+`AUTOSSH_DEBUG=1 AUTOSSH_LOGFILE={{log_file}} autossh -f -M {{monitor_port}} -v -E {{ssh_log_file}} {{ssh_command}}`

+ 2 - 2
pages/common/cat.md

@@ -8,11 +8,11 @@
 
 - Concatenate several files into the target file:
 
-`cat {{file1}} {{file2}} > {{target-file}}`
+`cat {{file1}} {{file2}} > {{target_file}}`
 
 - Append several files into the target file:
 
-`cat {{file1}} {{file2}} >> {{target-file}}`
+`cat {{file1}} {{file2}} >> {{target_file}}`
 
 - Number all output lines:
 

+ 1 - 1
pages/common/comm.md

@@ -16,7 +16,7 @@
 
 - Get lines only found in first file, saving the result to a third file:
 
-`comm -23 {{file1}} {{file2}} > file1-only.txt`
+`comm -23 {{file1}} {{file2}} > {{file1_only}}`
 
 - Print lines only found in second file, when the files aren't sorted:
 

+ 1 - 1
pages/common/ed.md

@@ -28,7 +28,7 @@
 
 - Write the current document to a new file (the filename can be omitted if `ed` was called with an existing file):
 
-`w {{filename.txt}}`
+`w {{filename}}`
 
 - Quit ed:
 

+ 2 - 2
pages/common/electrum.md

@@ -4,11 +4,11 @@
 
 - Create a new wallet:
 
-`electrum -w {{new-wallet.dat}} create`
+`electrum -w {{new_wallet.dat}} create`
 
 - Restore an existing wallet from seed offline:
 
-`electrum -w {{recovery-wallet.dat}} restore -o`
+`electrum -w {{recovery_wallet.dat}} restore -o`
 
 - Create a signed transaction offline:
 

+ 2 - 2
pages/common/ffmpeg.md

@@ -4,11 +4,11 @@
 
 - Extract the sound from a video and save it as MP3:
 
-`ffmpeg -i {{video-filename}} -vn -ar 44100 -ac 2 -ab 192 -f mp3 {{sound.mp3}}`
+`ffmpeg -i {{video_filename}} -vn -ar 44100 -ac 2 -ab 192 -f mp3 {{sound.mp3}}`
 
 - Convert frames from a video into individual numbered images:
 
-`ffmpeg -i {{video-filename}} {{image%d.png}}`
+`ffmpeg -i {{video_filename}} {{image%d.png}}`
 
 - Combine numbered images (image1.jpg, image2.jpg, etc) into a video:
 

+ 1 - 1
pages/common/git-diff.md

@@ -20,4 +20,4 @@
 
 - Create a patch file:
 
-`git diff > {{target-file.patch}}`
+`git diff > {{target_file.patch}}`

+ 4 - 4
pages/common/gzip.md

@@ -8,16 +8,16 @@
 
 - Decompress a file, replacing it with the original uncompressed version:
 
-`gzip -d {{file.ext.gz}}`
+`gzip -d {{file.ext}}.gz`
 
 - Compress a file specifying the output filename:
 
-`gzip -c {{file.ext}} > compressed-file.ext.gz`
+`gzip -c {{file.ext}} > {{compressed_file.ext}}.gz`
 
 - Uncompress a gzipped file specifying the output filename:
 
-`gzip -c -d {{file.ext.gz}} > uncompressed-file.ext`
+`gzip -c -d {{file.ext}}.gz > {{uncompressed_file.ext}}`
 
 - Specify the compression level. 1=Fastest (Worst), 9=Slowest (Best), Default level is 6:
 
-`gzip -9 -c {{file.ext}} > compressed-file.ext.gz`
+`gzip -9 -c {{file.ext}} > {{compressed_file.ext}}.gz`

+ 1 - 1
pages/common/haxelib.md

@@ -16,4 +16,4 @@
 
 - Install the development version of a library from a Git repository:
 
-`haxelib git {{libname}} {{GIT-URL}}`
+`haxelib git {{libname}} {{git_url}}`

+ 1 - 1
pages/common/http.md

@@ -8,7 +8,7 @@
 
 - Send form-encoded data:
 
-`http -f {{example.org}} {{name='bob'}} {{profile-picture@'bob.png'}}`
+`http -f {{example.org}} {{name='bob'}} {{profile_picture@'bob.png'}}`
 
 - Send JSON object:
 

+ 1 - 1
pages/common/license.md

@@ -8,7 +8,7 @@
 
 - Create a license with custom filename:
 
-`license -o {{filename.txt}} {{license_name}}`
+`license -o {{filename}} {{license_name}}`
 
 - List all locally available licenses:
 

+ 1 - 1
pages/common/ln.md

@@ -8,7 +8,7 @@
 
 - Overwrite an existing symbolic to point to a different file:
 
-`ln -sf {{path/to/new/file}} {{path/to/symlink}}`
+`ln -sf {{path/to/new_file}} {{path/to/symlink}}`
 
 - Create a hard link to a file:
 

+ 3 - 3
pages/common/nc.md

@@ -16,11 +16,11 @@
 
 - Serve a file:
 
-`nc -l {{port}} < {{somefile.txt}}`
+`nc -l {{port}} < {{file}}`
 
 - Receive a file:
 
-`nc {{ip_address}} {{port}} > {{somefile.txt}}`
+`nc {{ip_address}} {{port}} > {{file}}`
 
 - Server stay up after client detach:
 
@@ -36,4 +36,4 @@
 
 - Proxy and port forwarding:
 
-`nc -l {{ port }} | nc {{ hostname }} {{ port }}`
+`nc -l {{port}} | nc {{hostname}} {{port}}`

+ 1 - 1
pages/common/parallel.md

@@ -20,7 +20,7 @@
 
 - Break stdin into ~1M blocks, feed each block to stdin of new command:
 
-`cat {{bigfile.txt}} | parallel --pipe --block 1M {{command}}`
+`cat {{big_file.txt}} | parallel --pipe --block 1M {{command}}`
 
 - Run on multiple machines via SSH:
 

+ 1 - 1
pages/common/pass.md

@@ -25,4 +25,4 @@
 
 - Run any git command against the underlying store repository:
 
-`pass git {{git-arguments}}`
+`pass git {{git_arguments}}`

+ 3 - 3
pages/common/patch.md

@@ -5,12 +5,12 @@
 
 - Apply a patch:
 
-`patch < {{patchfile}}.diff`
+`patch < {{patch_file}}.diff`
 
 - Apply a patch to current directory:
 
-`patch -p1 < {{patchfile}}.diff`
+`patch -p1 < {{patch_file}}.diff`
 
 - Apply the reverse of a patch:
 
-`patch -R < {{patchfile}}.diff`
+`patch -R < {{patch_file}}.diff`

+ 1 - 1
pages/common/redis-cli.md

@@ -20,4 +20,4 @@
 
 - Execute Redis command:
 
-`redis-cli {{redis command}}`
+`redis-cli {{redis_command}}`

+ 1 - 1
pages/common/tac.md

@@ -8,4 +8,4 @@
 
 - Concatenate several files reversed into the target file:
 
-`tac {{file1}} {{file2}} > {{target-file}}`
+`tac {{file1}} {{file2}} > {{target_file}}`

+ 3 - 3
pages/common/transcode.md

@@ -5,12 +5,12 @@
 
 - Create stabilisation file to be able to remove camera shakes:
 
-`transcode -J stabilize -i {{inputfile}}`
+`transcode -J stabilize -i {{input_file}}`
 
 - Remove camera shakes after creating stabilisation file, transform video using xvid:
 
-`transcode -J transform -i {{inputfile}} -y xvid -o {{outputfile}}`
+`transcode -J transform -i {{input_file}} -y xvid -o {{output_file}}`
 
 - Resize the video to 640x480 pixels and convert to MPEG4 codec using xvid:
 
-`transcode -Z 640x480 -i {{inputfile}} -y xvid -o {{outputfile}}`
+`transcode -Z 640x480 -i {{input_file}} -y xvid -o {{output_file}}`

+ 4 - 4
pages/common/ufraw-batch.md

@@ -4,16 +4,16 @@
 
 - Simply convert RAW files to jpg:
 
-`ufraw-batch --out-type=jpg {{input-file(s)}}`
+`ufraw-batch --out-type=jpg {{input_file(s)}}`
 
 - Simply convert RAW files to png:
 
-`ufraw-batch --out-type=png {{input-file(s)}}`
+`ufraw-batch --out-type=png {{input_file(s)}}`
 
 - Extract the preview image from the raw file:
 
-`ufraw-batch --embedded-image {{input-file(s)}}`
+`ufraw-batch --embedded-image {{input_file(s)}}`
 
 - Save the file with size up to the given maximums MAX1 and MAX2:
 
-`ufraw-batch --size=MAX1,MAX2 {{input-file(s)}}`
+`ufraw-batch --size=MAX1,MAX2 {{input_file(s)}}`

+ 1 - 1
pages/common/unzip.md

@@ -8,7 +8,7 @@
 
 - Extract zip files(s) to given path:
 
-`unzip {{files(s)}} -d {{/path/to/put/extracted/files}}`
+`unzip {{compressed_file(s)}} -d {{/path/to/put/extracted_file(s)}}`
 
 - List the contents of a zip file without extracting:
 

+ 1 - 1
pages/common/zbarimg.md

@@ -4,4 +4,4 @@
 
 - Process an image file:
 
-`zbarimg {{image file}}`
+`zbarimg {{image_file}}`

+ 2 - 2
pages/linux/emerge.md

@@ -16,11 +16,11 @@
 
 - Install a new package, with confirmation:
 
-`emerge -av {{package-name}}`
+`emerge -av {{package_name}}`
 
 - Remove a package, with confirmation:
 
-`emerge -Cav {{package-name}}`
+`emerge -Cav {{package_name}}`
 
 - Remove orphaned packages (that were installed only as dependencies):
 

+ 1 - 1
pages/linux/htop.md

@@ -8,7 +8,7 @@
 
 - Start htop displaying only processes owned by given user:
 
-`htop -u {{user-name}}`
+`htop -u {{user_name}}`
 
 - Get help about interactive commands:
 

+ 1 - 1
pages/linux/mdadm.md

@@ -4,7 +4,7 @@
 
 - Create array:
 
-`mdadm --create {{/path/to/raid_device_file}} --level {{ raid level }} --raid-devices {{ number of disks}} {{/path/to/disk_device_file}}`
+`mdadm --create {{/path/to/raid_device_file}} --level {{raid_level}} --raid-devices {{number_of_disks}} {{/path/to/disk_device_file}}`
 
 - Stop array:
 

+ 1 - 1
pages/linux/mkfs.cramfs.md

@@ -8,4 +8,4 @@
 
 - Create a ROM filesystem with a volume-name:
 
-`mkfs.cramfs -n {{volume-name}} {{/dev/sdb1}}`
+`mkfs.cramfs -n {{volume_name}} {{/dev/sdb1}}`

+ 2 - 2
pages/linux/mkfs.exfat.md

@@ -8,8 +8,8 @@
 
 - Create filesystem with a volume-name:
 
-`mkfs.exfat -n {{volume-name}} {{/dev/sdb1}}`
+`mkfs.exfat -n {{volume_name}} {{/dev/sdb1}}`
 
 - Create filesystem with a volume-id:
 
-`mkfs.exfat -i {{volume-id}} {{/dev/sdb1}}`
+`mkfs.exfat -i {{volume_id}} {{/dev/sdb1}}`

+ 2 - 2
pages/linux/mkfs.fat.md

@@ -8,11 +8,11 @@
 
 - Create filesystem with a volume-name:
 
-`mkfs.fat -n {{volume-name}} {{/dev/sdb1}}`
+`mkfs.fat -n {{volume_name}} {{/dev/sdb1}}`
 
 - Create filesystem with a volume-id:
 
-`mkfs.fat -i {{volume-id}} {{/dev/sdb1}}`
+`mkfs.fat -i {{volume_id}} {{/dev/sdb1}}`
 
 - Use 5 instead of 2 file allocation tables:
 

+ 1 - 1
pages/linux/mkfs.ntfs.md

@@ -8,7 +8,7 @@
 
 - Create filesystem with a volume-label:
 
-`mkfs.ntfs -L {{volume-label}} {{/dev/sdb1}}`
+`mkfs.ntfs -L {{volume_label}} {{/dev/sdb1}}`
 
 - Create filesystem with specific UUID:
 

+ 2 - 2
pages/linux/mkfs.vfat.md

@@ -8,11 +8,11 @@
 
 - Create filesystem with a volume-name:
 
-`mkfs.vfat -n {{volume-name}} {{/dev/sdb1}}`
+`mkfs.vfat -n {{volume_name}} {{/dev/sdb1}}`
 
 - Create filesystem with a volume-id:
 
-`mkfs.vfat -i {{volume-id}} {{/dev/sdb1}}`
+`mkfs.vfat -i {{volume_id}} {{/dev/sdb1}}`
 
 - Use 5 instead of 2 file allocation tables:
 

+ 3 - 3
pages/linux/pacman.md

@@ -8,11 +8,11 @@
 
 - Install a new package:
 
-`pacman -S package-name`
+`pacman -S {{package_name}}`
 
 - Remove a package and its dependencies:
 
-`pacman -Rs package-name`
+`pacman -Rs {{package_name}}`
 
 - Search the package database for a keyword:
 
@@ -28,7 +28,7 @@
 
 - Find which package owns a certain file:
 
-`pacman -Qo filename`
+`pacman -Qo {{filename}}`
 
 - Empty package cache to free up space:
 

+ 2 - 2
pages/linux/pkgadd.md

@@ -4,8 +4,8 @@
 
 - Install a local software package:
 
-`pkgadd {{package-name}}`
+`pkgadd {{package_name}}`
 
 - Update an already installed package from a local package:
 
-`pkgadd -u {{package-name}}`
+`pkgadd -u {{package_name}}`

+ 1 - 1
pages/linux/pkginfo.md

@@ -8,7 +8,7 @@
 
 - List files owned by a package:
 
-`pkginfo -l {{package-name}}`
+`pkginfo -l {{package_name}}`
 
 - List the owner(s) of files matching a pattern:
 

+ 1 - 1
pages/linux/pkgrm.md

@@ -4,4 +4,4 @@
 
 - Remove an installed package:
 
-`pkgrm {{package-name}}`
+`pkgrm {{package_name}}`

+ 5 - 5
pages/linux/prt-get.md

@@ -4,19 +4,19 @@
 
 - Install a package:
 
-`prt-get install {{package-name}}`
+`prt-get install {{package_name}}`
 
 - Install a package with dependency handling:
 
-`prt-get depinst {{package-name}}`
+`prt-get depinst {{package_name}}`
 
 - Update a package manually:
 
-`prt-get upgrade {{package-name}}`
+`prt-get upgrade {{package_name}}`
 
 - Remove a package:
 
-`prt-get remove {{package-name}}`
+`prt-get remove {{package_name}}`
 
 - Upgrade the system from the local ports tree:
 
@@ -24,7 +24,7 @@
 
 - Search the ports tree:
 
-`prt-get search {{package-name}}`
+`prt-get search {{package_name}}`
 
 - Search for a file in a package:
 

+ 2 - 2
pages/osx/du.md

@@ -4,11 +4,11 @@
 
 - Get a sum of the total size of a file/folder in human readable units:
 
-`du -sh {{file/directory}}`
+`du -sh {{file_or_directory}}`
 
 - List file sizes of a directory and any subdirectories in KB:
 
-`du -k {{file/directory}}`
+`du -k {{file_or_directory}}`
 
 - Get recursively, individual file/folder sizes in human readable form:
 

+ 1 - 1
pages/osx/top.md

@@ -16,7 +16,7 @@
 
 - Start top displaying only processes owned by given user:
 
-`top -user {{user-name}}`
+`top -user {{user_name}}`
 
 - Get help about interactive commands: