ARM build fixed, paging structures was missing in include file and x86 function was...
[ZeXOS.git] / README
blob2c0f022d7a3380b3fd200359eddc7aea7a03101b
1  ________           __   __   _____   ____
2 /\_____  \         /\ \ /\ \ /\  __`\/\  _`\
3 \/____//'/'     __ \ `\`\/'/'\ \ \/\ \ \,\L\_\
4      //'/'    /'__`\`\/ > <   \ \ \ \ \/_\__ \
5     //'/'___ /\  __/   \/'/\`\ \ \ \_\ \/\ \L\ \
6     /\_______\ \____\  /\_\\ \_\\ \_____\ `\____\
7     \/_______/\/____/  \/_/ \/_/ \/_____/\/_____/
8  
9 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
11 ZeX/OS is simple operating system written in
12 C and assembler languages.
14 * Archs:        x86, x86_64, ARM
15 * Mode:         protected
16 * Supports:     preemptive multitasking, shell, commands, multitty, paging, tcp/ips
17 * Drivers:      built-in (floppy, video, keyboard, rs232, lba, vga, pci, mouse, speaker, pcnet32, rtl8029, rtl8139)
18 * Apps:         elf executable (irc, websrv, nc, wm, ..), built-in (fdisk, hdcat ..)
19 * Filesystem:   zexfs, fat12, fat16, iso9660, ext2
20 * Networking:   ipv6, ipv4, tcp, udp, icmp, arp, ndp, dns
22 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
24 * Default users *
26 Administrator account:
27 login name: root
28 Password: root
30 Guest account:
31 Login name: guest
32 Password: guest
34 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
36 * Network *
38 Ethernet IPv4 address:  192.168.1.50
39 Ethernet IPv6 address:  fc00:0:0:0:0:0:0:10
41 Ethernet IPv4 gateway:  192.168.1.1
42 Ethernet IPv6 gateway:  N/A
44 Easy setup example:
45 ifconfig eth0 192.168.1.50
46 ifroute eth0 192.168.1.1
47 dnsconfig 81.91.216.131
49 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
51 * Commands list *
53 help            Displays list of available commands
54 hdd             Detect HDD
55 reboot          Reboot computer
56 halt            Shutdown computer
57 tasks           Print all tasks
58 ps              Print all process
59 uptime          Print uptime in seconds
60 version         Displays a version of system
61 debug           Change to developer mode
62 mount           Mount device to selected directory
63 umount          Unmount mounted directory
64 env             Displays all env variables
65 cd              Change directory
66 ls              Displays files in current directory
67 cat             Displays text in selected file
68 mkdir           Create a directory
69 exec            Execute a selected program
70 lsdev           Displays found devices
71 login           Login as another user
72 serialw         Write data on rs232
73 serialr         Read data from rs232
74 fdisk           Partition table manipulator
75 hdcat           Read selected block of data from drive
76 free            Display amount of free and used memory
77 date            Show current date and time
78 kill            Send a signal to process
79 modprobe        program to add modules from the kernel
80 lsmod           program to show the status of modules
81 lspci           list all pci devices
82 iflist          Show network interface
83 ifconfig        Configure network interface
84 ifroute         Configure gateway address
85 dnsconfig       Configure domain name server address
86 kbdmap          Change keyboard layout
87 mkzexfs         Create zexfs filesystem on hdd
88 ping            Send ICMP echo request
89 netexec         Execute file from network
91 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
93 * Key shortcut *
95 Backspace       Delete character
96 Enter           Confirm command
97 F1              Console tty0
98 F2              Console tty1
99 F3              Console tty2
100 F4              Console tty3
101 CTRL+ALT+DEL    Reboot
102 CTRL+C          Kill running application on tty
103 UP              Previous command from console log
104 DOWN            Next command from console log
106 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
108  * More docs *
110 ZeX/OS web pages - http://zexos.org
111 Wiki pages at http://zexos.wiki.sourceforge.net/FAQ
112 Forum is placed at http://forum.zexos.org
114 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-