nortti
/
sortix-mirror
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
sortix-mirror/share/man/man7/user-guide.7

146 lines
3.8 KiB
Groff
Raw Normal View History

Fix date format in manual pages.
2017-06-03 19:27:30 +00:00
.Dd December 28, 2015
Add manual pages.
2015-10-05 22:32:45 +00:00
.Dt USER-GUIDE 7
.Os
.Sh NAME
.Nm user-guide
.Nd basic system usage and overview
.Sh DESCRIPTION
Sortix is a small self-hosting Unix-like operating system developed since 2011.
This document covers matters relevant to new users from other Unix-like
operating systems.
.Ss Introduction
Add sysinstall(8), sysmerge(8), and sysupgrade(8).
2016-02-18 21:16:02 +00:00
The installation process is covered in
.Xr installation 7 .
Bootable cdrom releases will offer the options of running a live environment,
installing the operating system, or upgrading an existing installation.
.Pp
You will be presented a with standard Unix command line environment upon login or
booting the live environment.
Add manual pages.
2015-10-05 22:32:45 +00:00
.Ss Shutdown
.Xr init 8
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
spawns a session after boot.
This is
Add login(8).
2015-12-25 02:24:51 +00:00
.Xr login 8
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
if the system is booted in multi-user mode.
This is a root shell if booted in single-user mode.
Add manual pages.
2015-10-05 22:32:45 +00:00
.Pp
Add halt(8), poweroff(8), and reboot(8).
2021-12-11 02:28:59 +00:00
To power off the computer login as user
.Sy poweroff
or run
.Xr poweroff 8
after logging in.
To reboot the computer login as user
.Sy reboot
or run
.Xr reboot 8
after logging in.
Add manual pages.
2015-10-05 22:32:45 +00:00
.Ss Keyboard Layout
The kernel has a default US keyboard layout compiled into it.
.Pp
You can change the current keyboard layout using
.Xr chkblayout 1 .
It loads the requested keyboard layout with the requested name from
.Pa /share/kblayout .
For instance to load a Danish keyboard layout:
.Pp
.Dl $ chkblayout dk
.Pp
The system has basic unicode capabilities but the kernel console font is limited
to characters in codepage 437.
.Ss Graphics
The bootloader prepares an appropriate video mode to the best of its abilities.
If you have a supported graphics card:
.Pp
.Bl -bullet -compact
.It
.Xr bga 4 -
Bochs Graphics Adapter found in virtual machines.
.El
.Pp
Then you can run
.Xr chvideomode 1
to change the video mode after boot.
.Pp
.Dl $ chvideomode
.Ss Manual
The system manual can be viewed with the
.Xr man 1
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
program.
Sortix is currently in the process of being documented and many manual pages are
missing.
The current priority is to document areas specific to Sortix and assume standard
knowledge from other operating systems.
Add manual pages.
2015-10-05 22:32:45 +00:00
.Ss Editor
.Xr editor 1
is the standard text file editor.
.Ss Games
The base system comes with games such as
.Xr asteroids 6 .
Additional third party games may be installed through ports.
.Ss Filesystem Hierarchy
The filesystem hierarchy is described in
.Xr hier 7 .
.Ss Memory Usage
The
.Xr memstat 1
command shows the current memory usage.
.Ss Third Party Software
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
Releases come with useful third party software installed.
The
Add manual pages.
2015-10-05 22:32:45 +00:00
.Pa /tix/installed.list
file lists all currently installed ports.
.Ss Source Code
Releases come full with the system source code in
.Pa /src
Add git repository to /src if applicable.
2015-08-14 15:25:10 +00:00
as a
.Xr git 1
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
repository along with the tools to build it and develop it.
The build process is covered in
Add manual pages.
2015-10-05 22:32:45 +00:00
.Xr development 7 .
.Ss Mounting
You can mount ext2 partitions using
.Xr extfs 8
and unmount them with
.Xr unmount 8 :
.Pp
.Dl $ extfs /dev/ahci0p1 /mnt
.Dl $ unmount /mnt
.Pp
Beware that
.Xr init 8
Fix mountpoint typo in user-guide(7).
2017-06-04 21:43:08 +00:00
is unaware of manual mountpoints and powering off will not gracefully unmount.
Add manual pages.
2015-10-05 22:32:45 +00:00
The
.Xr extfs 8
driver only supports the
.Sy large_file
and
.Sy filetype
Correct manpage spacing per roff(7) convention. roff(7) dictates that "Each sentence should terminate at the end of an input line." Instead of doing this, Sortix manpages (incorrectly) used double-spaces to separate sentences. Additionally, fix a few small typos.
2017-02-15 21:56:28 +00:00
ext2 extensions.
You can make a compatible filesystem with:
Add manual pages.
2015-10-05 22:32:45 +00:00
.Pp
.Dl $ mkfs.ext2 -O none,large_file,filetype
.Ss Networking
Add networking stack. This change adds all the kernel parts of a network stack. The network stack is partial but implements many of the important parts. Add if(4) network interface abstraction. Network interfaces are registered in a global list that can be iterated and each assigned an unique integer identifier. Add reference counted packets with a cache that recycles recent packets. Add support for lo(4) loopback and ether(4) ethernet network interfaces. The /dev/lo0 loopback device is created automatically on boot. Add arp(4) address resolution protocol driver for translation of inet(4) network layer addresses into ether(4) link layer addresses. arp(4) entries are cached and evicted from the cache when needed or when the entry has not been used for a while. The cache is limited to 256 entries for now. Add ip(4) internet protocol version 4 support. IP fragmentation and options are not implemented yet. Add tcp(4) transmission control protocol sockets for a reliable transport layer protocol that provides a reliable byte stream connection between two hosts. The implementation is incomplete and does not yet implement out of band data, options, and high performance extensions. Add udp(4) user datagram protocol sockets for a connectionless transport layer that provides best-effort delivery of datagrams. Add ping(4) sockets for a best-effort delivery of echo datagrams. Change type of sa_family_t from unsigned short to uint16_t. Add --disable-network-drivers to the kernel(7) options and expose it with a bootloader menu. tix-iso-bootconfig can set this option by default. Import CRC32 code from libz for the Ethernet checksum. This is a compatible ABI change that adds features to socket(2) (AF_INET, IPPROTO_TCP, IPPROTO_UDP, IPPROTO_PING), the ioctls for if(4), socket options, and the lo0 loopback interface. This commit is based on work by Meisaka Yukara contributed as the commit bbf7f1e8a5238a2bd1fe8eb1d2cc5c9c2421e2c4. Almost no lines of this work remains in this final commit as it has been rewritten or refactored away over the years, see the individual file headers for which files contain remnants of this work. Co-authored-by: Meisaka Yukara <Meisaka.Yukara@gmail.com>
2022-12-04 23:35:21 +00:00
Internet Protocol version 4
.Pq Xr ip 4
networking is available if you have a supported network interface
.Pq Xr if 4 .
.Pp
The Internet Protocol version 6
.Xr ( ip6 4 )
is not yet supported.
Add sf(1).
2015-09-20 01:33:04 +00:00
.Ss Serial Transfer
It is possible to transfer files over serial devices as described in
.Xr serial-transfer 7 .
Add manual pages.
2015-10-05 22:32:45 +00:00
.Ss Development
The system is self-hosting and is capable of building itself as described in
.Xr development 7 .
Ports are cross-compiled as described in
.Xr cross-development 7 ,
but it is becoming feasible to build a large number of them natively.
.Sh SEE ALSO
.Xr cross-development 7 ,
Add sf(1).
2015-09-20 01:33:04 +00:00
.Xr development 7 ,
Add sysinstall(8), sysmerge(8), and sysupgrade(8).
2016-02-18 21:16:02 +00:00
.Xr installation 7 ,
.Xr serial-transfer 7 ,
.Xr upgrade 7