sandy

text editor
git clone git://git.suckless.org/sandy
Log | Files | Refs | README | LICENSE

README (1133B)


      1 sandy - simple ncurses text editor
      2 ==================================
      3 sandy is a simple ncurses text editor.
      4 
      5 
      6 Requirements
      7 ------------
      8 In order to build sandy you need the ncurses header files.
      9 
     10 
     11 Installation
     12 ------------
     13 Edit config.mk to match your local setup (sandy is installed into the
     14 /usr/local namespace by default). Optionally, create a config.h file to 
     15 further configure the editor at compile time. An examples file is provided as 
     16 config.def.h.
     17 
     18 Afterwards enter the following command to build and install sandy (use root if
     19 needed):
     20 
     21     make clean install
     22 
     23 
     24 Running sandy
     25 -------------
     26 Use the following syntax:
     27 
     28 	sandy [-r] [-S | -s SYNTAX] [-t TABSTOP] [File]
     29 
     30 Where:
     31 -a starts with autoindent
     32 -r opens the file read-only
     33 -S use no syntax colors at all.
     34 -s SYNTAX  lets you specify the syntax colors for this file
     35 -t TABSTOP sets the tabstop for this instance of sandy
     36 
     37 
     38 Name
     39 ----
     40 In case you are wondering, sandy was the smartest pet ferret. She died of
     41 cancer though. We were sad and started coding this editor.
     42 
     43 
     44 Known issues
     45 ------------
     46 Mouse scroll down works if ncurses is compiled with --enable-ext-mouse.