services: sddm: Deprecate 'sddm-service' procedure.
* gnu/services/sddm.scm (sddm-service): Mark as deprecated. * doc/guix.texi (X Window): Document 'sddm-service-type' and 'sddm-configuration'.
This commit is contained in:
		
							parent
							
								
									5ac5f2c129
								
							
						
					
					
						commit
						8cf3e167c1
					
				
					 2 changed files with 39 additions and 10 deletions
				
			
		|  | @ -14193,16 +14193,43 @@ Relogin after logout. | |||
| 
 | ||||
| @cindex login manager | ||||
| @cindex X11 login | ||||
| @deffn {Scheme Procedure} sddm-service config | ||||
| Return a service that spawns the SDDM graphical login manager for config of | ||||
| type @code{<sddm-configuration>}. | ||||
| @defvr {Scheme Variable} sddm-service-type | ||||
| This is the type of the service to run the | ||||
| @uref{https://github.com/sddm/sddm,SSDM display manager}.  Its value | ||||
| must be a @code{sddm-configuration} record (see below). | ||||
| 
 | ||||
| @example | ||||
|   (sddm-service (sddm-configuration | ||||
|                  (auto-login-user "Alice") | ||||
|                  (auto-login-session "xfce.desktop"))) | ||||
| @end example | ||||
| @end deffn | ||||
| Here's an example use: | ||||
| 
 | ||||
| @lisp | ||||
| (service sddm-service-type | ||||
|          (sddm-configuration | ||||
|            (auto-login-user "alice") | ||||
|            (auto-login-session "xfce.desktop"))) | ||||
| @end lisp | ||||
| @end defvr | ||||
| 
 | ||||
| @deftp {Data Type} sddm-configuration | ||||
| This data type represents the configuration of the SDDM login manager. | ||||
| The available fields are: | ||||
| 
 | ||||
| @table @asis | ||||
| @item @code{sddm} (default: @code{sddm}) | ||||
| The SDDM package to use. | ||||
| 
 | ||||
| @item @code{display-server} (default: @code{"x11"}) | ||||
| This must be either @code{"x11"} or @code{"wayland"}. | ||||
| 
 | ||||
| @c FIXME: Add more fields. | ||||
| 
 | ||||
| @item @code{auto-login-user} (default: @code{""}) | ||||
| If non-empty, this is the user account under which to log in | ||||
| automatically. | ||||
| 
 | ||||
| @item @code{auto-login-session} (default: @code{""}) | ||||
| If non-empty, this is the @file{.desktop} file name to use as the | ||||
| auto-login session. | ||||
| @end table | ||||
| @end deftp | ||||
| 
 | ||||
| @cindex Xorg, configuration | ||||
| @deftp {Data Type} xorg-configuration | ||||
|  |  | |||
|  | @ -30,6 +30,7 @@ | |||
|   #:use-module (gnu system shadow) | ||||
|   #:use-module (guix gexp) | ||||
|   #:use-module (guix records) | ||||
|   #:use-module (guix deprecation) | ||||
|   #:export (sddm-configuration | ||||
|             sddm-configuration? | ||||
|             sddm-service-type | ||||
|  | @ -319,7 +320,8 @@ Relogin="              (if (sddm-configuration-relogin? config) | |||
|                                            sddm-profile-service))) | ||||
|                 (default-value (sddm-configuration)))) | ||||
| 
 | ||||
| (define* (sddm-service #:optional (config (sddm-configuration))) | ||||
| (define-deprecated (sddm-service #:optional (config (sddm-configuration))) | ||||
|   sddm-service-type | ||||
|   "Run the @uref{https://github.com/sddm/sddm,SSDM display manager} | ||||
| with the given @var{config}, a @code{<sddm-configuration>} object." | ||||
|   (service sddm-service-type config)) | ||||
|  |  | |||
		Reference in a new issue