Skip to content

Commit 4cc5f8e

Browse files
braindigitalisbraindigitalis
committed
mount command
1 parent fbee903 commit 4cc5f8e

File tree

2 files changed

+221
-0
lines changed

2 files changed

+221
-0
lines changed

‎docs/mount-command.html‎

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.14.0"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Retro Rocket OS: mount command</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<script type="text/javascript" src="clipboard.js"></script>
13+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<script type="text/javascript" src="cookie.js"></script>
17+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
18+
<script type="text/javascript" src="search/searchdata.js"></script>
19+
<script type="text/javascript" src="search/search.js"></script>
20+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
21+
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
22+
<link href="style.css" rel="stylesheet" type="text/css"/>
23+
</head>
24+
<body>
25+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
26+
<div id="titlearea">
27+
<table cellspacing="0" cellpadding="0">
28+
<tbody>
29+
<tr id="projectrow">
30+
<td id="projectlogo"><img alt="Logo" src="rr.png"/></td>
31+
<td id="projectalign">
32+
<div id="projectname">Retro Rocket OS
33+
</div>
34+
<div id="projectbrief">BASIC-Powered Operating System</div>
35+
</td>
36+
</tr>
37+
</tbody>
38+
</table>
39+
</div>
40+
<!-- end header part -->
41+
<!-- Generated by Doxygen 1.14.0 -->
42+
<script type="text/javascript">
43+
var searchBox = new SearchBox("searchBox", "search/",'.html');
44+
</script>
45+
<script type="text/javascript">
46+
$(function() { codefold.init(); });
47+
</script>
48+
<script type="text/javascript" src="menudata.js"></script>
49+
<script type="text/javascript" src="menu.js"></script>
50+
<script type="text/javascript">
51+
$(function() {
52+
initMenu('',true,false,'search.php','Search',true);
53+
$(function() { init_search(); });
54+
});
55+
</script>
56+
<div id="main-nav"></div>
57+
</div><!-- top -->
58+
<div id="side-nav" class="ui-resizable side-nav-resizable">
59+
<div id="nav-tree">
60+
<div id="nav-tree-contents">
61+
<div id="nav-sync" class="sync"></div>
62+
</div>
63+
</div>
64+
<div id="splitbar" style="-moz-user-select:none;"
65+
class="ui-resizable-handle">
66+
</div>
67+
</div>
68+
<script type="text/javascript">
69+
$(function(){initNavTree('mount-command.html','',''); });
70+
</script>
71+
<div id="container">
72+
<div id="doc-content">
73+
<!-- window showing the filter options -->
74+
<div id="MSearchSelectWindow"
75+
onmouseover="return searchBox.OnSearchSelectShow()"
76+
onmouseout="return searchBox.OnSearchSelectHide()"
77+
onkeydown="return searchBox.OnSearchSelectKey(event)">
78+
</div>
79+
80+
<!-- iframe showing the search results (closed by default) -->
81+
<div id="MSearchResultsWindow">
82+
<div id="MSearchResults">
83+
<div class="SRPage">
84+
<div id="SRIndex">
85+
<div id="SRResults"></div>
86+
<div class="SRStatus" id="Loading">Loading...</div>
87+
<div class="SRStatus" id="Searching">Searching...</div>
88+
<div class="SRStatus" id="NoMatches">No Matches</div>
89+
</div>
90+
</div>
91+
</div>
92+
</div>
93+
94+
<div><div class="header">
95+
<div class="headertitle"><div class="title">mount command </div></div>
96+
</div><!--header-->
97+
<div class="contents">
98+
<div class="textblock"><h2 class="doxsection"><a class="anchor" id="mount-directory-storage-device-name-filesystem-type"></a>
99+
mount [directory] [storage-device-name] [filesystem-type]</h2>
100+
<p>Attaches a file system on a storage device to the visible set of directories and files you can see and work with.</p>
101+
<p>Think of mounting a filesystem like plugging in something to a power outlet. Once you have plugged it in and turned it on, it is available to use. This is basically how file systems work.</p>
102+
<ul>
103+
<li>The first parameter is the directory, this can be any existing empty directory in the file system. For example /harddisk, /ramdisk, etc.</li>
104+
<li>The second parameter is a storage device name. Storage device names are allocated by the system. Hard disks (SATA, NVMe etc) start with <span class="tt">hd</span> and are suffixed by number starting at 0, so the first found hard disk is <span class="tt">hd0</span>, the next <span class="tt">hd1</span> etc. Ram disks start with <span class="tt">ram</span> amd a number. CD/DVD drives start with <span class="tt">cd</span> and a number.</li>
105+
<li>The third parameter is a filesystem type, supported file system types are listed below.</li>
106+
</ul>
107+
<table class="markdownTable">
108+
<tr class="markdownTableHead">
109+
<th class="markdownTableHeadNone">File system type </th><th class="markdownTableHeadNone">Full name </th><th class="markdownTableHeadNone">Description </th></tr>
110+
<tr class="markdownTableRowOdd">
111+
<td class="markdownTableBodyNone">rfs </td><td class="markdownTableBodyNone">RetroFS, the Retro Rocket native file system </td><td class="markdownTableBodyNone">Readable, writeable file system for large hard disks, e.g. NVMe, SATA. The default file system type for fixed disks and ramdisks </td></tr>
112+
<tr class="markdownTableRowEven">
113+
<td class="markdownTableBodyNone">iso9660 </td><td class="markdownTableBodyNone">ISO 9660 file system for CDs and DVDs </td><td class="markdownTableBodyNone">Read-only file system mainly for CDs and DVDs. The default file system of the Retro Rocket LiveCD </td></tr>
114+
<tr class="markdownTableRowOdd">
115+
<td class="markdownTableBodyNone">fat32 </td><td class="markdownTableBodyNone">FAT32 DOS and Windows file system </td><td class="markdownTableBodyNone">Readable, writeable file system used for removable media, and the recovery/boot partition of installed systems </td></tr>
116+
<tr class="markdownTableRowEven">
117+
<td class="markdownTableBodyNone">devfs </td><td class="markdownTableBodyNone">Device tree file system </td><td class="markdownTableBodyNone">Readable, writeable file system which device drivers may use to expose device-specific information and control surfaces. * </td></tr>
118+
<tr class="markdownTableRowOdd">
119+
<td class="markdownTableBodyNone">dummyfs </td><td class="markdownTableBodyNone">Dummy File System </td><td class="markdownTableBodyNone">The dummy file system does nothing, you cannot read or write to it. It is the placeholder for everything until the system boots </td></tr>
120+
</table>
121+
<ul>
122+
<li>For <span class="tt">devfs</span>, you cannot create arbitrary files in this file system. Your ability to read from, or write to the files in this directory depends on the behaviour of the driver which places the file there.</li>
123+
</ul>
124+
<h3 class="doxsection"><a class="anchor" id="example-15"></a>
125+
Example</h3>
126+
<div class="fragment"><div class="line">mount /harddisk hd0 rfs</div>
127+
</div><!-- fragment --><h3 class="doxsection"><a class="anchor" id="notes-192"></a>
128+
Notes</h3>
129+
<ul>
130+
<li>Mounting a storage device with a file system it is not configured for will result in an error</li>
131+
<li>Unmounting file systems is <b>not yet supported</b>. To clear a mounting, it is currently required that you reboot the system. </li>
132+
</ul>
133+
</div></div><!-- contents -->
134+
</div><!-- PageDoc -->
135+
</div><!-- doc-content -->
136+
<div id="page-nav" class="page-nav-panel">
137+
<div id="page-nav-resize-handle"></div>
138+
<div id="page-nav-tree">
139+
<div id="page-nav-contents">
140+
</div><!-- page-nav-contents -->
141+
</div><!-- page-nav-tree -->
142+
</div><!-- page-nav -->
143+
</div><!-- container -->
144+
<!-- start footer part -->
145+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
146+
<ul>
147+
<li class="navelem"><a href="index.html">Retro Rocket OS</a></li><li class="navelem"><a href="user-guide.html">User Guide</a></li><li class="navelem"><a href="commands.html">Commands</a></li>
148+
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
149+
</ul>
150+
</div>
151+
</body>
152+
</html>

‎docs/xml/mount-command.xml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
2+
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.14.0" xml:lang="en-US">
3+
<compounddef id="mount-command" kind="page">
4+
<compoundname>mount-command</compoundname>
5+
<title>mount command</title>
6+
<briefdescription>
7+
</briefdescription>
8+
<detaileddescription>
9+
<sect1 id="mount-command_1mount-directory-storage-device-name-filesystem-type_1s1"><sect2 id="mount-command_1mount-directory-storage-device-name-filesystem-type">
10+
<title>mount [directory] [storage-device-name] [filesystem-type]</title><para>Attaches a file system on a storage device to the visible set of directories and files you can see and work with.</para>
11+
<para>Think of mounting a filesystem like plugging in something to a power outlet. Once you have plugged it in and turned it on, it is available to use. This is basically how file systems work.</para>
12+
<para><itemizedlist>
13+
<listitem><para>The first parameter is the directory, this can be any existing empty directory in the file system. For example /harddisk, /ramdisk, etc.</para>
14+
</listitem><listitem><para>The second parameter is a storage device name. Storage device names are allocated by the system. Hard disks (SATA, NVMe etc) start with <computeroutput>hd</computeroutput> and are suffixed by number starting at 0, so the first found hard disk is <computeroutput>hd0</computeroutput>, the next <computeroutput>hd1</computeroutput> etc. Ram disks start with <computeroutput>ram</computeroutput> amd a number. CD/DVD drives start with <computeroutput>cd</computeroutput> and a number.</para>
15+
</listitem><listitem><para>The third parameter is a filesystem type, supported file system types are listed below.</para>
16+
</listitem></itemizedlist>
17+
</para>
18+
<para><table rows="6" cols="3"><row>
19+
<entry thead="yes"><para>File system type </para>
20+
</entry><entry thead="yes"><para>Full name </para>
21+
</entry><entry thead="yes"><para>Description </para>
22+
</entry></row>
23+
<row>
24+
<entry thead="no"><para>rfs </para>
25+
</entry><entry thead="no"><para>RetroFS, the Retro Rocket native file system </para>
26+
</entry><entry thead="no"><para>Readable, writeable file system for large hard disks, e.g. NVMe, SATA. The default file system type for fixed disks and ramdisks </para>
27+
</entry></row>
28+
<row>
29+
<entry thead="no"><para>iso9660 </para>
30+
</entry><entry thead="no"><para>ISO 9660 file system for CDs and DVDs </para>
31+
</entry><entry thead="no"><para>Read-only file system mainly for CDs and DVDs. The default file system of the Retro Rocket LiveCD </para>
32+
</entry></row>
33+
<row>
34+
<entry thead="no"><para>fat32 </para>
35+
</entry><entry thead="no"><para>FAT32 DOS and Windows file system </para>
36+
</entry><entry thead="no"><para>Readable, writeable file system used for removable media, and the recovery/boot partition of installed systems </para>
37+
</entry></row>
38+
<row>
39+
<entry thead="no"><para>devfs </para>
40+
</entry><entry thead="no"><para>Device tree file system </para>
41+
</entry><entry thead="no"><para>Readable, writeable file system which device drivers may use to expose device-specific information and control surfaces. * </para>
42+
</entry></row>
43+
<row>
44+
<entry thead="no"><para>dummyfs </para>
45+
</entry><entry thead="no"><para>Dummy File System </para>
46+
</entry><entry thead="no"><para>The dummy file system does nothing, you cannot read or write to it. It is the placeholder for everything until the system boots </para>
47+
</entry></row>
48+
</table>
49+
</para>
50+
<para><itemizedlist>
51+
<listitem><para>For <computeroutput>devfs</computeroutput>, you cannot create arbitrary files in this file system. Your ability to read from, or write to the files in this directory depends on the behaviour of the driver which places the file there.</para>
52+
</listitem></itemizedlist>
53+
</para>
54+
<sect3 id="mount-command_1example-15">
55+
<title>Example</title><para><programlisting><codeline><highlight class="normal">mount<sp/>/harddisk<sp/>hd0<sp/>rfs</highlight></codeline>
56+
</programlisting></para>
57+
</sect3>
58+
<sect3 id="mount-command_1notes-192">
59+
<title>Notes</title><para><itemizedlist>
60+
<listitem><para>Mounting a storage device with a file system it is not configured for will result in an error</para>
61+
</listitem><listitem><para>Unmounting file systems is <bold>not yet supported</bold>. To clear a mounting, it is currently required that you reboot the system. </para>
62+
</listitem></itemizedlist>
63+
</para>
64+
</sect3>
65+
</sect2></sect1>
66+
</detaileddescription>
67+
<location file="docpages/user-guide/commands/mount.md"/>
68+
</compounddef>
69+
</doxygen>

0 commit comments

Comments
 (0)