John Alanbrook
ef28be93db
Some checks failed
Build and Deploy / build-macos (push) Failing after 2s
Build and Deploy / build-windows (CLANG64) (push) Has been cancelled
Build and Deploy / package-dist (push) Has been cancelled
Build and Deploy / deploy-itch (push) Has been cancelled
Build and Deploy / deploy-gitea (push) Has been cancelled
Build and Deploy / build-linux (push) Has been cancelled
102 lines
2.4 KiB
Groff
102 lines
2.4 KiB
Groff
.TH CELL-CONFIG 1 "2025" "Cell" "Cell Manual"
|
|
.SH NAME
|
|
cell config \- manage system and actor configurations
|
|
.SH SYNOPSIS
|
|
.B cell config
|
|
.I command
|
|
[options]
|
|
.SH DESCRIPTION
|
|
The
|
|
.B cell config
|
|
command manages configuration settings for the Cell system. It provides
|
|
functionality to view, set, and manage both system-wide and actor-specific
|
|
configuration values stored in
|
|
.IR .cell/cell.toml .
|
|
.SH COMMANDS
|
|
.TP
|
|
.B get \fIkey\fR
|
|
Get a configuration value. Keys use dot notation (e.g., system.ar_timer).
|
|
.TP
|
|
.B set \fIkey\fR \fIvalue\fR
|
|
Set a configuration value. Values are automatically parsed to appropriate types.
|
|
.TP
|
|
.B list
|
|
List all configuration values in a hierarchical format.
|
|
.TP
|
|
.B actor \fIname\fR get \fIkey\fR
|
|
Get an actor-specific configuration value.
|
|
.TP
|
|
.B actor \fIname\fR set \fIkey\fR \fIvalue\fR
|
|
Set an actor-specific configuration value.
|
|
.TP
|
|
.B actor \fIname\fR list
|
|
List all configuration values for a specific actor.
|
|
.SH SYSTEM KEYS
|
|
.TP
|
|
.B system.ar_timer
|
|
Seconds before idle actor reclamation (default: 60)
|
|
.TP
|
|
.B system.actor_memory
|
|
MB of memory an actor can use; 0 for unbounded (default: 0)
|
|
.TP
|
|
.B system.net_service
|
|
Seconds per network service pull (default: 0.1)
|
|
.TP
|
|
.B system.reply_timeout
|
|
Seconds to hold callback for reply messages; 0 for unbounded (default: 60)
|
|
.TP
|
|
.B system.actor_max
|
|
Maximum number of simultaneous actors (default: 10,000)
|
|
.TP
|
|
.B system.stack_max
|
|
MB of memory each actor's stack can grow to (default: 0)
|
|
.SH EXAMPLES
|
|
View a system configuration value:
|
|
.PP
|
|
.nf
|
|
cell config get system.ar_timer
|
|
.fi
|
|
.PP
|
|
Set a system configuration value:
|
|
.PP
|
|
.nf
|
|
cell config set system.net_service 0.2
|
|
.fi
|
|
.PP
|
|
Configure an actor-specific setting:
|
|
.PP
|
|
.nf
|
|
cell config actor prosperon/_sdl_video set resolution 1920x1080
|
|
cell config actor extramath/spline set precision high
|
|
.fi
|
|
.PP
|
|
List all configurations:
|
|
.PP
|
|
.nf
|
|
cell config list
|
|
.fi
|
|
.PP
|
|
List actor-specific configurations:
|
|
.PP
|
|
.nf
|
|
cell config actor prosperon/_sdl_video list
|
|
.fi
|
|
.SH FILES
|
|
.TP
|
|
.I .cell/cell.toml
|
|
The main configuration file containing all system and actor settings.
|
|
.SH NOTES
|
|
Configuration values are automatically parsed to appropriate types:
|
|
.IP \(bu 2
|
|
Boolean: true, false
|
|
.IP \(bu 2
|
|
Numbers: integers and floats (underscores allowed for readability)
|
|
.IP \(bu 2
|
|
Strings: everything else
|
|
.PP
|
|
Actor configurations are loaded automatically when an actor starts,
|
|
merging the actor-specific settings into the actor's args.
|
|
.SH SEE ALSO
|
|
.BR cell (1),
|
|
.BR cell-init (1),
|
|
.BR cell-get (1) |