Documentation Update: Add linux ssh guide

.rstcheck.cfg

@@ -6,4 +6,5 @@ ignore_directives =
     doxygenfile,
     include,
     mdinclude,
+    tab,
     todo,

docs/requirements.txt

@@ -5,3 +5,4 @@ rstcheck[sphinx]==6.2.0
 rstfmt==0.0.14
 Sphinx==7.2.5
 sphinx-copybutton==0.5.2
+sphinx_inline_tabs==2023.4.21

docs/source/about/advanced_usage.rst

@@ -866,18 +866,18 @@ capture
               or `nvlax <https://github.com/illnyang/nvlax/>`__.
    wlr        Capture for wlroots based Wayland compositors via DMA-BUF.
    kms        DRM/KMS screen capture from the kernel. This requires that sunshine has cap_sys_admin capability.
-              See :ref:`Linux Setup <about/usage:setup>`.
+              See :ref:`Linux Setup <about/usage:linux>`.
    x11        Uses XCB. This is the slowest and most CPU intensive so should be avoided if possible.
    =========  ===========
-   
+
 **Default**
    Automatic. Sunshine will use the first capture method available in the order of the table above.
 
 **Example**
    .. code-block:: text
 
       capture = kms
-      
+
 encoder
 ^^^^^^^
 
@@ -992,7 +992,7 @@ nvenc_preset
 **Description**
    NVENC encoder performance preset.
    Higher numbers improve compression (quality at given bitrate) at the cost of increased encoding latency.
-   Recommended to change only when limited by network or decoder, otherwise similar effect can be accomplished by increasing bitrate. 
+   Recommended to change only when limited by network or decoder, otherwise similar effect can be accomplished by increasing bitrate.
 
    .. Note:: This option only applies when using NVENC `encoder`_.
 
@@ -1027,7 +1027,7 @@ nvenc_twopass
 **Description**
    Enable two-pass mode in NVENC encoder.
    This allows to detect more motion vectors, better distribute bitrate across the frame and more strictly adhere to bitrate limits.
-   Disabling it is not recommended since this can lead to occasional bitrate overshoot and subsequent packet loss. 
+   Disabling it is not recommended since this can lead to occasional bitrate overshoot and subsequent packet loss.
 
    .. Note:: This option only applies when using NVENC `encoder`_.
 
@@ -1058,7 +1058,7 @@ nvenc_realtime_hags
 **Description**
    Use realtime gpu scheduling priority in NVENC when hardware accelerated gpu scheduling (HAGS) is enabled in Windows.
    Currently NVIDIA drivers may freeze in encoder when HAGS is enabled, realtime priority is used and VRAM utilization is close to maximum.
-   Disabling this option lowers the priority to high, sidestepping the freeze at the cost of reduced capture performance when the GPU is heavily loaded. 
+   Disabling this option lowers the priority to high, sidestepping the freeze at the cost of reduced capture performance when the GPU is heavily loaded.
 
    .. Note:: This option only applies when using NVENC `encoder`_.
 

docs/source/about/app_examples.rst → docs/source/about/guides/app_examples.rst

@@ -128,11 +128,53 @@ Changing Resolution and Refresh Rate (Linux - X11)
 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
 | **Field**            | **Value**                                                                                                                             |
 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
-| Command Preparations | Do: ``sh -c "xrandr --output HDMI-1 --mode \"${SUNSHINE_CLIENT_WIDTH}x${SUNSHINE_CLIENT_HEIGHT}\" --range ${SUNSHINE_CLIENT_FPS}"``   |
+| Command Preparations | Do: ``sh -c "xrandr --output HDMI-1 --mode \"${SUNSHINE_CLIENT_WIDTH}x${SUNSHINE_CLIENT_HEIGHT}\" --rate ${SUNSHINE_CLIENT_FPS}"``    |
 |                      +---------------------------------------------------------------------------------------------------------------------------------------+
 |                      | Undo: ``xrandr --output HDMI-1 --mode 3840x2160 --rate 120``                                                                          |
 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
 
+.. hint::
+   The above only works if the xrandr mode already exists. You will need to create new modes to stream to macOS and iOS devices, since they use non standard resolutions.
+
+   You can update the ``Do`` command to this:
+      .. code-block:: bash
+
+         bash -c "${HOME}/scripts/set-custom-res.sh \"${SUNSHINE_CLIENT_WIDTH}\" \"${SUNSHINE_CLIENT_HEIGHT}\" \"${SUNSHINE_CLIENT_FPS}\""
+
+   The ``set-custom-res.sh`` will have this content:
+      .. code-block:: bash
+
+         #!/bin/bash
+
+         # Get params and set any defaults
+         width=${1:-1920}
+         height=${2:-1080}
+         refresh_rate=${3:-60}
+
+         # You may need to adjust the scaling differently so the UI/text isn't too small / big
+         scale=${4:-0.55}
+
+         # Get the name of the active display
+         display_output=$(xrandr | grep " connected" | awk '{ print $1 }')
+
+         # Get the modeline info from the 2nd row in the cvt output
+         modeline=$(cvt ${width} ${height} ${refresh_rate} | awk 'FNR == 2')
+         xrandr_mode_str=${modeline//Modeline \"*\" /}
+         mode_alias="${width}x${height}"
+
+         echo "xrandr setting new mode ${mode_alias} ${xrandr_mode_str}"
+         xrandr --newmode ${mode_alias} ${xrandr_mode_str}
+         xrandr --addmode ${display_output} ${mode_alias}
+
+         # Reset scaling
+         xrandr --output ${display_output} --scale 1
+
+         # Apply new xrandr mode
+         xrandr --output ${display_output} --primary --mode ${mode_alias} --pos 0x0 --rotate normal --scale ${scale}
+
+         # Optional reset your wallpaper to fit to new resolution
+         # xwallpaper --zoom /path/to/wallpaper.png
+
 Changing Resolution and Refresh Rate (Linux - Wayland)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

docs/source/about/guides/guides.rst

@@ -0,0 +1,10 @@
+Guides
+======
+
+Collection of guides written by the community!
+
+.. toctree::
+   :maxdepth: 2
+
+   app_examples
+   linux/linux