Basic commands to get around the Synology Box using the CLI: Difference between revisions

From wiki
Jump to navigation Jump to search
imported>Falcon359
(New page: '''1. Basic commands''' A. To go to a directory, command: cd /directory name B. To make a directory, command: mkdir /directory name C. Directory list, command: dir D. To find...)
 
imported>Johayek
mNo edit summary
 
(48 intermediate revisions by 11 users not shown)
Line 1: Line 1:
'''1. Basic commands'''
__TOC__
  A. To go to a directory, command: cd /directory name
 
  B. To make a directory, command: mkdir /directory name
==File Management==
  C. Directory list, command: dir
===To edit a text file (using vi)===
  D. To find a file, command: find / -name "file name"
For info on how to use vi see [[Linux VI Editor|Basic commands for Linux vi Editor]]
  E. To delete a file, command: rm file name
{| border="0" cellpadding="0" style="text-align:left"
  F. To delete directory and its content, command: rm –r directory name
|-
  G. To move or rename a file, command: mv /directory name/file name /destination directory
|<pre>vi /location_of_file/file_name</pre>
  H. To copy a file or files, command: cp /directory name/file name /destination directory
|-
  I. For more than one file, command: cp /directory name/*.* /destination directory
|}
  J. To reboot the Synology box, command: reboot
 
  K. To shutdown the Synology box, command: poweroff
===To go to a directory===
  L. Clear terminal screen, command: clear
{| border="0" cellpadding="0" style="text-align:left"
  M. To stop a process, command: kill process id
|-
  N. To stop a program, command: killall program name
|<pre>cd /directoryName</pre>
  O. Check system memory, command: cat /proc/meminfo or free
|-
  P. Check system CPU, command: cat /proc/cpuinfo
|}
  Q. Check for interrupts in use, command: cat /proc/interrupts
 
  R. Check file system being used, command: cat /proc/filesystems
===Make a directory===
  S. Check linux version, command, cat /proc/version
{| border="0" cellpadding="0" style="text-align:left"
  T. Shows the most current processes running, command: top
|-
  U. Shows all processes running, command: ps –ef
|<pre>mkdir /directoryName</pre>
  V. To install program, command: ipkg install file name
|-
  W. To remove a program, command: ipkg remove file name
|}
 
===List contents of Directory===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>dir</pre>
|-
|}
 
===Count the number of files in the current Directory and its sub-directories===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>find . -type f | wc -l</pre>
|-
|}
 
===Check size of Directory and sub-directories===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>du -ah /path/to/dir</pre>
|-
|}
 
===Find a file===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>find / -name fileName</pre>
|-
|}
 
===Delete a file===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>rm fileName</pre>
|-
|}
 
===Delete a directory and its content===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>rm -r directoryName</pre>
|-
|}
*Note: Use this command with great care
 
===Move or Rename a file===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>mv /sourceDirectory/sourceFile /destination</pre>
|-
|}
 
===Copy a file===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>cp /sourceDirectory/sourceFile /destination</pre>
|-
|}
 
===Copy groups of files===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>cp /sourceDirectory/*.* /destination</pre>
|-
|}
 
===Copy a directory and any sub directories===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>cp -r -p /sourceDirectory /destinationpath</pre>
|-
|}
 
===Create a uncompressed tar (.tar) archive===
To create a uncompressed (.tar) archive of all files directories and subdirectories in the current directory:
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>tar -cvf archivefilename.tar *</pre>
|-
|}
 
===Create a compressed tar (.tgz) archive===
To create a compressed (.tgz) archive of all files directories and subdirectories in the current directory:
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>tar -cvzf archivefilename.tgz *</pre>
|-
|}
 
===Unpack .tar archives===
For uncompressed .tar archives:
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>tar xvf file.tar</pre>
|-
|}
 
===Unpack .tar.gz archives===
For gzip compressed .tar.gz archives:
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>tar xvzf file.tar.gz</pre>
|-
|}
 
==System Management==
 
===Reboot the Synology box===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>reboot</pre>
|-
|}
 
===Shutdown the Synology box===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>poweroff</pre>
|-
|}
 
===Stop a process===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>kill processID</pre>
|-
|}
 
===Stop a program===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>killall programName</pre>
|-
|}
 
===Display most current processes running===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>top</pre>
|-
|}
 
===Report disk space usage===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>df</pre>
|-
|}
 
===Show all current processes===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>ps</pre>
|-
|}
 
===Show currently open ports and their status===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>netstat -an</pre>
|-
|}
 
===Change Logged in user===
If you are logged in as root you can open a new shell as if you just logged in as another user, substitute xxx with the user name. To return to root session use "exit"
 
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>su – xxx</pre>
|-
|}
 
===Install a ipkg program package===
Note: This assumes you have already installed ipkg itself.
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>ipkg install fileName</pre>
|-
|}
 
===Uninstall a ipkg program package===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>ipkg remove filename</pre>
|-
|}
 
==Restart Services==
 
===apache===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>/usr/syno/etc/rc.d/S97apache-user.sh restart</pre>
|-
|}
 
===appletalk===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>/usr/syno/etc/rc.d/S81atalk.sh restart</pre>
|-
|}
 
===cron===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>/usr/syno/etc/rc.d/S04crond.sh stop
/usr/syno/etc/rc.d/S04crond.sh start</pre>
|}
 
===ftp===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>/usr/syno/etc/rc.d/S99ftpd.sh restart</pre>
|-
|}
 
===index===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>/usr/syno/etc/rc.d/S66synoindexd.sh restart</pre>
|-
|}
 
===itunes===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>/usr/syno/etc/rc.d/S99itunes.sh restart</pre>
|-
|}
 
===mysql===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>/usr/syno/etc/rc.d/S21mysql.sh restart</pre>
|-
|}
 
===nfs===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>/usr/syno/etc/rc.d/S83nfsd.sh restart</pre>
|-
|}
 
===postgresql===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>/usr/syno/etc/rc.d/S20pgsql.sh restart</pre>
|-
|}
 
===samba===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>/usr/syno/etc/rc.d/S80samba.sh restart</pre>
|-
|}
 
===SSH===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>/usr/syno/etc.defaults/rc.d/S95sshd.sh restart</pre>
|-
|}
 
==System Information==
 
===Check system memory info===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>cat /proc/meminfo</pre>
|-
|}
 
===Check CPU Info===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>cat /proc/cpuinfo</pre>
|-
|}
 
===Check Interrupts in use===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>cat /proc/interrupts</pre>
|-
|}
 
===Check File Systems in use===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>cat /proc/filesystems</pre>
|-
|}
 
===Comprehensive information on the file system format===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>tune2fs -l /dev/hda3</pre>
|-
|}
 
===Check Linux Version===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>cat /proc/version</pre>
|-
|}
 
===Check RAID Devices===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>cat /proc/mdstat</pre>
|-
|}
 
===Check Enviroment Variables===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>env</pre>
|-
|}
 
===Check what physical and logical disks/partitions you have===
{| border="0" cellpadding="0" style="text-align:left"
|-
|For multibay NASs and more info
<pre>cat /proc/diskstats</pre>
or for all NAS types
<pre>cat /proc/partitions</pre>
or for similar but different info
<pre>fdisk -l</pre>
|-
|}
 
==Miscellaneous==
===Clear terminal screen===
{| border="0" cellpadding="0" style="text-align:left"
|-
|<pre>clear</pre>
|-
|}
 
[[Category:SynologyWiki]]
[[Category:ToBeExported]]

Latest revision as of 17:37, 31 January 2015

File Management[edit]

To edit a text file (using vi)[edit]

For info on how to use vi see Basic commands for Linux vi Editor

vi /location_of_file/file_name

To go to a directory[edit]

cd /directoryName

Make a directory[edit]

mkdir /directoryName

List contents of Directory[edit]

dir

Count the number of files in the current Directory and its sub-directories[edit]

find . -type f | wc -l

Check size of Directory and sub-directories[edit]

du -ah /path/to/dir

Find a file[edit]

find / -name fileName

Delete a file[edit]

rm fileName

Delete a directory and its content[edit]

rm -r directoryName
  • Note: Use this command with great care

Move or Rename a file[edit]

mv /sourceDirectory/sourceFile /destination

Copy a file[edit]

cp /sourceDirectory/sourceFile /destination

Copy groups of files[edit]

cp /sourceDirectory/*.* /destination

Copy a directory and any sub directories[edit]

cp -r -p /sourceDirectory /destinationpath

Create a uncompressed tar (.tar) archive[edit]

To create a uncompressed (.tar) archive of all files directories and subdirectories in the current directory:

tar -cvf archivefilename.tar *

Create a compressed tar (.tgz) archive[edit]

To create a compressed (.tgz) archive of all files directories and subdirectories in the current directory:

tar -cvzf archivefilename.tgz *

Unpack .tar archives[edit]

For uncompressed .tar archives:

tar xvf file.tar

Unpack .tar.gz archives[edit]

For gzip compressed .tar.gz archives:

tar xvzf file.tar.gz

System Management[edit]

Reboot the Synology box[edit]

reboot

Shutdown the Synology box[edit]

poweroff

Stop a process[edit]

kill processID

Stop a program[edit]

killall programName

Display most current processes running[edit]

top

Report disk space usage[edit]

df

Show all current processes[edit]

ps

Show currently open ports and their status[edit]

netstat -an

Change Logged in user[edit]

If you are logged in as root you can open a new shell as if you just logged in as another user, substitute xxx with the user name. To return to root session use "exit"

su – xxx

Install a ipkg program package[edit]

Note: This assumes you have already installed ipkg itself.

ipkg install fileName

Uninstall a ipkg program package[edit]

ipkg remove filename

Restart Services[edit]

apache[edit]

/usr/syno/etc/rc.d/S97apache-user.sh restart

appletalk[edit]

/usr/syno/etc/rc.d/S81atalk.sh restart

cron[edit]

/usr/syno/etc/rc.d/S04crond.sh stop
/usr/syno/etc/rc.d/S04crond.sh start

ftp[edit]

/usr/syno/etc/rc.d/S99ftpd.sh restart

index[edit]

/usr/syno/etc/rc.d/S66synoindexd.sh restart

itunes[edit]

/usr/syno/etc/rc.d/S99itunes.sh restart

mysql[edit]

/usr/syno/etc/rc.d/S21mysql.sh restart

nfs[edit]

/usr/syno/etc/rc.d/S83nfsd.sh restart

postgresql[edit]

/usr/syno/etc/rc.d/S20pgsql.sh restart

samba[edit]

/usr/syno/etc/rc.d/S80samba.sh restart

SSH[edit]

/usr/syno/etc.defaults/rc.d/S95sshd.sh restart

System Information[edit]

Check system memory info[edit]

cat /proc/meminfo

Check CPU Info[edit]

cat /proc/cpuinfo

Check Interrupts in use[edit]

cat /proc/interrupts

Check File Systems in use[edit]

cat /proc/filesystems

Comprehensive information on the file system format[edit]

tune2fs -l /dev/hda3

Check Linux Version[edit]

cat /proc/version

Check RAID Devices[edit]

cat /proc/mdstat

Check Enviroment Variables[edit]

env

Check what physical and logical disks/partitions you have[edit]

For multibay NASs and more info
cat /proc/diskstats

or for all NAS types

cat /proc/partitions

or for similar but different info

fdisk -l

Miscellaneous[edit]

Clear terminal screen[edit]

clear