Documentation

Documentation

Reference for Golf version 165

Note: All the topics below are available as a single-page documentation.

API
Client-API
Server-API

Application information
get-app

Array
get-array
new-array
purge-array
read-array
resize-array
write-array

Base64
decode-base64
encode-base64

Cookies
delete-cookie
get-cookie
set-cookie

Database
begin-transaction
commit-transaction
current-row
database-config-file
db-error
mariadb-database
postgresql-database
rollback-transaction
run-query
sqlite-database

Debugging
debugging
trace-run

Distributed computing
call-remote
new-remote
read-remote
run-remote

Documentation
documentation

Download and build
install
install-arch
install-debian
install-fedora
install-opensuse
uninstall

Encryption
decrypt-data
derive-key
encrypt-data
hash-string
hmac-string
random-crypto
random-string

Error handling
db-error
error-code
error-handling
report-error

FIFO
delete-fifo
new-fifo
purge-fifo
read-fifo
rewind-fifo
write-fifo

Files
close-file
copy-file
delete-file
file-position
file-storage
file-uploading
lock-file
open-file
read-file
read-line
rename-file
stat-file
temporary-file
uniq-file
unlock-file
write-file

General
about-golf
directories
SELinux

Golf compiler and utility
gg

Hex encoding
decode-hex
encode-hex

Index
delete-index
get-index
new-index
purge-index
read-index
use-cursor
write-index

JSON parsing
json-doc
read-json

Language
inline-code
statements
syntax-highlighting
unused-var
variable-scope

License
license

LIFO
delete-lifo
new-lifo
purge-lifo
read-lifo
rewind-lifo
write-lifo

Linked list
delete-list
get-list
new-list
position-list
purge-list
read-list
write-list

Memory
memory-handling

Messages
get-message
new-message
read-message
SEMI
write-message

Numbers
number-expressions
number-string
set-number
string-number

Output
finish-output
flush-output
output-statement
pf-out
pf-url
pf-web
p-num
p-out
p-path
p-source-file
p-source-line
p-url
p-web

Program execution
exec-program
handler-status

Program flow
break-loop
code-blocks
continue-loop
do-once
exit-handler
if-defined
if-true
return-handler
set-bool
start-loop

Quick start
123-hello-world

Regex
match-regex

Request data
get-param
request-body
set-param

Request information
get-req

Requests
request

Running application
application-setup
CGI
command-line
service

Safety
call-extended
extended-mode

Service manager
mgrg

Service processing
after-handler
before-handler
begin-handler
call-handler

Strings
copy-string
count-substring
delete-string
lower-string
read-split
replace-string
set-string
split-string
string-length
trim-string
upper-string
write-string

System information
get-sys

Time
get-time
pause-program

URL encoding
decode-url
encode-url

UTF8
text-utf8
utf8-text

Web
call-web
out-header
send-file
silent-header

Web encoding
decode-web
encode-web

Web servers
connect-apache-tcp-socket
connect-apache-unix-socket
connect-haproxy-tcp-socket
connect-nginx-tcp-socket
connect-nginx-unix-socket

Man pages

Golf documentation is available online, and also as man pages (i.e. manual pages). You can take any of the topics above and type it in man, for example

man run-query

Copied!

The Golf section is '2gg', so in case of other software having conflicting topic names, you can also type

man 2gg run-query

Copied!

Copyright (c) 2019-2025 Gliim LLC. All contents on this web site is "AS IS" without warranties or guarantees of any kind.