Files
source/S/src--vfs--shell--helpers--README.shell.html
github-actions[bot] 08571174ab Deploy to GitHub Pages
2026-02-01 17:32:02 +00:00

262 lines
16 KiB
HTML

<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>src/vfs/shell/helpers/README.shell</title>
<meta name='robots' content='noindex,nofollow' />
<meta name='generator' content='GLOBAL-6.6.11' />
<meta http-equiv='Content-Style-Type' content='text/css' />
<link rel='stylesheet' type='text/css' href='../style.css' />
</head>
<body>
<!-- beginning of fixed guide -->
<div id='guide'><ul>
<li><a href='#TOP'><img class='icon' src='../icons/first.png' alt='[^]' /></a></li>
<li><a href='#BOTTOM'><img class='icon' src='../icons/last.png' alt='[v]' /></a></li>
<li><a href='#TOP'><img class='icon' src='../icons/top.png' alt='[top]' /></a></li>
<li><a href='#BOTTOM'><img class='icon' src='../icons/bottom.png' alt='[bottom]' /></a></li>
<li><a href='../mains.html'><img class='icon' src='../icons/index.png' alt='[index]' /></a></li>
<li><a href='../help.html'><img class='icon' src='../icons/help.png' alt='[help]' /></a></li>
<li class='standout'><span><a href='../files/src.html'>src</a>/<a href='../files/src--vfs.html'>vfs</a>/<a href='../files/src--vfs--shell.html'>shell</a>/<a href='../files/src--vfs--shell--helpers.html'>helpers</a>/README.shell</span></li>
</ul></div>
<!-- end of fixed guide -->
<div align='right'>Manual pages:
<a href=man/mc.html>mc</a> &bullet; <a href=man/mcdiff.html>mcdiff</a> &bullet; <a href=man/mcedit.html>mcedit</a> &bullet; <a href=man/mcview.html>mcview</a>
</div>
<a id='TOP' name='TOP'></a><h2 class='header'><a href='../mains.html'>root</a>/<a href='../files/src.html'>src</a>/<a href='../files/src--vfs.html'>vfs</a>/<a href='../files/src--vfs--shell.html'>shell</a>/<a href='../files/src--vfs--shell--helpers.html'>helpers</a>/README.shell</h2>
<em class='comment'>/* <img class='icon' src='../icons/n_left.png' alt='[previous]' /><img class='icon' src='../icons/n_right.png' alt='[next]' /><img class='icon' src='../icons/n_first.png' alt='[first]' /><img class='icon' src='../icons/n_last.png' alt='[last]' /><img class='icon' src='../icons/n_top.png' alt='[top]' /><a href='#BOTTOM'><img class='icon' src='../icons/bottom.png' alt='[bottom]' /></a><a href='../mains.html'><img class='icon' src='../icons/index.png' alt='[index]' /></a><a href='../help.html'><img class='icon' src='../icons/help.png' alt='[help]' /></a>&nbsp;<input type='text' readonly onfocus='this.select();' value='+1 src/vfs/shell/helpers/README.shell' /> */</em>
<hr />
<pre>
<a id='L1' name='L1'></a>
<a id='L2' name='L2'></a> FIles transferred over SSH
<a id='L3' name='L3'></a> ~~~~~~~~~~~~~~~~~~~~~~~~~~
<a id='L4' name='L4'></a>
<a id='L5' name='L5'></a>This protocol was designed for transferring files over a remote shell
<a id='L6' name='L6'></a>connection (rsh and compatibles). It can be as well used for transfers over
<a id='L7' name='L7'></a>rsh, and there may be other uses.
<a id='L8' name='L8'></a>
<a id='L9' name='L9'></a>Since version 4.8.31 Midnight Commander doesn't support FISH commands with form
<a id='L10' name='L10'></a>
<a id='L11' name='L11'></a>#FISH_COMMAND [arg1] [arg2] ... [argN]
<a id='L12' name='L12'></a>
<a id='L13' name='L13'></a>and sends requests as shell scripts only.
<a id='L14' name='L14'></a>
<a id='L15' name='L15'></a>First, MC looks for system-wide set of scripts, then it checks whether
<a id='L16' name='L16'></a>current user has host-specific overrides in his per-user MC configuration
<a id='L17' name='L17'></a>directory. User-defined overrides take priority over sytem-wide scripts
<a id='L18' name='L18'></a>if they exist. The order in which the directories are traversed is as follows:
<a id='L19' name='L19'></a>
<a id='L20' name='L20'></a> /usr/libexec/mc/shell
<a id='L21' name='L21'></a> ~/.local/share/mc/shell/&lt;hostname&gt;/
<a id='L22' name='L22'></a>
<a id='L23' name='L23'></a>Server's reply is multiline, but always ends with
<a id='L24' name='L24'></a>
<a id='L25' name='L25'></a>### 000&lt;optional text&gt;
<a id='L26' name='L26'></a>
<a id='L27' name='L27'></a>line. ### is prefix to mark this line, 000 is return code. Return
<a id='L28' name='L28'></a>codes are superset to those used in ftp.
<a id='L29' name='L29'></a>
<a id='L30' name='L30'></a>There are few new exit codes defined:
<a id='L31' name='L31'></a>
<a id='L32' name='L32'></a>000 don't know; if there were no previous lines, this marks COMPLETE
<a id='L33' name='L33'></a>success, if they were, it marks failure.
<a id='L34' name='L34'></a>
<a id='L35' name='L35'></a>001 don't know; if there were no previous lines, this marks
<a id='L36' name='L36'></a>PRELIMinary success, if they were, it marks failure
<a id='L37' name='L37'></a>
<a id='L38' name='L38'></a> Connecting
<a id='L39' name='L39'></a> ~~~~~~~~~~
<a id='L40' name='L40'></a>MC uses "echo SHELL:;/bin/sh" as command executed on remote machine.
<a id='L41' name='L41'></a>
<a id='L42' name='L42'></a> Actions
<a id='L43' name='L43'></a> ~~~~~~~
<a id='L44' name='L44'></a>
<a id='L45' name='L45'></a>Get info about host into $result
<a id='L46' name='L46'></a>
<a id='L47' name='L47'></a> echo $result
<a id='L48' name='L48'></a> echo '### 200'
<a id='L49' name='L49'></a>
<a id='L50' name='L50'></a>Script: info
<a id='L51' name='L51'></a>
<a id='L52' name='L52'></a>--------------------------------------------------------------------------------
<a id='L53' name='L53'></a>
<a id='L54' name='L54'></a>List directory or get status information about single file.
<a id='L55' name='L55'></a>
<a id='L56' name='L56'></a> ls -lLa $1 | grep '^[^cbt]' | ( while read p x u g s m d y n; do echo "P$p $u.$g
<a id='L57' name='L57'></a> S$s
<a id='L58' name='L58'></a> d$m $d $y
<a id='L59' name='L59'></a> :$n
<a id='L60' name='L60'></a> "; done )
<a id='L61' name='L61'></a> ls -lLa $1 | grep '^[cb]' | ( while read p x u g a i m d y n; do echo "P$p $u.$g
<a id='L62' name='L62'></a> E$a$i
<a id='L63' name='L63'></a> dD$m $d $y
<a id='L64' name='L64'></a> :$n
<a id='L65' name='L65'></a> "; done )
<a id='L66' name='L66'></a> echo '### 200'
<a id='L67' name='L67'></a>
<a id='L68' name='L68'></a>Output is in following form (any line except :&lt;filename&gt; may be omitted):
<a id='L69' name='L69'></a>
<a id='L70' name='L70'></a>P&lt;unix permissions&gt; &lt;owner&gt;.&lt;group&gt;
<a id='L71' name='L71'></a>S&lt;size&gt;
<a id='L72' name='L72'></a>d&lt;3-letters month name&gt; &lt;day&gt; &lt;year or HH:MM&gt;
<a id='L73' name='L73'></a>D&lt;year&gt; &lt;month&gt; &lt;day&gt; &lt;hour&gt; &lt;minute&gt; &lt;second&gt;[.1234]
<a id='L74' name='L74'></a>E&lt;major-of-device&gt;,&lt;minor&gt;
<a id='L75' name='L75'></a>:&lt;filename&gt;
<a id='L76' name='L76'></a>L&lt;filename symlink points to&gt;
<a id='L77' name='L77'></a>&lt;blank line to separate items&gt;
<a id='L78' name='L78'></a>
<a id='L79' name='L79'></a>Unix permissions are of form X---------
<a id='L80' name='L80'></a>where X is type of file:
<a id='L81' name='L81'></a> '-' a regular file
<a id='L82' name='L82'></a> 'd' a directory
<a id='L83' name='L83'></a> 'c' a character device
<a id='L84' name='L84'></a> 'b' a block device
<a id='L85' name='L85'></a> 'l' a symbolic link
<a id='L86' name='L86'></a> 'p' a FIFO
<a id='L87' name='L87'></a> 's' a socket.
<a id='L88' name='L88'></a>
<a id='L89' name='L89'></a>'d' has three fields:
<a id='L90' name='L90'></a> month (one of strings Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec)
<a id='L91' name='L91'></a> day of month
<a id='L92' name='L92'></a> single number indicating year, or HH:MM field (assume current year in such
<a id='L93' name='L93'></a> case). As you've probably noticed, this is pretty broken; it is for
<a id='L94' name='L94'></a> compatibility with ls listing.
<a id='L95' name='L95'></a>
<a id='L96' name='L96'></a>Script: ls
<a id='L97' name='L97'></a>
<a id='L98' name='L98'></a>--------------------------------------------------------------------------------
<a id='L99' name='L99'></a>
<a id='L100' name='L100'></a>Get file
<a id='L101' name='L101'></a>
<a id='L102' name='L102'></a> ls -l /some/name | ( read a b c d x e; echo $x ); echo '### 100'; cat /some/name; echo '### 200'
<a id='L103' name='L103'></a>
<a id='L104' name='L104'></a>Server sends line with filesize on it, followed by line with ### 100
<a id='L105' name='L105'></a>indicating partial success, then it sends binary data (exactly filesize bytes)
<a id='L106' name='L106'></a>and follows them with (with no preceding newline) ### 200.
<a id='L107' name='L107'></a>
<a id='L108' name='L108'></a>Note that there's no way to abort running RETR command - except closing
<a id='L109' name='L109'></a>the connection.
<a id='L110' name='L110'></a>
<a id='L111' name='L111'></a>Script: get
<a id='L112' name='L112'></a>
<a id='L113' name='L113'></a>--------------------------------------------------------------------------------
<a id='L114' name='L114'></a>
<a id='L115' name='L115'></a>Put file
<a id='L116' name='L116'></a>
<a id='L117' name='L117'></a> &gt; /file/name; echo '### 001'; ( dd bs=4096 count=&lt;size/4096&gt;; dd bs=&lt;size%4096&gt; count=1 ) 2&gt;/dev/null | ( cat &gt; %s; cat &gt; /dev/null ); echo '### 200'
<a id='L118' name='L118'></a>
<a id='L119' name='L119'></a>This command is for storing /file/name, which is exactly size bytes big.
<a id='L120' name='L120'></a>You probably think I went crazy. Well, I did not: that strange cat &gt; /dev/null
<a id='L121' name='L121'></a>has purpose to discard any extra data which was not written to disk (due to for
<a id='L122' name='L122'></a>example out of space condition).
<a id='L123' name='L123'></a>
<a id='L124' name='L124'></a>[Why? Imagine uploading file with "rm -rf /" line in it.]
<a id='L125' name='L125'></a>
<a id='L126' name='L126'></a>Script: send
<a id='L127' name='L127'></a>
<a id='L128' name='L128'></a>--------------------------------------------------------------------------------
<a id='L129' name='L129'></a>
<a id='L130' name='L130'></a>Change directory
<a id='L131' name='L131'></a>
<a id='L132' name='L132'></a> cd /somewhere; echo '### 000'
<a id='L133' name='L133'></a>
<a id='L134' name='L134'></a>It is specified here, but I'm not sure how wise idea is to use this one:
<a id='L135' name='L135'></a>it breaks stateless-ness of the protocol.
<a id='L136' name='L136'></a>
<a id='L137' name='L137'></a>--------------------------------------------------------------------------------
<a id='L138' name='L138'></a>
<a id='L139' name='L139'></a>Change mode
<a id='L140' name='L140'></a>
<a id='L141' name='L141'></a> chmod 1234 file; echo '### 000'
<a id='L142' name='L142'></a>
<a id='L143' name='L143'></a>Script: chmod
<a id='L144' name='L144'></a>
<a id='L145' name='L145'></a>--------------------------------------------------------------------------------
<a id='L146' name='L146'></a>
<a id='L147' name='L147'></a>Change own
<a id='L148' name='L148'></a>
<a id='L149' name='L149'></a> chown user /file/name; echo '### 000'
<a id='L150' name='L150'></a>
<a id='L151' name='L151'></a>Script: chown
<a id='L152' name='L152'></a>
<a id='L153' name='L153'></a>--------------------------------------------------------------------------------
<a id='L154' name='L154'></a>
<a id='L155' name='L155'></a>Remove file
<a id='L156' name='L156'></a>
<a id='L157' name='L157'></a> rm -f /some/path; echo '### 000'
<a id='L158' name='L158'></a>
<a id='L159' name='L159'></a>Sctipt: unlink
<a id='L160' name='L160'></a>
<a id='L161' name='L161'></a>--------------------------------------------------------------------------------
<a id='L162' name='L162'></a>
<a id='L163' name='L163'></a>Make directory:
<a id='L164' name='L164'></a>
<a id='L165' name='L165'></a> mkdir /some/path; echo '### 000'
<a id='L166' name='L166'></a>
<a id='L167' name='L167'></a>Script: mkdir
<a id='L168' name='L168'></a>
<a id='L169' name='L169'></a>--------------------------------------------------------------------------------
<a id='L170' name='L170'></a>
<a id='L171' name='L171'></a>Remove directory
<a id='L172' name='L172'></a>
<a id='L173' name='L173'></a> rmdir /some/path; echo '### 000'
<a id='L174' name='L174'></a>
<a id='L175' name='L175'></a>Script: rmdir
<a id='L176' name='L176'></a>
<a id='L177' name='L177'></a>--------------------------------------------------------------------------------
<a id='L178' name='L178'></a>
<a id='L179' name='L179'></a>Rename/move file
<a id='L180' name='L180'></a>
<a id='L181' name='L181'></a> mv /path/a /path/b; echo '### 000'
<a id='L182' name='L182'></a>
<a id='L183' name='L183'></a>Script: mv
<a id='L184' name='L184'></a>
<a id='L185' name='L185'></a>--------------------------------------------------------------------------------
<a id='L186' name='L186'></a>
<a id='L187' name='L187'></a>Make link
<a id='L188' name='L188'></a>
<a id='L189' name='L189'></a> ln /path/a /path/b; echo '### 000'
<a id='L190' name='L190'></a>
<a id='L191' name='L191'></a>Script: hardlink
<a id='L192' name='L192'></a>
<a id='L193' name='L193'></a>--------------------------------------------------------------------------------
<a id='L194' name='L194'></a>
<a id='L195' name='L195'></a>Make symbolic link:
<a id='L196' name='L196'></a>
<a id='L197' name='L197'></a> ln -s /path/a /path/b; echo '### 000'
<a id='L198' name='L198'></a>
<a id='L199' name='L199'></a>Script: ln
<a id='L200' name='L200'></a>
<a id='L201' name='L201'></a>--------------------------------------------------------------------------------
<a id='L202' name='L202'></a>
<a id='L203' name='L203'></a>You can use following parameters:
<a id='L204' name='L204'></a>SHELL_FILESIZE
<a id='L205' name='L205'></a>SHELL_FILENAME
<a id='L206' name='L206'></a>SHELL_FILEMODE
<a id='L207' name='L207'></a>SHELL_FILEOWNER
<a id='L208' name='L208'></a>SHELL_FILEGROUPE
<a id='L209' name='L209'></a>SHELL_FILEFROM
<a id='L210' name='L210'></a>SHELL_FILETO
<a id='L211' name='L211'></a>
<a id='L212' name='L212'></a>NB:
<a id='L213' name='L213'></a>'SHELL_FILESIZE' is used if we operate with single file name in 'unlink', 'rmdir', 'chmod', etc...
<a id='L214' name='L214'></a>'SHELL_FILEFROM','SHELL_FILETO' are used if we operate with two files in 'ln', 'hardlink', 'mv' etc...
<a id='L215' name='L215'></a>'SHELL_FILEOWNER', 'SHELL_FILEGROUPE' are a new user/group in chown
<a id='L216' name='L216'></a>
<a id='L217' name='L217'></a>and flags:
<a id='L218' name='L218'></a>SHELL_HAVE_HEAD
<a id='L219' name='L219'></a>SHELL_HAVE_SED
<a id='L220' name='L220'></a>SHELL_HAVE_AWK
<a id='L221' name='L221'></a>SHELL_HAVE_PERL
<a id='L222' name='L222'></a>SHELL_HAVE_LSQ
<a id='L223' name='L223'></a>SHELL_HAVE_DATE_MDYT
<a id='L224' name='L224'></a>
<a id='L225' name='L225'></a>That's all, folks!
<a id='L226' name='L226'></a> pavel@ucw.cz
<a id='L227' name='L227'></a> aborodin@vmail.ru
</pre>
<hr />
<a id='BOTTOM' name='BOTTOM'></a>
<em class='comment'>/* <img class='icon' src='../icons/n_left.png' alt='[previous]' /><img class='icon' src='../icons/n_right.png' alt='[next]' /><img class='icon' src='../icons/n_first.png' alt='[first]' /><img class='icon' src='../icons/n_last.png' alt='[last]' /><a href='#TOP'><img class='icon' src='../icons/top.png' alt='[top]' /></a><img class='icon' src='../icons/n_bottom.png' alt='[bottom]' /><a href='../mains.html'><img class='icon' src='../icons/index.png' alt='[index]' /></a><a href='../help.html'><img class='icon' src='../icons/help.png' alt='[help]' /></a>&nbsp;<input type='text' readonly onfocus='this.select();' value='+227 src/vfs/shell/helpers/README.shell' /> */</em>
</body>
</html>