Difference between revisions of "Sh-file"

From HPC Wiki
Jump to: navigation, search
m
Line 1: Line 1:
 
== General ==
 
== General ==
  
A [[shell]] script or Sh-file is something between a single command and a (not necessarily) small programm. The basic idea is to couple a few [[shell]] commands together in a file for ease of use. So whenever you tell the [[shell]] to execute that file, it will execute all the specified commands in order. This makes it very easy to run a couple of commands and gives one the opportunity to simplify frequent tasks easily.
+
A [[shell]] script or sh-file is something between a single command and a (not necessarily) small programm. The basic idea is to chain a few [[shell]] commands together in a file for ease of use. So whenever you tell the [[shell]] to execute that file, it will execute all the specified commands in order. This makes it very easy to run a couple of commands and gives one the opportunity to simplify frequent tasks.
  
  
Line 7: Line 7:
 
  $ bash myscript.sh
 
  $ bash myscript.sh
  
starts a (new) instance of the bash shell, which runs the commands specified in 'yourfile.sh'.
+
starts a (new) instance of the bash shell, which runs the commands specified in 'myscript.sh'.
  
 
To create or write a new shell script file, one can utilize e.g. [[vim]] or a different text editor. Generally a script starts with a shebang (#!) specifying the type of shell the script expects (bash in this case)
 
To create or write a new shell script file, one can utilize e.g. [[vim]] or a different text editor. Generally a script starts with a shebang (#!) specifying the type of shell the script expects (bash in this case)
Line 14: Line 14:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Following that, one continues with [[shell]] commands, one per line. Comment lines start with '#' and are highly recommended for read- and reusability. Furthermore the 'echo' command is useful to display information on what is currently being done or return results. A minimal shell script might look like this
+
Following that, one continues with [[shell]] commands, one per line. Comment lines start with '#' and are highly recommended for improving the readability of the code and later support its reusability for other tasks. Furthermore the 'echo' command is useful to display information on what is currently being done or return results. A minimal shell script might look like this
  
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">

Revision as of 12:30, 10 April 2018

General

A shell script or sh-file is something between a single command and a (not necessarily) small programm. The basic idea is to chain a few shell commands together in a file for ease of use. So whenever you tell the shell to execute that file, it will execute all the specified commands in order. This makes it very easy to run a couple of commands and gives one the opportunity to simplify frequent tasks.


Usage

$ bash myscript.sh

starts a (new) instance of the bash shell, which runs the commands specified in 'myscript.sh'.

To create or write a new shell script file, one can utilize e.g. vim or a different text editor. Generally a script starts with a shebang (#!) specifying the type of shell the script expects (bash in this case)

#!/bin/bash

Following that, one continues with shell commands, one per line. Comment lines start with '#' and are highly recommended for improving the readability of the code and later support its reusability for other tasks. Furthermore the 'echo' command is useful to display information on what is currently being done or return results. A minimal shell script might look like this

#!/bin/bash

# pwd prints the current directory
echo 'The current directory is:'
pwd

# ls -l gives a list of everything of files and subdirectories
echo 'and in this directory you can find:'
ls -l

which prints the current directory and a list of the contained subdirectories and files.



Making a file executable

To execute the script without specifying the shell first, one has to make the file executable with

$ chmod +x myscript.sh

and now one can execute the file with

$ ./myscript.sh

However, don't forget the shebang, otherwise this might not work.


References

Guide to shell scripting