newtrodit.man

$NEWTRODIT_MANUAL
What is Newtrodit?

 Newtrodit is a console-based text editor. As Windows doesn't include a console text editor, 
 Newtrodit is probably your best choice. The editor is designed to be minimalistic and easy to use.
 Even if it's keyboard-based, the keybinds are easy to remember due to the fact that they're
 similar to other applications.
 The main goal is having a noticeable efficiency increase when working.

 Command line usage

 newtrodit [switches] [file]

         --fontcolor, -fc  Changes the font color.
         --converttab, -t  Converts tabs to spaces.
         --convertnull, -n Converts nulls characters to spaces.
         --devmode, -d     Enables developer mode.
         --menucolor, -mc  Changes Newtrodit's menus color.
         --help, -h        Opens this Newtrodit help manual.
         --lfunix, -ln     Changes the line ending to UNIX (LF).
         --lfwin, -lw      Changes the line ending to Windows (CRLF).
         --line, -l        Displays line number.
         --sigsegv, -s     Displays a message when a SIGSEGV (Segmentation fault) is caught.
         --version, -v     Shows Newtrodit's version.

 Unlike previous versions, switches can go at any position, before or after file/files.
 
 Usage inside application

 Navigation

 You can use any other raw text editor navigation features. 
 To move between lines and columns, you may use arrow keys. 
 You can see the current cursor position at the bottom left part, 
 where Ln means line and Col means column  

 End and Home, PageUp, PageDown

 Keybinds

 Keybinds are written as follows:

 '^'     = Control
 'A-'    = Alt
 'S-'    = Shift
 
 Navigation inside the manual
 
 ^X        = Go back to Newtrodit
 A-F4      = Exit Newtrodit
 PageUp    = Go to the previous page
 PageDown  = Go to the next page
 Up        = Go to the previous line
 Down      = Go to the next line

 Control keybinds

 ^C        = Copy line to clipboard
 ^D        = Show line content (requires developer mode)
 ^F        = Find string
 ^G        = Go to a specific line
 ^H        = Replace string
 ^L        = Toggle line count
 ^N        = New file
 ^O        = Open file
 ^R        = Reload file (same as '^N' and '^O')
 ^S        = Save file
 ^W        = Close current file
 ^V        = Paste line from clipboard
 ^X        = Exit Newtrodit

 S-^F      = Find string (case insensitive)
 S-^H      = Same as F1 (shows help manual)
 S-^L      = Locate files. See the advanced section for more information.
 S-^R      = Reload settings
 S-^S      = Save file as
 S-^D      = Toggle dev mode
 S-^N      = Toggle null character to spaces conversion
 S-^T      = Toggle tab to spaces conversion

 Alt keybinds

 A-Home    = Go to the beginning of the first non-blank space
 A-^N      = Create a new empty file and save it (same as '^N' and '^S')
 A-^R      = Encode/decode line using ROT13 algorithm

 Function keys keybinds

 F1        = Shows help (manual)
 F2        = Renames current file (can also be used to move)
 F3        = Next find occurrence (can only be used after '^F')
 F5        = Runs a macro, if a macro hasn't been defined yet, it will run the current file
 F6        = Adds current date and time
 F10       = Opens containing directory in Windows Explorer

 ^F1       = About Newtrodit
 ^F4       = Close current file (same as ^W)
 
 S-F10     = Opens a terminal instance in current directory
 A-F4      = Same as ^X (exits Newtrodit)


 Advanced keybinds

  Locate files (S-^L)
  
   The function will search for a file only in the current directory.
   Additionally, you can use wildcards to perform an advanced search.
   Newtrodit will automatically detect if you are using wildcards and it will change the search path accordingly.
   
   The asterisk (*) can be used to replace any word of any length.
   The question mark (?) can be used to replace character of always length 1.

   The function will search for the first matches, displaying the date and time in the
   DD/MM/YYYY hh:mm:ss format. File size is shown in bytes.
    
   Example
  
    'hello' would match for example a file called 'myhello.txt' and 'hello.txt'
    'hello*' won't match 'myhello.txt', but '*hello*' will.
    'hello.???' will only match files with the name 'hello' and a 3 character extension.

     This wildcards have the same behavior as cmd.exe DIR command ones.

     Known issue: Correct file size displaying is limited to 4 GB due to 32-bit integer limitations.

  
 Settings

 Newtrodit can be customizable as you like it by changing some settings.

 Settings file must be located in the same directory as Newtrodit with the name 'newtrodit.config'.
 It's a simple text file with one line per setting, with an INI-like syntax.

 Comments are allowed in the settings file with the ';' (semicolon) character.
 
 List of settings types

   String       = String. This setting type stores a string of text.
   Integer      = Integer. This setting type stores an integer, which may have a defined range.
   Boolean      = Boolean. This setting type stores a boolean value (either 1 or 0).

   In case that a boolean or an integer setting is not a valid value, 0 will be used by default.

 List of all settings

  Boolean settings

  - converttab    = Toggle tab conversion from tabs to spaces. Boolean type.
  - convertnull   = Toggle null character conversion to spaces. Boolean type.
  - curinsert     = Toggle cursor size change in insert mode. Boolean type.
  - devmode       = Toggle developer mode. Boolean type.
  - linecount     = Toggle line count. Boolean type.
  - mouse         = Toggle mouse support. Boolean type.
  - oldkeybinds   = Toggle old keybind usage. Boolean type.
  - sigsegv       = Toggle SIGSEGV handler. Boolean type.
  - syntax        = Toggle syntax highlighting. Boolean type.

  Integer settings

  - codepage      = Console codepage. Integer type
  - cursize       = Console cursor size. Integer type.
  - fontcolor     = Font color. Integer type. The range of the integer is betwen 0 and 255.
  - linecountwide = Line count width. Integer type.
  - menucolor     = Menu color. Integer type. The range of the integer is betwen 0 and 255.
  - tabwide       = Tab width. Integer type.
  - xsize         = X size of the window (columns). Integer type.
  - ysize         = Y size of the window (lines). Integer type.

  String settings

  - manfile       = Name of the manual file. String type.
  - newline       = New line, which will be added to the end of each line. String type.

 WARNING: Wrongly configuring settings cause unexpected behavior and major issues.

 Example of a settings file:

  ; Example settings file for Newtrodit
  codepage=437
  xsize=120
  ysize=30
  linecount=0
  tabwide=8
  manfile=newtrodit.man
  linecountwide=3
  mouse=1

 Syntax highlighting

 Newtrodit has some syntax highlighting rules to color the code you're writing and to make it
 easier to read. 

 Syntax highlighting format is similar to the settings format (INI-like), but with some special keywords.
 Each line must start with a keyword followed by an equal sign and the color of the keyword.

 Here's a list of all special keywords:
  $$NEWTRODIT_SYNTAX = This must be the first line of the file to indicate the syntax
                      highlighting format used is the one used by Newtrodit.
                                  
  $$LANGUAGE           = This keyword indicates the language of the code.
  $$COMMENT            = This keyword the comment string.
  $$COMMENT_COLOR      = Comments color.
  $$QUOTE_COLOR        = String color.
  $$DEFAULT_COLOR      = Code that isn't highlighting will be colored in this color.
  $$NUMBER_COLOR       = Every number written will be colored in this color.
  $$SEPARATORS         = Code separator characters. (e.g. ',.()+-/*=~[];{}<> ')
  $$CAPITAL            = Enable capital words syntax highlighting. Use '0' to disable and '1' to enable.
  $$CAPITAL_COLOR      = Color for the highlighted capital words. Requires $$CAPITAL to be set to '1'.
  $$CAPITAL_MIN        = Minimum length for capital words to be highlighted. Requires $$CAPITAL to be set to '1'.

 Old keybinds

 Some keybinds can be changed using the oldkeybinds setting.
 Here's a list of the replaced keybinds:

 ^X --> ^Q (Quit Newtrodit)
 ^K --> ^X (Cut line)
 
 Developer mode

 Developer mode is a setting made for users who want to use test/debug features on Newtrodit.
 Features of developer mode:
  - Displaying line content (^D)
  - Displaying old and new console size (F12)

 To toggle developer mode, press 'S-^D'


 Configuration priority

  The setting that applies last has the highest priority.

  For example, writing 2 lines with the same setting will result in the second line
  being written with the second setting, ignoring the first one.

  Priority order (lowest to highest):
  - Newtrodit default settings
  - Settings file
  - Command line arguments
  - Inside application setting changing
  - Syntax highlighting (for colors scheme)

  Even if a color scheme has been defined in command line arguments, syntax highlighting will override the colored
  keywords.

 Crashes

 As all programs, Newtrodit isn't perfect. If you find a bug, please report it on:
  $G/issues

 Most common crash causes are:
  - Not enough memory available
  - Invalid settings file
  - Invalid or too large syntax highlighting scheme
  - Memory allocation error
  - Buffer overflow

 There are also more rare crashes, such as:
  - Memory/stack corruption
  - External program interferences (e.g. external programs that write memory to Newtrodit)
  
  If you find a crash, please report it with all the information on the crash screen.
  

 Internal working

 At the moment, Newtrodit has a buffer of $X x $Y. The maximum number of lines is
 $Y, with a buffer increment of $I, while line length depends on the memory available on the system.
 
 This is due to the fact that the buffer is a 2D array of characters. This is one of the main 
 issues that Newtrodit has to deal with and we're working on it.

 It has been coded in C to have maximum performance. At the moment it's only compatible with
 Windows because it uses the Windows API to display the GUI.

 Some more specific internal working behaviors:
  - New lines while reading a file are added when a '\n' character is found, 
    and not when a custom new line string is found.


 The source code of Newtrodit is composed by:

 dialog.h           : Dialogs
 globals.h          : Global variables
 manual.c           : Manual
 newtrodit.c        : Main source file
 newtrodit_core.h   : All core functions
 newtrodit_func.c   : Main functions
 newtrodit_gui.c    : GUI loading
 newtrodit_syntax.h : Syntax highlighting


 License
 
 Newtrodit is licensed under the GNU General Public License version 3.0.
 See https://www.gnu.org/licenses for more details.

 About Newtrodit
 
 Newtrodit is a free open-source program created by anic17 with some contributions by other members.
 Started working at the ending of 2020, it's now another way to code in Windows.

 Here's a list of people who contributed and helped in the creation of this project:
   - Karanveer Chouhan (TheKvc)   : Helped in lots of things.
   - Teddy Astie (TSnake41)       : Issue solving.
   - Teoman Deniz (TeomanDeniz)   : Feedback and testing.
   - Tim Greller (timlg07)        : Issue solving.
   - Mathieu (Illegal-Services)   : Lots of feedback and testing.
   - Zackery Smith (ZackeryRSmith): Helped a lot while developing Newtrodit, creator of the Linux port 

 I would like to give special thanks to ZackeryRSmith, who helped a lot to Newtrodit development.
 Newtrodit $V
 Build date [$B]

 Feel free to contribute here: $G