Make filenames a bit more friendly for Windows users.

2025-03-09 10:39:02 -04:00 · 2024-06-17 17:09:54 +01:00 · 2024-06-17 17:09:54 +01:00 · 31541a8645
commit 31541a8645
parent 0e18b9daaf
23 changed files with 45 additions and 40 deletions
--- a/.github/workflows/ci-irctest.yml
+++ b/.github/workflows/ci-irctest.yml
@ -40,6 +40,11 @@ jobs:
          CXXFLAGS: -DINSPIRCD_UNLIMITED_MAINLOOP
        run: make install --jobs $(($(getconf _NPROCESSORS_ONLN) + 1))

+      - name: Work around an issue with irctest
+        env:
+          CXXFLAGS: -DINSPIRCD_UNLIMITED_MAINLOOP
+        run: cp ~/.local/conf/examples/help.example.conf ~/.local/conf/examples/help.conf.example
+
      - name: Make artifact tarball
        run: |-
          cd ~
--- a/docs/conf/codepages/ascii.example.conf
+++ b/docs/conf/codepages/ascii.example.conf
--- a/docs/conf/codepages/iso-8859-1.example.conf
+++ b/docs/conf/codepages/iso-8859-1.example.conf
@ -39,4 +39,4 @@
 <cpcase lower="222" upper="254"> # þ => Þ

 # Include the ASCII rules to avoid duplication.
-<include file="examples/codepages/ascii.conf.example">
+<include file="examples/codepages/ascii.example.conf">
--- a/docs/conf/codepages/iso-8859-2.example.conf
+++ b/docs/conf/codepages/iso-8859-2.example.conf
@ -57,4 +57,4 @@
 <cpcase lower="254" upper="222"> # ţ => Ţ

 # Include the ASCII rules to avoid duplication.
-<include file="examples/codepages/ascii.conf.example">
+<include file="examples/codepages/ascii.example.conf">
--- a/docs/conf/codepages/rfc1459.example.conf
+++ b/docs/conf/codepages/rfc1459.example.conf
--- a/docs/conf/codepages/strict-rfc1459.example.conf
+++ b/docs/conf/codepages/strict-rfc1459.example.conf
--- a/docs/conf/filter.example.conf
+++ b/docs/conf/filter.example.conf
--- a/docs/conf/help.example.conf
+++ b/docs/conf/help.example.conf
--- a/docs/conf/inspircd.example.conf
+++ b/docs/conf/inspircd.example.conf
@ -227,7 +227,7 @@
 # can be done by using <connect connected="no">                       #

 # To enable IRCCloud on your network uncomment this:
-#<include file="examples/providers/irccloud.conf.example">
+#<include file="examples/providers/irccloud.example.conf">

 # A connect class with <connect:deny> set denies connections from the specified host/IP range.
 <connect
@ -486,7 +486,7 @@

 # This file has all the information about oper classes, types and o:lines.
 # You *MUST* edit it.
-#<include file="examples/opers.conf.example">
+#<include file="examples/opers.example.conf">

 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 #                                                                     #
@ -495,7 +495,7 @@
 #
 #   motd - displayed on connect and when a user executes /MOTD
 # Modules can also define their own files
-<files motd="examples/motd.txt.example">
+<files motd="examples/motd.example.txt">

 # Example of an executable file include. Note this will be read on rehash,
 # not when the command is run.
@ -703,7 +703,7 @@
         #  - topiclock       Channel mode +t - limits changing the topic to (half)ops
         # You can also configure this on a per-channel basis with a channel mode and
         # even negate the configured exemptions below.
-         # See exemptchanops in modules.conf.example for more details.
+         # See exemptchanops in modules.example.conf for more details.
         exemptchanops="filter:o nickflood:o nonick:v regmoderated:o"

         # invitebypassmodes: This allows /INVITE to bypass other channel modes.
@ -1037,7 +1037,7 @@
 # provide almost all the features of InspIRCd. :)                     #
 #                                                                     #
 # The default does nothing -- we include it for simplicity for you.   #
-#<include file="examples/modules.conf.example">
+#<include file="examples/modules.example.conf">

 #-#-#-#-#-#-#-#-#-#-#-# SERVICES CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
@ -1046,13 +1046,13 @@
 # exemptions for services pseudoclients:                              #
 #
 # Anope users should uncomment this:
-#<include file="examples/services/anope.conf.example">
+#<include file="examples/services/anope.example.conf">
 #
 # Atheme users should uncomment this:
-#<include file="examples/services/atheme.conf.example">
+#<include file="examples/services/atheme.example.conf">
 #
 # Users of other services should uncomment this:
-#<include file="examples/services/generic.conf.example">
+#<include file="examples/services/generic.example.conf">

 #########################################################################
 #                                                                       #
--- a/docs/conf/links.example.conf
+++ b/docs/conf/links.example.conf
@ -2,7 +2,7 @@
 #                                                                     #
 #   Configure the port and address bindings for linking here.         #
 #                                                                     #
-#   Refer to the port configuration section in inspircd.conf.example  #
+#   Refer to the port configuration section in inspircd.example.conf  #
 #   for more information about the available options.                 #
 #                                                                     #

@ -142,4 +142,4 @@

 # Once you have edited this file you can remove this line. This is just to
 # ensure that you don't hastily include the file without reading it.
-<die reason="Using links.conf.example without editing it is a security risk">
+<die reason="Using links.example.conf without editing it is a security risk">
--- a/docs/conf/modules.example.conf
+++ b/docs/conf/modules.example.conf
@ -653,11 +653,11 @@
 #<module name="codepage">
 #
 # You should include one of the following files to set your codepage:
-#<include file="examples/codepages/ascii.conf.example">
-#<include file="examples/codepages/iso-8859-1.conf.example">
-#<include file="examples/codepages/iso-8859-2.conf.example">
-#<include file="examples/codepages/rfc1459.conf.example">
-#<include file="examples/codepages/strict-rfc1459.conf.example">
+#<include file="examples/codepages/ascii.example.conf">
+#<include file="examples/codepages/iso-8859-1.example.conf">
+#<include file="examples/codepages/iso-8859-2.example.conf">
+#<include file="examples/codepages/rfc1459.example.conf">
+#<include file="examples/codepages/strict-rfc1459.example.conf">
 #
 # You can also define a custom codepage. For details on how to do this
 # please refer to the docs site:
@ -939,13 +939,13 @@
 # more of the following example configs for popular DNSBLs:           #
 #                                                                     #
 # DroneBL (https://dronebl.org)                                       #
-#<include file="examples/providers/dronebl.conf.example">
+#<include file="examples/providers/dronebl.example.conf">
 #                                                                     #
 # EFnet RBL (https://rbl.efnetrbl.org)                                #
-#<include file="examples/providers/efnet-rbl.conf.example">
+#<include file="examples/providers/efnet-rbl.example.conf">
 #                                                                     #
 # dan.me.uk Tor exit node DNSBL (https://www.dan.me.uk/dnsbl)         #
-#<include file="examples/providers/torexit.conf.example">
+#<include file="examples/providers/torexit.example.conf">

 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Exempt channel operators module: Provides support for allowing      #
@ -954,7 +954,7 @@
 # anticaps, auditorium-see, auditorium-vis, blockcaps, blockcolor,    #
 # filter, flood, nickflood, noctcp, nonick, nonotice, regmoderated,   #
 # stripcolor, and topiclock.                                          #
-# See <options:exemptchanops> in inspircd.conf.example for a more     #
+# See <options:exemptchanops> in inspircd.example.conf for a more     #
 # detailed list of the restriction modes that can be exempted.        #
 # These are settable using: /MODE #chan +X <restriction>:<status>     #
 # Furthermore, the exemptions configured in <options:exemptchanops>   #
@ -991,7 +991,7 @@
 # Your choice of regex engine must match on all servers network-wide. #
 #                                                                     #
 # To learn more about the configuration of this module, read          #
-# examples/filter.conf.example, which covers the various types of     #
+# examples/filter.example.conf, which covers the various types of     #
 # filters and shows how to add exemptions.                            #
 #                                                                     #
 #-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
@ -1000,7 +1000,7 @@
 # specify below the path to the filter.conf file, or define some      #
 # <keyword> tags.                                                     #
 #                                                                     #
-#<include file="examples/filter.conf.example">
+#<include file="examples/filter.example.conf">

 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Gateway module: Enables forwarding the real IP address of a user from
@ -1138,7 +1138,7 @@
 # If you specify to use the help module, then specify below the path  #
 # to the help.conf file.                                              #
 #                                                                     #
-#<include file="examples/help.conf.example">
+#<include file="examples/help.example.conf">

 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Help mode module: Provides oper-only user mode `h` (helpop) which
@ -2431,7 +2431,7 @@
 #
 # This file has all the information about server links and services servers.
 # You *MUST* edit it if you intend to link servers.
-#<include file="examples/links.conf.example">
+#<include file="examples/links.example.conf">

 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # SQL authentication module: Allows IRCd connections to be tied into
@ -2518,7 +2518,7 @@
 # connections in order to oper up. It is highly recommended to load
 # this module if you use TLS on your network.
 # For how to use the oper features, please see the first
-# example <oper> tag in opers.conf.example.
+# example <oper> tag in opers.example.conf.
 #
 #<module name="sslinfo">
 #
--- a/docs/conf/motd.example.txt
+++ b/docs/conf/motd.example.txt
@ -21,7 +21,7 @@
        \__/  /(_/     \__/
          (__/

-      +---- To change this see \bmotd.txt.example\x ----+
+      +---- To change this see \bmotd.example.txt\x ----+
      |                                             |
      |   * \bWeb:\x https://www.inspircd.org           |
      |   * \bIRC:\x irc.inspircd.org #inspircd         |
--- a/docs/conf/opermotd.example.txt
+++ b/docs/conf/opermotd.example.txt
@ -21,7 +21,7 @@
        \__/  /(_/     \__/
          (__/

-      +-- To change this see \bopermotd.txt.example\x --+
+      +-- To change this see \bopermotd.example.txt\x --+
      |                                             |
      |   * \bWeb:\x https://www.inspircd.org           |
      |   * \bIRC:\x irc.inspircd.org #inspircd         |
--- a/docs/conf/opers.example.conf
+++ b/docs/conf/opers.example.conf
@ -92,7 +92,7 @@
    # operator type. This can be viewed with /OPERMOTD or automatically
    # on login if automotd (see below) is enabled.
    # Requires the opermotd module to be loaded.
-    motd="examples/opermotd.txt.example"
+    motd="examples/opermotd.example.txt"

    # automotd: Whether to send the server operator MOTD (see above)
    # to operators of this type when they log in.
@ -219,4 +219,4 @@

 # Once you have edited this file you can remove this line. This is just to
 # ensure that you don't hastily include the file without reading it.
-<die reason="Using opers.conf.example without editing it is a security risk">
+<die reason="Using opers.example.conf without editing it is a security risk">
--- a/docs/conf/providers/dronebl.example.conf
+++ b/docs/conf/providers/dronebl.example.conf
--- a/docs/conf/providers/efnet-rbl.example.conf
+++ b/docs/conf/providers/efnet-rbl.example.conf
--- a/docs/conf/providers/irccloud.example.conf
+++ b/docs/conf/providers/irccloud.example.conf
--- a/docs/conf/providers/torexit.example.conf
+++ b/docs/conf/providers/torexit.example.conf
--- a/docs/conf/quotes.example.txt
+++ b/docs/conf/quotes.example.txt
--- a/docs/conf/services/anope.example.conf
+++ b/docs/conf/services/anope.example.conf
@ -2,4 +2,4 @@
 # by Anope. See https://www.anope.org for more information on Anope.

 # This file inherits from the generic config to avoid repetition.
-<include file="examples/services/generic.conf.example">
+<include file="examples/services/generic.example.conf">
--- a/docs/conf/services/atheme.example.conf
+++ b/docs/conf/services/atheme.example.conf
@ -3,7 +3,7 @@
 # information on Atheme.

 # This file inherits from the generic config to avoid repetition.
-<include file="examples/services/generic.conf.example">
+<include file="examples/services/generic.example.conf">

 # Long hand aliases for services pseudoclients.
 <alias text="ALIS"      replace="SQUERY $requirement :$2-" requires="ALIS"      service="yes">
--- a/docs/conf/services/generic.example.conf
+++ b/docs/conf/services/generic.example.conf
--- a/make/template/main.mk
+++ b/make/template/main.mk
@ -279,10 +279,10 @@ endif
 	-$(INSTALL) $(INSTFLAGS) -m $(INSTMODE_TXT) @CONFIGURE_DIRECTORY@/inspircd.1 $(MANPATH) 2>/dev/null
 	-$(INSTALL) $(INSTFLAGS) -m $(INSTMODE_TXT) @CONFIGURE_DIRECTORY@/inspircd-testssl.1 $(MANPATH) 2>/dev/null
 	-$(INSTALL) $(INSTFLAGS) -m $(INSTMODE_BIN) tools/testssl $(BINPATH)/inspircd-testssl 2>/dev/null
-	-$(INSTALL) $(INSTFLAGS) -m $(INSTMODE_TXT) docs/conf/*.example $(EXAPATH)
-	-$(INSTALL) $(INSTFLAGS) -m $(INSTMODE_TXT) docs/conf/codepages/*.example $(EXAPATH)/codepages
-	-$(INSTALL) $(INSTFLAGS) -m $(INSTMODE_TXT) docs/conf/providers/*.example $(EXAPATH)/providers
-	-$(INSTALL) $(INSTFLAGS) -m $(INSTMODE_TXT) docs/conf/services/*.example $(EXAPATH)/services
+	-$(INSTALL) $(INSTFLAGS) -m $(INSTMODE_TXT) docs/conf/*.example.* $(EXAPATH)
+	-$(INSTALL) $(INSTFLAGS) -m $(INSTMODE_TXT) docs/conf/codepages/*.example.* $(EXAPATH)/codepages
+	-$(INSTALL) $(INSTFLAGS) -m $(INSTMODE_TXT) docs/conf/providers/*.example.* $(EXAPATH)/providers
+	-$(INSTALL) $(INSTFLAGS) -m $(INSTMODE_TXT) docs/conf/services/*.example.* $(EXAPATH)/services
 	-$(INSTALL) $(INSTFLAGS) -m $(INSTMODE_TXT) docs/sql/log_sql/*.sql $(EXAPATH)/sql/log_sql
 	-$(INSTALL) $(INSTFLAGS) -m $(INSTMODE_TXT) docs/sql/sqloper/*.sql $(EXAPATH)/sql/sqloper
 	-$(INSTALL) $(INSTFLAGS) -m $(INSTMODE_TXT) @CONFIGURE_DIRECTORY@/help.txt $(CONPATH)
@ -314,10 +314,10 @@ deinstall:
 	-rm -f $(BINPATH)/inspircd
 	-rm -f $(BINPATH)/inspircd-testssl
 	-rm -f $(CONPATH)/help.txt
-	-rm -f $(EXAPATH)/*.example
-	-rm -f $(EXAPATH)/codepages/*.example
-	-rm -f $(EXAPATH)/providers/*.example
-	-rm -f $(EXAPATH)/services/*.example
+	-rm -f $(EXAPATH)/*.example.*
+	-rm -f $(EXAPATH)/codepages/*.example.*
+	-rm -f $(EXAPATH)/providers/*.example.*
+	-rm -f $(EXAPATH)/services/*.example.*
 	-rm -f $(EXAPATH)/sql/*.sql
 	-rm -f $(MANPATH)/inspircd-testssl.1
 	-rm -f $(MANPATH)/inspircd.1