Contents

• Chapter ‍1 Guide
• Chapter ‍2 OMake quickstart guide
  • 2.1 Description
    • 2.1.1 Automatic dependency analysis
    • 2.1.2 Content-based dependency analysis
  • 2.2 For users already familiar with make
  • 2.3 Building a small C program
  • 2.4 Larger projects
  • 2.5 Subdirectories
  • 2.6 Other things to consider
  • 2.7 Building OCaml programs
  • 2.8 The OMakefile and OMakeroot files
  • 2.9 Multiple version support
  • 2.10 Notes
• Chapter ‍3 Additional build examples
  • 3.1 OMakeroot vs. OMakefile
  • 3.2 An example C project
  • 3.3 An example OCaml project
  • 3.4 OCaml ‍Library with C ‍Dependencies
  • 3.5 Handling new languages
    • 3.5.1 Defining a default compilation rule
    • 3.5.2 Defining a rule for linking
    • 3.5.3 Dependency scanning
    • 3.5.4 Pulling it all together
    • 3.5.5 Finishing up
  • 3.6 Collapsing the hierarchy, .SUBDIRS bodies
    • 3.6.1 Using glob patterns
    • 3.6.2 Simplified sub-configurations
    • 3.6.3 Computing the subdirectory list
    • 3.6.4 Temporary directories
• Chapter ‍4 OMake concepts and syntax
  • 4.1 Variables
  • 4.2 Adding to a variable definition
  • 4.3 Arrays
  • 4.4 Special characters and quoting
  • 4.5 Function definitions
    • 4.5.1 Passing parameterized bodies
    • 4.5.2 Keyword arguments
  • 4.6 Curried functions
  • 4.7 Comments
  • 4.8 File inclusion
  • 4.9 Scoping, sections
  • 4.10 Conditionals
  • 4.11 Matching
  • 4.12 Objects
  • 4.13 Classes
  • 4.14 Inheritance
  • 4.15 static.
    • 4.15.1 .STATIC
      • 4.15.1.1 .MEMO
      • 4.15.1.2 :key:
  • 4.16 Constants
• Chapter ‍5 Variables and Naming
  • 5.1 private.
  • 5.2 this.
  • 5.3 global.
  • 5.4 protected.
  • 5.5 public.
  • 5.6 Qualified blocks
  • 5.7 declare
• Chapter ‍6 Expressions and values
  • 6.1 Dynamic scoping
  • 6.2 Functional evaluation
  • 6.3 Exporting the environment
    • 6.3.1 Export regions
    • 6.3.2 Returning values from exported regions
  • 6.4 Objects
  • 6.5 Field and method calls
  • 6.6 Method override
  • 6.7 Super calls
• Chapter ‍7 Additional language examples
  • 7.1 Strings, arrays, and sequences
  • 7.2 Quoted strings
  • 7.3 Merging
  • 7.4 Arrays
  • 7.5 Files and directories
  • 7.6 Iteration, mapping, and foreach
  • 7.7 Lazy expressions
    • 7.7.1 A larger example of lazy expressions
  • 7.8 Scoping and exports
  • 7.9 Shell aliases
  • 7.10 Input/output redirection on the cheap
• Chapter ‍8 Rules
  • 8.1 Implicit rules
  • 8.2 Bounded implicit rules
  • 8.3 section
  • 8.4 section rule
  • 8.5 Special dependencies
    • 8.5.1 :effects:
    • 8.5.2 :exists:
    • 8.5.3 :key:
    • 8.5.4 :normal:
    • 8.5.5 :optional:
    • 8.5.6 :scanner:
    • 8.5.7 :squash:
    • 8.5.8 :value:
  • 8.6 .SCANNER rules
    • 8.6.1 Named scanners, and the :scanner: dependencies
    • 8.6.2 Notes
  • 8.7 .DEFAULT
  • 8.8 .SUBDIRS
  • 8.9 .INCLUDE
  • 8.10 .PHONY
  • 8.11 Rule scoping
    • 8.11.1 Scoping of implicit rules
    • 8.11.2 Scoping of .SCANNER rules
    • 8.11.3 Scoping for .PHONY targets
  • 8.12 Running OMake from a subdirectory
    • 8.12.1 Phony targets in a subdirectory
    • 8.12.2 Hierarchy of .PHONY targets
  • 8.13 Pathnames in rules
• Chapter ‍9 Base library
  • 9.1 Builtin variables
  • 9.2 Logic, Boolean functions, and control flow
    • 9.2.1 not
    • 9.2.2 equal
    • 9.2.3 and
    • 9.2.4 or
    • 9.2.5 if
    • 9.2.6 switch, match
    • 9.2.7 try
    • 9.2.8 raise
    • 9.2.9 exit
    • 9.2.10 defined
    • 9.2.11 defined-env
    • 9.2.12 getenv
    • 9.2.13 setenv
    • 9.2.14 unsetenv
    • 9.2.15 get-registry
    • 9.2.16 getvar
    • 9.2.17 setvar
  • 9.3 Arrays and sequences
    • 9.3.1 array
    • 9.3.2 split
    • 9.3.3 concat
    • 9.3.4 length
    • 9.3.5 nth
    • 9.3.6 replace-nth
    • 9.3.7 nth-hd
    • 9.3.8 nth-tl
    • 9.3.9 subrange
    • 9.3.10 rev
    • 9.3.11 join
    • 9.3.12 string
    • 9.3.13 string-length
    • 9.3.14 subst
    • 9.3.15 string-escaped, ocaml-escaped, html-escaped, html-pre-escaped
    • 9.3.16 c-escaped, id-escaped, sql-escaped, uri-escaped
    • 9.3.17 hexify, unhexify
    • 9.3.18 decode-uri, encode-uri
    • 9.3.19 quote
    • 9.3.20 quote-argv
    • 9.3.21 html-string
    • 9.3.22 addsuffix
    • 9.3.23 mapsuffix
    • 9.3.24 addsuffixes, addprefixes
    • 9.3.25 removeprefix
    • 9.3.26 removesuffix
    • 9.3.27 replacesuffixes
    • 9.3.28 addprefix
    • 9.3.29 mapprefix
    • 9.3.30 add-wrapper
    • 9.3.31 set
    • 9.3.32 mem
    • 9.3.33 intersection
    • 9.3.34 intersects
    • 9.3.35 set-diff
    • 9.3.36 filter
    • 9.3.37 filter-out
    • 9.3.38 capitalize
    • 9.3.39 uncapitalize
    • 9.3.40 uppercase
    • 9.3.41 lowercase
    • 9.3.42 system
    • 9.3.43 shell
    • 9.3.44 export
    • 9.3.45 while
    • 9.3.46 break
    • 9.3.47 random, random-init
  • 9.4 Arithmetic
    • 9.4.1 int
    • 9.4.2 float
    • 9.4.3 Basic arithmetic
    • 9.4.4 Comparisons
  • 9.5 First-class functions
    • 9.5.1 fun
    • 9.5.2 apply
    • 9.5.3 applya
    • 9.5.4 create-map, create-lazy-map
  • 9.6 Iteration and mapping
    • 9.6.1 foreach
  • 9.7 Boolean tests
    • 9.7.1 sequence-forall
    • 9.7.2 sequence-exists
    • 9.7.3 sequence-sort
    • 9.7.4 compare
• Chapter ‍10 File, I/O and system operations
  • 10.1 File names
    • 10.1.1 file, dir
    • 10.1.2 tmpdir
    • 10.1.3 tmpfile
    • 10.1.4 in
    • 10.1.5 basename
    • 10.1.6 dirname
    • 10.1.7 rootname
    • 10.1.8 dirof
    • 10.1.9 fullname
    • 10.1.10 absname
    • 10.1.11 homename
    • 10.1.12 suffix
  • 10.2 Path search
    • 10.2.1 which
    • 10.2.2 where
    • 10.2.3 rehash
    • 10.2.4 exists-in-path
    • 10.2.5 digest, digest-optional, digest-string
    • 10.2.6 find-in-path, find-in-path-optional
    • 10.2.7 digest-in-path, digest-in-path-optional
  • 10.3 File stats
    • 10.3.1 file-exists, target-exists, target-is-proper
    • 10.3.2 stat-reset
    • 10.3.3 filter-exists, filter-targets, filter-proper-targets
    • 10.3.4 find-targets-in-path, find-targets-in-path-optional
    • 10.3.5 find-ocaml-targets-in-path-optional
    • 10.3.6 file-sort
      • 10.3.6.1 sort rule
    • 10.3.7 file-check-sort
  • 10.4 Globbing and file listings
    • 10.4.1 glob
    • 10.4.2 ls
    • 10.4.3 subdirs
  • 10.5 Filesystem operations
    • 10.5.1 mkdir
    • 10.5.2 Stat
    • 10.5.3 stat, lstat
    • 10.5.4 unlink
    • 10.5.5 rename
    • 10.5.6 link
    • 10.5.7 symlink, symlink-raw
    • 10.5.8 readlink, readlink-raw
    • 10.5.9 chmod
    • 10.5.10 chown
    • 10.5.11 utimes
    • 10.5.12 truncate
    • 10.5.13 umask
  • 10.6 vmount
    • 10.6.1 vmount
    • 10.6.2 vmount-map
    • 10.6.3 add-project-directories
    • 10.6.4 remove-project-directories
  • 10.7 File predicates
    • 10.7.1 test
    • 10.7.2 find
  • 10.8 IO functions
    • 10.8.1 Standard channels
    • 10.8.2 open-in-string
    • 10.8.3 open-out-string, out-contents
    • 10.8.4 fopen
    • 10.8.5 close
    • 10.8.6 read, input-line
    • 10.8.7 write
    • 10.8.8 lseek
    • 10.8.9 rewind
    • 10.8.10 tell
    • 10.8.11 flush
    • 10.8.12 channel-name
    • 10.8.13 dup
    • 10.8.14 dup2
    • 10.8.15 set-nonblock
    • 10.8.16 set-close-on-exec-mode
    • 10.8.17 pipe
    • 10.8.18 mkfifo
    • 10.8.19 select
    • 10.8.20 lockf
    • 10.8.21 InetAddr
    • 10.8.22 Host
    • 10.8.23 gethostbyname
    • 10.8.24 Protocol
    • 10.8.25 getprotobyname
    • 10.8.26 Service
    • 10.8.27 getservbyname
    • 10.8.28 socket
    • 10.8.29 bind
    • 10.8.30 listen
    • 10.8.31 accept
    • 10.8.32 connect
    • 10.8.33 getchar
    • 10.8.34 gets
    • 10.8.35 fgets
  • 10.9 Printing functions
  • 10.10 Value printing functions
    • 10.10.1 Miscellaneous functions
      • 10.10.1.1 set-channel-line
  • 10.11 Higher-level IO functions
    • 10.11.1 Regular expressions
    • 10.11.2 cat
    • 10.11.3 grep
    • 10.11.4 scan
    • 10.11.5 awk
    • 10.11.6 fsubst
    • 10.11.7 lex
    • 10.11.8 lex-search
    • 10.11.9 Lexer
    • 10.11.10 Omake_lexer.Lexer matching
    • 10.11.11 Extending lexer definitions
    • 10.11.12 Threading the lexer object
    • 10.11.13 Parser
    • 10.11.14 Calling the parser
    • 10.11.15 Parsing control
    • 10.11.16 Extending parsers
    • 10.11.17 Passwd
    • 10.11.18 getpwnam, getpwuid
    • 10.11.19 getpwents
    • 10.11.20 Group
    • 10.11.21 getgrnam, getgrgid
    • 10.11.22 tgetstr
    • 10.11.23 xterm-escape-begin, xterm-escape-end
    • 10.11.24 xterm-escape
    • 10.11.25 prompt-invisible-begin, prompt-invisible-end
    • 10.11.26 prompt-invisible
    • 10.11.27 gettimeofday
    • 10.11.28 Tm
    • 10.11.29 gmtime, localtime
    • 10.11.30 mktime, normalize-time
• Chapter ‍11 Shell commands
  • 11.1 What is considered a shell command?
  • 11.2 Simple commands
  • 11.3 Globbing
  • 11.4 Background jobs
  • 11.5 Command sequence
  • 11.6 File redirection
  • 11.7 Pipelines
  • 11.8 Conditional execution
  • 11.9 Grouping
  • 11.10 Basic builtin functions
    • 11.10.1 echo
    • 11.10.2 cd
  • 11.11 Job control builtin functions
    • 11.11.1 jobs
    • 11.11.2 bg
    • 11.11.3 fg
    • 11.11.4 stop
    • 11.11.5 wait
    • 11.11.6 kill
  • 11.12 Command history
    • 11.12.1 history
• Chapter ‍12 The standard objects
  • 12.1 Pervasives objects
    • 12.1.1 Object
    • 12.1.2 Map
    • 12.1.3 Number
    • 12.1.4 Int
    • 12.1.5 Float
    • 12.1.6 Sequence
    • 12.1.7 Array
    • 12.1.8 String
    • 12.1.9 Fun
    • 12.1.10 Rule
    • 12.1.11 Target
    • 12.1.12 Node
    • 12.1.13 File
    • 12.1.14 Dir
    • 12.1.15 Channel
    • 12.1.16 InChannel
    • 12.1.17 OutChannel
    • 12.1.18 Location
    • 12.1.19 Exception
    • 12.1.20 RuntimeException
    • 12.1.21 UnbuildableException
    • 12.1.22 Shell
• Chapter ‍13 Build functions and utilities
  • 13.1 Builtin .PHONY targets
  • 13.2 Options and versioning
    • 13.2.1 OMakeFlags
    • 13.2.2 OMakeVersion
    • 13.2.3 cmp-versions
    • 13.2.4 DefineCommandVars
  • 13.3 Examining the dependency graph
    • 13.3.1 dependencies, dependencies-all, dependencies-proper
    • 13.3.2 target
    • 13.3.3 find-build-targets
    • 13.3.4 project-directories
    • 13.3.5 rule
    • 13.3.6 build
  • 13.4 The OMakeroot file
    • 13.4.1 Variables
    • 13.4.2 System variables
  • 13.5 Building C and C++ code
    • 13.5.1 Autoconfiguration variables
      • 13.5.1.1 Unix-like systems
      • 13.5.1.2 Win32
    • 13.5.2 C and C++ configuration variables
    • 13.5.3 Generated C files
      • 13.5.3.1 CGeneratedFiles, LocalCGeneratedFiles
    • 13.5.4 Building C programs and Libraries
      • 13.5.4.1 StaticCLibrary, DynamicCLibrary
      • 13.5.4.2 StaticCLibraryCopy, DynamicCLibraryCopy
      • 13.5.4.3 StaticCLibraryInstall, DynamicCLibraryInstall
      • 13.5.4.4 StaticCObject, StaticCObjectCopy, StaticCObjectInstall
      • 13.5.4.5 CProgram
      • 13.5.4.6 CProgramCopy
      • 13.5.4.7 CProgramInstall
      • 13.5.4.8 CXXProgram, CXXProgramInstall
      • 13.5.4.9 StaticCXXLibrary, StaticCXXLibraryCopy, StaticCXXLibraryInstall, DynamicCXXLibrary, DynamicCXXLibraryCopy, DynamicCXXLibraryInstall
  • 13.6 Building OCaml code
    • 13.6.1 Autoconfiguration variables for OCaml compilation
    • 13.6.2 Configuration variables for OCaml compilation
    • 13.6.3 OCaml command flags
    • 13.6.4 Library variables
    • 13.6.5 Generated OCaml Files
      • 13.6.5.1 OCamlGeneratedFiles, LocalOCamlGeneratedFiles
      • 13.6.5.2 Automatic discovery of generated files during dependency analysis
      • 13.6.5.3 DeclareMLIOnly
    • 13.6.6 Using the Menhir parser generator
    • 13.6.7 Building OCaml programs and Libraries
      • 13.6.7.1 OCamlLibrary
      • 13.6.7.2 OCamlMixedLibrary
      • 13.6.7.3 OCamlPackage
      • 13.6.7.4 OCamlLibraryCopy
      • 13.6.7.5 OCamlLibraryInstall
      • 13.6.7.6 OCamlProgram
      • 13.6.7.7 OCamlMixedProgram
      • 13.6.7.8 OCamlProgramCopy
      • 13.6.7.9 OCamlProgramInstall
  • 13.7 Building L^AT_EX files
    • 13.7.1 Configuration variables
    • 13.7.2 Building L^AT_EX documents
      • 13.7.2.1 LaTeXDocument
      • 13.7.2.2 TeXGeneratedFiles, LocalTeXGeneratedFiles
      • 13.7.2.3 LaTeXDocumentCopy
      • 13.7.2.4 LaTeXDocumentInstall
• Chapter ‍14 Autoconfiguration functions and variables
  • 14.1 General-purpose autoconfiguration functions
    • 14.1.1 ConfMsgChecking, ConfMsgResult
    • 14.1.2 ConfMsgWarn, ConfMsgError
    • 14.1.3 ConfMsgYesNo, ConfMsgFound
    • 14.1.4 TryCompileC, TryLinkC, TryRunC
    • 14.1.5 RunCProg
    • 14.1.6 CheckCHeader, VerboseCheckCHeader
    • 14.1.7 CheckCLib, VerboseCheckCLib
    • 14.1.8 CheckProg
  • 14.2 Translating autoconf scripts
  • 14.3 Predefined configuration tests
    • 14.3.1 NCurses library configuration
    • 14.3.2 ReadLine library configuration
    • 14.3.3 Snprintf configuration
• Chapter ‍15 The OSH shell
  • 15.1 Startup
  • 15.2 Aliases
  • 15.3 Interactive syntax
• Appendix ‍A Synopsis
  • A.1 General usage
  • A.2 Output control
    • A.2.1 -s
    • A.2.2 -S
    • A.2.3 -w
    • A.2.4 --progress
    • A.2.5 --print-status
    • A.2.6 --print-exit
    • A.2.7 --verbose
    • A.2.8 --output-normal
    • A.2.9 --output-postpone
    • A.2.10 --output-only-errors
    • A.2.11 --output-at-end
    • A.2.12 -o
  • A.3 Build options
    • A.3.1 -k
    • A.3.2 -n
    • A.3.3 -p
    • A.3.4 -P
    • A.3.5 -R
    • A.3.6 -t
    • A.3.7 -U
    • A.3.8 --depend
    • A.3.9 --configure
    • A.3.10 --force-dotomake
    • A.3.11 --dotomake
    • A.3.12 -j
    • A.3.13 --print-dependencies
    • A.3.14 --show-dependencies
    • A.3.15 --all-dependencies
    • A.3.16 --verbose-dependencies
    • A.3.17 --install
    • A.3.18 --install-all
    • A.3.19 --install-force
    • A.3.20 --absname
    • A.3.21 variable definition
  • A.4 Additional options
  • A.5 Environment variables
    • A.5.1 OMAKEFLAGS
    • A.5.2 OMAKELIB
  • A.6 Functions
    • A.6.1 OMakeFlags
  • A.7 Option processing
  • A.8 .omakerc
• Appendix ‍B OMake grammar
  • B.1 OMake lexical conventions
    • B.1.1 Comments
    • B.1.2 Special characters
    • B.1.3 Identifiers
    • B.1.4 Command identifiers
    • B.1.5 Variable references
    • B.1.6 String constants
  • B.2 The OMake grammar
    • B.2.1 Expressions
      • B.2.1.1 Inline applications
    • B.2.2 Statements and programs
      • B.2.2.1 Special forms
      • B.2.2.2 Variable definitions
      • B.2.2.3 Applications and function definitions
      • B.2.2.4 Objects
      • B.2.2.5 Rules
      • B.2.2.6 Shell commands
  • B.3 Dollar modifiers
  • B.4 Programming syntax
    • B.4.1 Usage
    • B.4.2 Examples
• Appendix ‍C References
  • C.1 See Also
  • C.2 Version
  • C.3 License and Copyright
  • C.4 Original Author
  • C.5 Maintainer