From 579f55965b6857c1337cbd0fd31ad326e915e192 Mon Sep 17 00:00:00 2001
From: Nathan Glenn <garfieldnate@gmail.com>
Date: Wed, 16 Oct 2024 08:58:01 -0500
Subject: [PATCH] Update debugger/cli parameters page

Required leading `-` was missing for debugger params, making it basically
unusable. Cleanup the formatting, etc. and add a missing param, as well.
---
 .../CommandLineOptionsForDebuggerAndCLI.md    | 47 ++++++++++---------
 1 file changed, 25 insertions(+), 22 deletions(-)

diff --git a/docs/reference/CommandLineOptionsForDebuggerAndCLI.md b/docs/reference/CommandLineOptionsForDebuggerAndCLI.md
index d6e01b11..67574093 100644
--- a/docs/reference/CommandLineOptionsForDebuggerAndCLI.md
+++ b/docs/reference/CommandLineOptionsForDebuggerAndCLI.md
@@ -2,40 +2,43 @@
 date: 2016-09-30
 tags:
     - debugger
+    - cli
 authors:
     - soar
 ---
 
-<!-- markdown-link-check-disable-next-line -->
-<!-- old URL: https://soar.eecs.umich.edu/articles/articles/documentation/224-command-line-options-for-the-java-debugger-and-cli -->
-
 # Command-Line Options for the Java Debugger and CLI
 
 ## Soar Java Debugger Command Line Options
 
-- remote Use a remote connection (with default ip and port values)
-- ip xxx Use this IP value (implies remote connection)
-- port ppp Use this port (implies remote connection, without any remote options
-    we start a local kernel)
-- agent `<name>` On a remote connection select this agent as initial agent
-- agent `<name>` On a local connection use this as the name of the initial agent
-- source `<path>` Load this file of productions on launch (only valid for local kernel)
-- quitonfinish When combined with source causes the debugger to exit after sourcing that one file
-- listen ppp Use this port to listen for remote connections (only valid for a local kernel)
-- maximize Start with maximized window
-- width `<width>` Start with this window width
-- height `<height>` Start with this window height
-- x `<x>` -y `<y>` Start with this window position
-- cascade Cascade each window that starts (offsetting from the -x `<x>` -y `<y>`
-    if given). This option now always on. (Providing width/height/x/y => not a
+-   `-remote`: Use a remote connection (with default ip and port values)
+-   `-ip <ip>`: Use the specified IP value (implies remote connection)
+-   `-port <port>`: Use the specified port (implies remote connection)
+-   `-agent <name>`: On a remote connection, select the specified agent as
+initial agent; on a local connection, assign the specified name to the initial agent
+-   `-source <path>`: Source the specified .soar file on launch (only valid for local
+kernel)
+-   `-quitonfinish`: When combined with `-source`, causes the debugger to exit after
+sourcing that one file
+-   `-listen <port>`: Use the specified port to listen for remote connections (only
+valid for a local kernel)
+-   `-maximize`: Start with maximized window
+-   `-width <width>`: Start with the specified window width
+-   `-height <height>`: Start with the specified window height
+-   `-x <x> -y <y>`: Start with the specified window position
+-   `-cascade`: Cascade each opened window (offsetting from the -x `<x>` -y `<y>`
+    if given). This option is always on. (Providing width/height/x/y => not a
     maximized window)
+-   `-layout <xml file>`: Load the layout (window positions, types of windows etc.)
+from the specified XML file. You can also store the layout file in the debugger settings
+folder and refer to it by just the file name.
 
 ## Soar-CLI Command Line Options
 
-- `-l` Listen on, i.e. launches Soar kernel in new thread
-- `-n` No syntax coloring
-- `-p` `<port>` Listens on port `<port>`
-- `-s` `<file>` Sources file `<file>` on load
+-   `-l`: Listen on, i.e. launches Soar kernel in new thread
+-   `-n`: No syntax coloring
+-   `-p <port>`: Listens on port `<port>`
+-   `-s <file>`: Sources file `<file>` on load
 
 To manage multiple agents, you can use the commands "create", "list", and "switch".