avdl.1 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. ./" Written by Tom Tsagk <tomtsagk@darkdimension.org>
  2. .TH AVDL 1 "2021-02-28" "avdl 0.0.0"
  3. .SH NAME
  4. avdl \- abstract video-game development language compiler
  5. .SH SYNOPSIS
  6. .B avdl\fR [\fB-c\fR] [\fB-o \fIoutput\fR] \fIfile\fR...
  7. .SH DESCRIPTION
  8. .B avdl
  9. is a high level programming language designed to describe a video game
  10. in an abstract way, and then compile it for different platforms.
  11. .SH OPTIONS
  12. .TP
  13. \fB-c\fR
  14. Only compile the given file to an object file.
  15. Each given file will be compiled to a file with the same name
  16. but with a \fB.ago\fR suffix.
  17. If \fB-o\fR is active, only one input file can be given.
  18. .TP
  19. \fB-o \fIoutput\fR
  20. Provide a name for the \fIoutput\fR file.
  21. If \fB-c\fR is active, \fIoutput\fR will be an object file.
  22. Otherwise, \fIoutput\fR will be the executable file.
  23. .SH EXAMPLES
  24. To compile a file, use the following command:
  25. .PP
  26. .nf
  27. .RS
  28. avdl file1 file2
  29. .RE
  30. .fi
  31. .PP
  32. Unless an error occurs, this will compile and link all given files and produce
  33. a file named \fBgame\fR in the current directory, which is the executable for
  34. the game itself.
  35. It's also possible to compile each file individually, and link them
  36. all together in separate steps. This can be used to compile only parts
  37. of a project that have changed, instead of the whole project:
  38. .PP
  39. .nf
  40. .RS
  41. avdl -c file1 -o file1.ago
  42. avdl -c file2 -o file2.ago
  43. avdl file1.ago file2.ago -o my_game
  44. .RE
  45. .fi
  46. .PP
  47. Take a look at \fBsamples/\fR for examples of actual projects.
  48. .SH AUTHOR
  49. Tom Tsagk (tomtsagk@darkdimension.org)