README

   1  ________           __   __   _____   ____
   2 /\_____  \         /\ \ /\ \ /\  __`\/\  _`\
   3 \/____//'/'     __ \ `\`\/'/'\ \ \/\ \ \,\L\_\
   4      //'/'    /'__`\`\/ > <   \ \ \ \ \/_\__ \
   5     //'/'___ /\  __/   \/'/\`\ \ \ \_\ \/\ \L\ \
   6     /\_______\ \____\  /\_\\ \_\\ \_____\ `\____\
   7     \/_______/\/____/  \/_/ \/_/ \/_____/\/_____/
   8
   9 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  10
  11 ZeX/OS is simple operating system written in
  12 C and assembler languages.
  13
  14 * Archs:        x86, x86_64, ARM
  15 * Mode:         protected
  16 * Supports:     preemptive multitasking, shell, commands, multitty, paging, networking, ipc, graphical environment, 2D and 3D (OpenGL) graphics
  17 * Drivers:      built-in (floppy, video, keyboard, rs232, lba, vga, vesa, pci, mouse, speaker, pcnet32, rtl8029, rtl8139, AC'97)
  18 * Apps:         elf executable (irc, websrv, nc, wm, ..), built-in (fdisk, hdcat ..)
  19 * Filesystem:   zexfs, fat12, fat16, iso9660, ext2, znfs
  20 * Networking:   ipv6, ipv4, tcp, udp, icmp, arp, ndp, dns, unix
  21
  22 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  23
  24 * Default users *
  25
  26 Administrator account:
  27 login name: root
  28 Password: root
  29
  30 Guest account:
  31 Login name: guest
  32 Password: guest
  33
  34 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  35
  36 * Network *
  37
  38 Ethernet IPv4 address:  192.168.0.50
  39 Ethernet IPv6 address:  fc00:0:0:0:0:0:0:10
  40
  41 Ethernet IPv4 gateway:  192.168.0.1
  42 Ethernet IPv6 gateway:  N/A
  43
  44 Easy setup example:
  45 ifconfig eth0 192.168.0.50
  46 ifroute eth0 192.168.0.1
  47 dnsconfig 192.168.0.1
  48
  49 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  50
  51 * Commands list *
  52
  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
  90 netcp           Copy file from network to filesystem
  91 savemode        Make less cpu load
  92 cpuinfo         Show CPU info
  93 adm             Automatic Device Mounter
  94 ttyctrl         TTY Console control
  95
  96 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  97
  98 * Key shortcut *
  99
 100 Backspace       Delete character
 101 Enter           Confirm command
 102 ALT+F1          Console tty0
 103 ALT+F2          Console tty1
 104 ALT+PAGEUP      Switch tty console to next one
 105 ALT+PAGEDOWN    Switch tty console to previous one
 106 CTRL+ALT+DEL    Reboot
 107 CTRL+C          Kill running application on current tty
 108 UP              Previous command from console log
 109 DOWN            Next command from console log
 110 SHIFT           Upper letters
 111
 112 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 113
 114 * User app installation *
 115
 116 ZeX/OS provides you many different apps you can use everyday.
 117 There are favorite apps like irc client, netcat client,
 118 email client, web client, web server, text editor,
 119 music player, remote control server, some games,
 120 calculator, grahical user interface, etc.
 121
 122 Just use build.sh script to install app from directory apps,
 123 for example:
 124         ./build.sh iso app
 125 Where 'app' specify name of app you want to install.
 126
 127 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 128
 129 * User app running *
 130
 131 When you use howto * User app installation *, you should be able to
 132 start apps from your CD-ROM directly.
 133 First you have to mount your cdrom device to directory.
 134 When you dont know, which device it actually is, use command: fdisk
 135 There is list of connected ATA block devices like HDDs or CD-ROMs.
 136 When it is cdrom device, you should see in list filesystem "isofs",
 137 right after partition name, you want to mount (e.g. /dev/hdc0 : isofs).
 138 Now you can use command like: mount /dev/hdc0 /mnt/cdrom
 139 and when no error occured, just go to directory /mnt/cdrom by
 140 command: cd /mnt/cdrom
 141 Now you are able to start it by command: exec yourapp
 142
 143 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 144
 145  * More docs *
 146
 147 ZeX/OS web pages - http://zexos.org
 148 Wiki pages at http://zexos.wiki.sourceforge.net/FAQ
 149 Forum is placed at http://forum.zexos.org
 150
 151 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-