diff --git a/2024/README.md b/2024/README.md index 6a128c458..da448866c 100644 --- a/2024/README.md +++ b/2024/README.md @@ -77,7 +77,7 @@ become more skilled in the programming in the C language. We were pleased to observe that while the [IOCCC size limit](../faq.html#size_rule_history) increased by about 21%, we received many submissions that were well under the new -[Rule 2 Size](../next/rules.html#rule-2-size) including a fair number of quality +[Rule 2](rules.html#rule2) including a fair number of quality small and medium sized submissions. Half of the **IOCCC28 winners** were less than _2/3 of the size limit_, and 10 of the **IOCCC28 winners** were less than _1/2 of the size limit_! @@ -85,10 +85,10 @@ _1/2 of the size limit_! **IMPORTANT NOTE**: The [IOCCC size limit](../faq.html#size_rule_history) increase for **IOCCC28** was the first size increase in over 10 years. Given the quality of submissions we received that were well under the limit, we do **NOT** expect to change the -[Rule 2 Size](../next/rules.html#rule-2-size) for **at least another 10 years** (and likely longer). +[Rule 2](rules.html#rule2) for **at least another 10 years** (and likely longer). **IMPORTANT HINT**: Only 3 of the 23 **IOCCC28 winners** came close to the [Rule -2 Size](../next/rules.html#rule-2-size). Large code size isn't everything. :-) +2](rules.html#rule2). Large code size isn't everything. :-) Those submitting to future contents should **take a careful note** of that fact. diff --git a/2024/index.html b/2024/index.html index b41981ca2..131505802 100644 --- a/2024/index.html +++ b/2024/index.html @@ -513,16 +513,16 @@ become more skilled in the programming in the C language.

Code size and Rule 2

We were pleased to observe that while the IOCCC size limit increased by about 21%, we received many submissions that were well under the new -Rule 2 Size including a fair number of quality +Rule 2 including a fair number of quality small and medium sized submissions. Half of the IOCCC28 winners were less than 2/3 of the size limit, and 10 of the IOCCC28 winners were less than 1/2 of the size limit!

IMPORTANT NOTE: The IOCCC size limit increase for IOCCC28 was the first size increase in over 10 years. Given the quality of submissions we received that were well under the limit, we do NOT expect to change the -Rule 2 Size for at least another 10 years (and likely longer).

-

IMPORTANT HINT: Only 3 of the 23 IOCCC28 winners came close to the Rule -2 Size. Large code size isn’t everything. :-) +Rule 2 for at least another 10 years (and likely longer).

+

IMPORTANT HINT: Only 3 of the 23 IOCCC28 winners came close to the Rule +2. Large code size isn’t everything. :-) Those submitting to future contents should take a careful note of that fact.

Rules and Guidelines for this contest

Here are the final versions of the IOCCC rules and guidelines that were in diff --git a/faq.html b/faq.html index 44dff4a67..9342f0d78 100644 --- a/faq.html +++ b/faq.html @@ -453,7 +453,7 @@

IOCCC FAQ Table of Contents

-

This is FAQ version 29.01 2025-11-28.

+

This is FAQ version 29.02 2025-11-29.

0. Entering the IOCCC: the bare minimum you need to know

Jump to: top

@@ -982,11 +979,12 @@ for more details.

See the FAQ on “Rule 17” and -Rule 17 - Packaging +Rule 17 - Use mkiocccentry itself.

Do remember that if your submission requires different filenames, then you MUST make a COPY of them in your Makefile. See also -Rule 5 - Integrity.

+Rule 5 - Do NOT modify submitted files or filenames or parent +directories.

Jump to: top

@@ -1130,12 +1128,12 @@ level directory.

itself is an extra file, meaning it counts AS an extra file. This file does NOT need to pass the txzchk(1) tests; only your submission tarball needs to pass these tests. However see below if you do do this.

-

Please pay careful attention to Rule 17 - Packaging and in +

Please pay careful attention to Rule 17 - Use mkiocccentry and in particular the part about the maximum number of files per submission, which not only discusses the maximum number of files but also specific rules you must follow if you do include a tarball. Not following these points puts you at great risk -of violating Rule 17 - Packaging!

+of violating Rule 17 - Use mkiocccentry!

Also, remember what the guidelines say:

IMPORTANT REMINDER: make SURE your tarball does NOT reveal who you are! @@ -1159,7 +1157,7 @@ ultimate author of the code you submit.

you used as well as how you used them to help write your submission.

Jump to: top

-

Q 1.7: What are details behind Rule 17 - Packaging?

+

Q 1.7: What are details behind Rule 17 - Use mkiocccentry?

TL;DR Rule 17 - Use mkiocccentry(1)

This is a COMPLEX rule. Violating this rule WILL CAUSE YOUR SUBMISSION TO @@ -1178,7 +1176,7 @@ contains IMPORTANT tools and libraries such as:

  • chksubmit(1) (which uses jparse(3) and is a wrapper to chkentry(1))

    • The above mentioned tools will help you verify that your submission -conforms to Rule 17 - Packaging. Each of these tool has a -h +conforms to Rule 17 - Use mkiocccentry. Each of these tool has a -h option that provides command line help. For additional details of each tool, see its man page, and in some cases, the IOCCC guidelines.

    The maximum number of extra files is 31. See the @@ -1228,7 +1226,7 @@ for help.

    The remarks.md MUST be a non-empty file in markdown format (mkiocccentry(1) only checks the file size but if you do not have any text in it you still risk violating this rule). See also -Rule 17 - Packaging +Rule 17 - Use mkiocccentry and our FAQ on “remarks.md”, our @@ -1322,16 +1320,17 @@ permissions and mkiocccentry(1) does this for you. In particular: d -r-xr-xr-x (i.e. 0555); and all other files MUST be -r--r--r-- (i.e. 0444). If any file or directory does not have the correct permissions, your submission WILL be rejected for violating -Rule 17 - Packaging!

    +Rule 17 - Use mkiocccentry!

    After mkiocccentry(1) creates the directories and copies the files with these modes, it also verifies them after the fact and if they are not correct it is an error.

    If you do need different permissions, then see the FAQ on “file permissions”. Also keep in mind -Rule 4 - Files, -Rule 5 - Integrity, +Rule 4 - Required files, +Rule 5 - Do NOT modify submitted files or filenames or parent +directories, and -Rule 16 - Anonymous.

    +Rule 16 - Anonymous judging.

    The txzchk(1) tool will also verify file/directory permissions (and many other things) for you, and so will chksubmit(1) (along with other checks on files and directories in your submission directory, including the two required JSON files, @@ -1344,18 +1343,18 @@ page.

    will run fnamchk(1) as part of its algorithm. If you use mkiocccentry(1) there should be no problem but if you were to package things manually it is possible there could be a problem and this poses a big risk of violating -Rule 4 - Files +Rule 4 - Required files or -Rule 17 - Packaging.

    +Rule 17 - Use mkiocccentry.

    The fnamchk(1), which txzchk(1) executes, will verify that the filename is correct. But if you do package your tarball manually, and you have a mismatch in what is in the tarball and the name, txzchk(1) will flag the discrepancy as an error and exit with non-zero.

    These checks MUST PASS. If they do not you stand a significant chance of having your submission rejected for violating -Rule 4 - Files +Rule 4 - Required files or -Rule 17 - Packaging.

    +Rule 17 - Use mkiocccentry.

    Maximum number of files per submission

    @@ -1385,9 +1384,9 @@ The mkiocccentry(1) tool uses the v7 format. For instance you might 
        tar --format=v7 -cJf foo.txz directory

    IMPORTANT: where -Rule 4 - Files, +Rule 4 - Required files, and -Rule 17 - Packaging. +Rule 17 - Use mkiocccentry and the tools from the latest release of the mkiocccentry repo conflict, the IOCCC judges will use their best judgment which @@ -1422,9 +1421,9 @@ page, for help here and also read our FAQ on “mkiocccentry repo bugs”.

    At the risk of stating the obvious: submissions that violate -Rule 4 - Files, +Rule 4 - Required files, or -Rule 17 - Packaging +Rule 17 - Use mkiocccentry WILL BE REJECTED, so BE SURE to use the latest release of the mkiocccentry repo, to form and test your submission’s xz compressed tarball. Do NOT assume you have the most @@ -1669,7 +1668,7 @@ somehow, txzchk(1) will flag it as an error. When the judges run WILL BE REJECTED for violating -Rule 17 - Packaging!

    +Rule 17 - Use mkiocccentry!

    You may use whatever tools you need to develop your submission, including the use of git(1) or gh(1), just be sure that your submission code and your submission Makefile don’t depend on such tools.

    @@ -1903,7 +1902,7 @@ of the same theme.

    Jump to: top

    -

    Q 2.4: How did an entry win the IOCCC that breaks Rule 2 - Size?

    +

    Q 2.4: How did an entry win the IOCCC that breaks Rule 2 - Size restrictions?

    As entries have been fixed it is entirely possible that some of the entries no @@ -2120,9 +2119,9 @@ two JSON files, .auth.json and .info.json as well as t .info.json manifest. (Okay there is an option to skip files but this is for the judges ONLY; use of this option to validate your submission puts you at a great risk of violating -Rule 4 - Files, +Rule 4 - Required files, or -Rule 17 - Packaging!).

    +Rule 17 - Use mkiocccentry!).

    As an example, if your submission directory is 00000000-0000-4000-0000-000000000000-3/ then you should run the following command:

    @@ -2142,9 +2141,9 @@ FAQ on “.auth.json” and the FAQ on “.info.json” as well as -Rule 4 - Files, +Rule 4 - Required files, and -Rule 17 - Packaging +Rule 17 - Use mkiocccentry for more information.

    NOTE: the chksubmit(1) tool invokes chkentry(1) but as a contestant you do not need to worry about those details. One should use chksubmit(1) instead @@ -2235,12 +2234,12 @@ to be valid. If this is not the case your submission WILL BE re

  • The IOCCC contestant ID used as a username in the form of in the form of a UUID and submission number; see the Rules for more details on this, and in particular -Rule 17 - Packaging.
    • +Rule 17 - Use mkiocccentry.

    NOTE: if the contest ID is NOT in this format then fnamchk will report it as an error and your submission WILL BE rejected for violating -Rule 17 - Packaging.

    +Rule 17 - Use mkiocccentry.

  • tarball (double quoted string)

    • The xz compressed tarball filename.
      • @@ -2248,10 +2247,10 @@ violating

      IMPORTANT: this MUST match the actual tarball’s filename in order for this to be valid. If there is a mismatch you stand a great risk of having your submission rejected for violating -Rule 17 - Packaging! +Rule 17 - Use mkiocccentry! Moreover, it is possible that txzchk will report a problem through fnamchk(1) which also puts you at great risk of violating -Rule 17 - Packaging. The +Rule 17 - Use mkiocccentry. The txzchk(1) tool will use the output of fnamchk to obtain the correct directory name in the tarball; if fnamchk fails to validate your filename, or if you have the wrong directory name in the @@ -2266,7 +2265,7 @@ tarball, this will be flaggd.

      in the mkiocccentry repo). If this is not the case you stand a great risk of having your submission rejected for violating -Rule 17 - Packaging.

      +Rule 17 - Use mkiocccentry.

    • author_count (number)

      • How many authors this submission has.
        • @@ -2339,7 +2338,7 @@ the range of 1 THROUGH MAX_AFFILIATION_LEN (see in the mkiocccentry repo). If this is not the case you stand a great risk of having your submission rejected for violating -Rule 17 - Packaging.

        +Rule 17 - Use mkiocccentry.

        NOTE: an affiliation does NOT have any affect on whether you will win or not.

      • past_winning_author (boolean)

          @@ -2424,9 +2423,9 @@ will use it on the submission directory as part of the judging process.

          is reported invalid by chksubmit(1), or if your submission directory is reported invalid by chksubmit(1), your submission will almost certainly be rejected for violating the Rules and in particular -Rule 4 - Files, +Rule 4 - Required files, and -Rule 17 - Packaging.

          +Rule 17 - Use mkiocccentry.

          An obvious example where chksubmit(1) would fail to validate .auth.json is if there is a mismatch of type in the JSON file with what is expected, for instance, if in .auth.json the no_comment that we chose to not comment on is @@ -2435,9 +2434,9 @@ out of range (see above for list). Two more examples would be if a field is missing or if an unknown filed is in the file. In these cases (and any others that must be established as valid by chksubmit(1)) your submission would be rejected for violating -Rule 4 - Files, +Rule 4 - Required files, and -Rule 17 - Packaging +Rule 17 - Use mkiocccentry and in particular because chksubmit(1) would not validate the .auth.json file (and maybe other things too).

          @@ -2557,7 +2556,7 @@ this is not the case your submission WILL BE rejected!

        • The IOCCC contestant ID used as a username in the form of in the form of a UUID and submission number; see the rules for more details on this, and in particular -Rule 17 - Packaging.
          • +Rule 17 - Use mkiocccentry.

      • submit_slot (number)

          @@ -2569,7 +2568,7 @@ on this, and in particular in the mkiocccentry repo). If this is not the case you stand a great risk of having your submission rejected for violating -Rule 17 - Packaging.

          +Rule 17 - Use mkiocccentry.

        • title (double quoted string)

          • A short name (length >= 1 THROUGH MAX_TITLE_LEN, defined in @@ -2579,7 +2578,7 @@ matches the regexp [a-z0-9][a-z0-9_+-]*.

          IMPORTANT: if this is NOT the case you stand a great risk of having your submission rejected for violating -Rule 17 - Packaging!

          • +Rule 17 - Use mkiocccentry!

        • abstract (double quoted string)

          • A one line summary of your submission, with a length of 1 THROUGH @@ -2590,7 +2589,7 @@ in the mkiocccentry repoThe abstract may not contain a ; (semicolon), nor & (ampersand), nor , (comma).

            IMPORTANT: if your abstract is 0 in length or > the maximum abstract length you stand a great risk of having your submission rejected for violating -Rule 17 - Packaging!

            • +Rule 17 - Use mkiocccentry!

          • tarball (double quoted string)

            • The xz compressed tarball filename.
              • @@ -2598,27 +2597,27 @@ stand a great risk of having your submission rejected for violating

              IMPORTANT: this MUST match the actual tarball’s filename in order for this to be valid. If there is a mismatch you stand a great risk of having your submission rejected for violating -Rule 17 - Packaging! +Rule 17 - Use mkiocccentry! Moreover, it is possible that txzchk will report a problem through fnamchk(1) which also puts you at great risk of violating -Rule 17 - Packaging. +Rule 17 - Use mkiocccentry. The txzchk(1) tool will use the output of fnamchk to obtain the correct directory name in the tarball; if fnamchk fails to validate your filename, or if you have the wrong directory name in the tarball, this will be flaggd.

            • rule_2a_size (number)

              IMPORTANT: if this violates Rule 2a you stand a great chance of having your submission rejected for violating the Rules!

            • rule_2b_size (number)

              IMPORTANT: if this violates -Rule 2b Next Size +Rule 2b Net Size you stand a great chance of having your submission rejected for violating the Rules!

              • @@ -2629,55 +2628,39 @@ chance of having your submission rejected for violating the

            • rule_2a_override (boolean)

              IMPORTANT: if the -Rule 2a Gross Size +Rule 2a - Gross Size calculated size is NOT violated but this is true then you stand a good chance of having your submission rejected for violating -Rule 17 - Packaging.

              • +Rule 17 - Use mkiocccentry.

            • rule_2a_mismatch (boolean)

            • rule_2b_override (boolean)

              IMPORTANT: if the -Rule 2b Next Size +Rule 2b - Net Size calculated size is NOT violated but this is true then you stand a good chance of having your submission rejected for violating -Rule 17 - Packaging.

              • -

            • highbit_warning (boolean)

              -
                -
              • true if iocccsize detects a high bit (unescaped octets with the high -bit set - octet value >= 128); see -Rule 12 - UTF-8, -else false.
                • -
              • -

            • nul_warning (boolean)

              -
                -
              • true if iocccsize detects a NUL character in the prog.c, else -false.
                • -
              • +Rule 17 - Use mkiocccentry.

            • trigraph_warning (boolean)

              • true if iocccsize detects an unknown or invalid trigraph in prog.c, else false.
              • -

            • wordbuf_warning (boolean)

              -
                -
              • This is ignored and will be removed for IOCCC29 and beyond.
                • -

            • ungetc_warning (boolean)

              • true if prog.c triggered an ungetc(3) error, else false.
                • @@ -2689,7 +2672,7 @@ else false.

              IMPORTANT: if the Makefile file has no problems and this is true then you stand a good chance of having your submission rejected for violating -Rule 17 - Packaging!

              +Rule 17 - Use mkiocccentry!

              See the FAQ on “Makefile” for more information.

              • @@ -2699,7 +2682,7 @@ for more information.

            IMPORTANT:: if the Makefile file does NOT have an all rule then you stand a good chance of having your submission rejected for violating -Rule 17 - Packaging!

            +Rule 17 - Use mkiocccentry!

            See the FAQ on “Makefile” for more information.

            • @@ -2710,7 +2693,7 @@ for more information.

            IMPORTANT: if the Makefile file does NOT have an all rule and this boolean is true then you stand a good chance of having your submission rejected for violating -Rule 17 - Packaging!

            +Rule 17 - Use mkiocccentry!

            See the FAQ on “Makefile” for more information.

            @@ -2721,7 +2704,7 @@ for more information.

            IMPORTANT: if the Makefile file does NOT have a clean rule and this boolean is true then you stand a good chance of having your submission rejected for violating -Rule 17 - Packaging!

            +Rule 17 - Use mkiocccentry!

            See the FAQ on “Makefile” for more information.

            @@ -2732,7 +2715,7 @@ for more information.

            IMPORTANT: if the Makefile file does NOT have an clobber rule and this boolean is true then you stand a good chance of having your submission rejected for violating -Rule 17 - Packaging!

            +Rule 17 - Use mkiocccentry!

            See the FAQ on “Makefile” for more information.

            @@ -2743,7 +2726,7 @@ for more information.

            IMPORTANT: if the Makefile file does NOT have a try rule and this boolean is true then you stand a good chance of having your submission rejected for violating -Rule 17 - Packaging!

            +Rule 17 - Use mkiocccentry!

            See the FAQ on “Makefile” for more information.

            @@ -2769,7 +2752,7 @@ for more information.

          IMPORTANT: if this is NOT the case you stand a great chance of having your submission rejected for violating -Rule 17 - Packaging!

          • +Rule 17 - Use mkiocccentry!

        • auth_JSON (double quoted string)

          • This MUST be ".auth.json", defined as AUTH_JSON_FILENAME in @@ -2782,7 +2765,7 @@ for more information.

          IMPORTANT: if this is NOT the case you stand a great chance of having your submission rejected for violating -Rule 17 - Packaging!

          • +Rule 17 - Use mkiocccentry!

        • c_src (double quoted string)

          • This MUST be "prog.c", defined as PROG_C_FILENAME in @@ -2792,7 +2775,7 @@ is your submission source code.

          IMPORTANT: if this is NOT the case you stand a great chance of having your submission rejected for violating -Rule 17 - Packaging!

          • +Rule 17 - Use mkiocccentry!

        • Makefile (double quoted string)

          • This MUST be "Makefile", defined as MAKEFILE_FILENAME in @@ -2805,7 +2788,7 @@ for more information.

          IMPORTANT: if this is NOT the case you stand a great chance of having your submission rejected for violating -Rule 17 - Packaging!

          • +Rule 17 - Use mkiocccentry!

        • remarks (double quoted string)

          • This MUST be "remarks.md", defined as REMARKS_FILENAME in @@ -2818,7 +2801,7 @@ for more information.

          IMPORTANT: if this is NOT the case you stand a great chance of having your submission rejected for violating -Rule 17 - Packaging!

          • +Rule 17 - Use mkiocccentry!

        The manifest array also OPTIONALLY has one or more of the field:

          @@ -2831,7 +2814,7 @@ and chksubmit will verify this for you; it is ALSO filenames are not unique, not POSIX plus + safe chars only, if they are the wrong permission and various other things. In these cases you stand a great risk of having your submission rejected for violating -Rule 17 - Packaging! +Rule 17 - Use mkiocccentry! On the other hand, ONLY mkiocccentry will verify that the files exist and can be read; txzchk(1) will NOT do this for you as it only LISTS the tarball: it does NOT extract it. @@ -2894,7 +2877,7 @@ out of range (see above for list). Two more examples would be if a field is missing or if an unknown filed is in the file. In these cases (and any others that must be established as valid by chksubmit) your submission would be rejected for violating -Rule 17 - Packaging, +Rule 17 - Use mkiocccentry, and in particular because chksubmit would not validate the .info.json file.

          If you wish to verify that your .info.json file is valid JSON then see the @@ -5858,22 +5841,6 @@ follow posts something so you will have to check the IOCCC feed manually.

          mastodon feed page and/or mastodon app from time to time to view IOCCC mastodon updates.

          Jump to: top

          -
          -

          Q 10.6.1: How can I get push notifications when the judges post something on mastodon?

          -
          -

          To do this you need to go to the IOCCC mastodon -account with a computer (it is unclear how to do -this with a mobile device, if it is even possible) and then you should see a -bell icon. Make sure it’s activated. If you mouse over it when it’s not enabled -it should look something like this, assuming of course we follow you! :-) (if -not the message about following each other won’t show up):

          -

          screenshot of Mastodon push notifications

          -

          It is not yet clear if this only works on desktop/computers or mobile devices -too as it was only just discovered (31 July 2025) but whatever the case we -suggest you do it.

          -

          Jump to: top

          Q 10.7: How do I set certain tabstops for viewing source code in vi(m)?

          diff --git a/faq.md b/faq.md index e1f435682..15caa1940 100644 --- a/faq.md +++ b/faq.md @@ -1,6 +1,6 @@ # IOCCC FAQ Table of Contents -This is FAQ version **29.01 2025-11-28**. +This is FAQ version **29.02 2025-11-29**. ## 0. [Entering the IOCCC: the bare minimum you need to know](#enter_questions) @@ -26,7 +26,7 @@ This is FAQ version **29.01 2025-11-28**. - **Q 1.4**: How can I check if my submission passes tests without having to answer questions? - **Q 1.5**: What are extra files and how may I include additional files beyond the max allowed? - **Q 1.6**: May I use AI, LLM, Virtual coding assistants, or similar tools to write my submission? -- **Q 1.7**: What are the details behind Rule 17 - Packaging? +- **Q 1.7**: What are the details behind Rule 17 - use mkiocccentry? - **Q 1.8**: How can I avoid re-entering my UUID to mkiocccentry? - **Q 1.9**: How can I avoid having to move or delete my submission directory for the same workdir? - **Q 1.10**: Can I download my submission tarball from the submit server? @@ -39,7 +39,7 @@ This is FAQ version **29.01 2025-11-28**. - **Q 2.1**: How can I comment or make a suggestion on IOCCC rules, guidelines and tools? - **Q 2.2**: Are there any compiler warnings that I should not worry about in my submissions? - **Q 2.3**: What types of entries have been frequently submitted to the IOCCC? -- **Q 2.4**: How did an entry win the IOCCC that breaks Rule 2 - Size? +- **Q 2.4**: How did an entry win the IOCCC that breaks Rule 2 - Size Limit? - **Q 2.5**: How many submissions do the judges receive for a given IOCCC? - **Q 2.6**: How much time does it take to judge the contest? - **Q 2.7**: How many judging rounds do you have? @@ -133,7 +133,6 @@ This is FAQ version **29.01 2025-11-28**. - **Q 10.4**: What is the current meaning of the IOCCC terms Author, Entry, and Submission? - **Q 10.5**: Am I allowed to use IOCCC content? - **Q 10.6**: What is Mastodon and why does the IOCCC use it? - - **Q 10.6.1**: How can I get push notifications when the judges post something on mastodon? - **Q 10.7**: How do I set certain tabstops for viewing source code in vi(m)? - **Q 10.8**: How do the menus on the website work and what can I do if they don't work? - **Q 10.9**: How do I find more information about a winning author of an entry? @@ -216,7 +215,7 @@ This toolkit is from the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry) and it is **required** that you use it to package your submission. Not doing so puts you at a great risk of violating the [Rules](next/rules.html) and in particular -[Rule 17 - Packaging](next/rules.html#rule-17---packaging). +[Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry). Jump to: [top](#) @@ -387,7 +386,7 @@ directory** will be created, with the name based on your IOCCC registration username, which is **in the form of a UUID**, and submission number along with the timestamp; see the [rules](next/rules.html) for more details on this, and in particular -[Rule 17 - Packaging](next/rules.html#rule-17---packaging). +[Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry). **IMPORTANT NOTE**: the tools that require other tools, `mkiocccentry(1)` and `txzchk(1)`, will, as of version `2.0.2 2025-03-11`, search under `$PATH`. If @@ -582,7 +581,7 @@ rounds; we look at the author name only if an entry wins. See the - leaving the remark section empty (which would also indicate that you did not use `mkiocccentry(1)`, as it requires it to not be of size 0, though if you only include whitespace you would still be violating -[Rule 17 - Packaging](next/rules.html#rule-17---packaging)). +[Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)). Jump to: [top](#) @@ -641,12 +640,13 @@ for more details. See the FAQ on "[Rule 17](#rule17)" and -[Rule 17 - Packaging](next/rules.html#rule-17---packaging) +[Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry) itself. Do remember that if your submission requires different filenames, then you **MUST** make a **COPY** of them in your `Makefile`. See also -[Rule 5 - Integrity](next/rules.html#rule-5---integrity). +[Rule 5 - Do NOT modify submitted files or filenames or parent +directories](next/rules.html#rule5-modifying-files). Jump to: [top](#) @@ -858,12 +858,12 @@ itself is an extra file, meaning it counts **AS** an extra file. This file does **NOT** need to pass the `txzchk(1)` tests; only your submission tarball needs to pass these tests. However see below if you do do this. -Please pay careful attention to [Rule 17 - Packaging](next/rules.html#rule-17---packaging) and in +Please pay careful attention to [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry) and in particular the part about the maximum number of files per submission, which not only discusses the maximum number of files but also specific rules you must follow if you do include a tarball. Not following these points puts you at great risk -of violating [Rule 17 - Packaging](next/rules.html#rule-17---packaging)! +of violating [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)! Also, remember what the [guidelines](next/guidelines.html) say: @@ -902,7 +902,7 @@ Jump to: [top](#)
          -### Q 1.7: What are details behind Rule 17 - Packaging? +### Q 1.7: What are details behind Rule 17 - Use mkiocccentry?
          @@ -925,7 +925,7 @@ contains **IMPORTANT** tools and libraries such as: - `chksubmit(1)` (which uses `jparse(3)` and is a wrapper to `chkentry(1)`) The above mentioned tools will help you verify that your submission -conforms to [Rule 17 - Packaging](next/rules.html#rule-17---packaging). Each of these tool has a `-h` +conforms to [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry). Each of these tool has a `-h` option that provides command line help. For additional details of each tool, see its man page, and in some cases, the [IOCCC guidelines](next/guidelines.html). @@ -988,7 +988,7 @@ for help. The `remarks.md` **MUST** be a **non**-empty file in markdown format (`mkiocccentry(1)` only checks the file size but if you do not have any text in it you still risk violating this rule). See also -[Rule 17 - Packaging](next/rules.html#rule-17---packaging) +[Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry) and our FAQ on "[remarks.md](#remarks_md)", our @@ -1096,7 +1096,7 @@ permissions and `mkiocccentry(1)` does this for you. In particular: directories `-r-xr-xr-x` (i.e. `0555`); and all other files **MUST** be `-r--r--r--` (i.e. `0444`). If any file or directory does not have the correct permissions, your submission **WILL** be rejected for violating -[Rule 17 - Packaging](next/rules.html#rule17)! +[Rule 17 - Use mkiocccentry](next/rules.html#rule17)! After `mkiocccentry(1)` creates the directories and copies the files with these modes, it also verifies them after the fact and if they are not correct it is an @@ -1104,10 +1104,11 @@ modes, it also verifies them after the fact and if they are not correct it is an If you do need different permissions, then see the FAQ on "[file permissions](#file_perms)". Also keep in mind -[Rule 4 - Files](next/rules.html#rule-4---files), -[Rule 5 - Integrity](next/rules.html#rule-5---integrity), +[Rule 4 - Required files](next/rules.html#rule4-required-files), +[Rule 5 - Do NOT modify submitted files or filenames or parent +directories](next/rules.html#rule5-modifying-files), and -[Rule 16 - Anonymous](next/rules.html#rule-16---anonymous). +[Rule 16 - Anonymous judging](next/rules.html#rule16-anonymous-judging). The `txzchk(1)` tool will also verify file/directory permissions (and many other things) for you, and so will `chksubmit(1)` (along with other checks on files and @@ -1122,9 +1123,9 @@ The tarball filename **MUST** pass `fnamchk(1)`; the tool `txzchk(1)` will run `fnamchk(1)` as part of its algorithm. If you use `mkiocccentry(1)` there should be no problem but if you were to package things manually it is possible there could be a problem and this poses a big risk of violating -[Rule 4 - Files](next/rules.html#rule-4---files) +[Rule 4 - Required files](next/rules.html#rule4-required-files) or -[Rule 17 - Packaging](next/rules.html#rule17). +[Rule 17 - Use mkiocccentry](next/rules.html#rule17). The `fnamchk(1)`, which `txzchk(1)` executes, will verify that the @@ -1134,9 +1135,9 @@ discrepancy as an error and exit with non-zero. These checks **MUST PASS**. If they do not you stand a significant chance of having your submission rejected for violating -[Rule 4 - Files](next/rules.html#rule-4---files) +[Rule 4 - Required files](next/rules.html#rule4-required-files) or -[Rule 17 - Packaging](next/rules.html#rule17). +[Rule 17 - Use mkiocccentry](next/rules.html#rule17).
          #### Maximum number of files per submission @@ -1177,9 +1178,9 @@ The `mkiocccentry(1)` tool uses the v7 format. For instance you might try:
          **IMPORTANT**: where -[Rule 4 - Files](next/rules.html#rule-4---files), +[Rule 4 - Required files](next/rules.html#rule4-required-files), and -[Rule 17 - Packaging](next/rules.html#rule-17---packaging). +[Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry) and the tools from the latest release of the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry) conflict, the [IOCCC judges](judges.html) will use their best judgment which @@ -1220,9 +1221,9 @@ for help here and also read our FAQ on "[mkiocccentry repo bugs](#mkiocccentry_bugs)". At the risk of stating the obvious: submissions that violate -[Rule 4 - Files](next/rules.html#rule-4---files), +[Rule 4 - Required files](next/rules.html#rule4-required-files), or -[Rule 17 - Packaging](next/rules.html#rule-17---packaging) +[Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry) **WILL BE REJECTED**, so **BE SURE** to use the latest release of the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry), to form and test your submission's xz compressed tarball. Do **NOT** assume you have the most @@ -1594,7 +1595,7 @@ somehow, `txzchk(1)` will flag it as an error. When the judges run `txzchk(1)` on the uploaded submission compressed tarball, if anything is wrong, for instance if you "sneak in" any dot files or dot directories, the submission **WILL BE REJECTED** for violating -[Rule 17 - Packaging](next/rules.html#rule-17---packaging)! +[Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)! You may use whatever tools you need to develop your submission, including the use of `git(1)` or `gh(1)`, just be sure that your submission code and your @@ -1911,7 +1912,7 @@ Jump to: [top](#)
          -### Q 2.4: How did an entry win the IOCCC that breaks Rule 2 - Size? +### Q 2.4: How did an entry win the IOCCC that breaks Rule 2 - Size restrictions?
          @@ -2210,9 +2211,9 @@ two JSON files, `.auth.json` and `.info.json` as well as the `prog.c`, `.info.json` manifest. (Okay there is an option to skip files but this is for the judges **ONLY**; use of this option to validate your submission puts you at a great risk of violating -[Rule 4 - Files](next/rules.html#rule-4---files), +[Rule 4 - Required files](next/rules.html#rule4-required-files), or -[Rule 17 - Packaging](next/rules.html#rule-17---packaging)!). +[Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)!). As an example, if your submission directory is `00000000-0000-4000-0000-000000000000-3/` then you should run the following @@ -2239,9 +2240,9 @@ FAQ on "[.auth.json](#auth_json)" and the FAQ on "[.info.json](#info_json)" as well as -[Rule 4 - Files](next/rules.html#rule-4---files), +[Rule 4 - Required files](next/rules.html#rule4-required-files), and -[Rule 17 - Packaging](next/rules.html#rule-17---packaging) +[Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry) for more information. **NOTE**: the `chksubmit(1)` tool invokes `chkentry(1)` but as a contestant you @@ -2336,12 +2337,12 @@ In order of the file's contents we describe each required field, below: * The IOCCC contestant ID used as a username in the form of **in the form of a UUID** and submission number; see the [Rules](next/rules.html) for more details on this, and in particular - [Rule 17 - Packaging](next/rules.html#rule-17---packaging). + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry). **NOTE:** if the contest ID is **NOT** in this format then `fnamchk` will report it as an **error** and your submission **WILL BE** rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging). + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry). - `tarball` (double quoted string) * The xz compressed tarball filename. @@ -2349,10 +2350,10 @@ In order of the file's contents we describe each required field, below: **IMPORTANT:** this **MUST** match the actual tarball's **filename** in order for this to be valid. If there is a mismatch you stand a great risk of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging)! + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)! Moreover, it is possible that `txzchk` will report a problem through `fnamchk(1)` which also puts you at great risk of violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging). The + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry). The `txzchk(1)` tool will use the output of `fnamchk` to obtain the correct directory _name_ in the tarball; if `fnamchk` fails to validate your filename, or if you have the wrong directory name in the @@ -2367,7 +2368,7 @@ In order of the file's contents we describe each required field, below: in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/)). If this is not the case you stand a great risk of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging). + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry). - `author_count` (number) * How many authors this submission has. @@ -2432,7 +2433,7 @@ author(s) of the submission: in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/)). If this is not the case you stand a great risk of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging). + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry). **NOTE:** an **affiliation** does **NOT** have any affect on whether you will win or not. @@ -2517,9 +2518,9 @@ At the risk of stating the obvious, if your `.auth.json` file is invalid JSON or is reported invalid by `chksubmit(1)`, or if your submission directory is reported invalid by `chksubmit(1)`, your submission will almost certainly be rejected for violating the [Rules](next/rules.html) and in particular -[Rule 4 - Files](next/rules.html#rule-4---files), +[Rule 4 - Required files](next/rules.html#rule4-required-files), and -[Rule 17 - Packaging](next/rules.html#rule-17---packaging). +[Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry). An obvious example where `chksubmit(1)` would fail to validate `.auth.json` is if there is a mismatch of type in the JSON file with what is expected, for @@ -2529,9 +2530,9 @@ out of range (see above for list). Two more examples would be if a field is missing or if an unknown filed is in the file. In these cases (and any others that must be established as valid by `chksubmit(1)`) your submission would be rejected for violating -[Rule 4 - Files](next/rules.html#rule-4---files), +[Rule 4 - Required files](next/rules.html#rule4-required-files), and -[Rule 17 - Packaging](next/rules.html#rule-17---packaging) +[Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry) and in particular because `chksubmit(1)` would not validate the `.auth.json` file (and maybe other things too). @@ -2655,7 +2656,7 @@ In order of the file's contents we describe each required field, below: * The IOCCC contestant ID used as a username in the form of **in the form of a UUID** and submission number; see the [rules](next/rules.html) for more details on this, and in particular - [Rule 17 - Packaging](next/rules.html#rule-17---packaging). + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry). - `submit_slot` (number) * The submission number. @@ -2666,7 +2667,7 @@ In order of the file's contents we describe each required field, below: in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/)). If this is not the case you stand a great risk of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging). + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry). - `title` (double quoted string) * A short name (length >= 1 **THROUGH** `MAX_TITLE_LEN`, defined in @@ -2676,7 +2677,7 @@ In order of the file's contents we describe each required field, below: **IMPORTANT:** if this is **NOT** the case you stand a great risk of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging)! + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)! - `abstract` (double quoted string) * A one line summary of your submission, with a length of 1 **THROUGH** @@ -2688,7 +2689,7 @@ In order of the file's contents we describe each required field, below: **IMPORTANT:** if your abstract is 0 in length or > the maximum abstract length you stand a great risk of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging)! + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)! - `tarball` (double quoted string) * The xz compressed tarball filename. @@ -2696,27 +2697,27 @@ In order of the file's contents we describe each required field, below: **IMPORTANT:** this **MUST** match the actual tarball's **filename** in order for this to be valid. If there is a mismatch you stand a great risk of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging)! + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)! Moreover, it is possible that `txzchk` will report a problem through `fnamchk(1)` which also puts you at great risk of violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging). + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry). The `txzchk(1)` tool will use the output of `fnamchk` to obtain the correct directory _name_ in the tarball; if `fnamchk` fails to validate your filename, or if you have the wrong directory name in the tarball, this will be flaggd. - `rule_2a_size` (number) - * The size calculated of [Rule 2a Gross Size](next/rules.html#rule-2a-gross-size). + * The size calculated of [Rule 2a - Gross Size](next/rules.html#rule2a-gross-size). **IMPORTANT:** if this violates [Rule 2a](next/rules.html#rule2a) you stand a great chance of having your submission rejected for violating the [Rules](next/rules.html)! - `rule_2b_size` (number) - * The size calculated of [Rule 2b Next Size](next/rules.html#rule-2b-net-size). + * The size calculated of [Rule 2b - Net Size](next/rules.html#rule2b-net-size). **IMPORTANT:** if this violates - [Rule 2b Next Size](next/rules.html#rule-2b-net-size) + [Rule 2b Net Size](next/rules.html#rule2b-net-size) you stand a great chance of having your submission rejected for violating the [Rules](next/rules.html)! @@ -2726,51 +2727,38 @@ In order of the file's contents we describe each required field, below: - `rule_2a_override` (boolean) * `true` if user overrides warning of - [Rule 2a Gross Size](next/rules.html#rule-2a-gross-size) + [Rule 2a - Gross Size](next/rules.html#rule2a-gross-size) violation, else `false`. **IMPORTANT:** if the - [Rule 2a Gross Size](next/rules.html#rule-2a-gross-size) + [Rule 2a - Gross Size](next/rules.html#rule2a-gross-size) calculated size is **NOT** violated but this is `true` then you stand a good chance of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging). + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry). - `rule_2a_mismatch` (boolean) * `true` if - [Rule 2a Gross Size](next/rules.html#rule-2a-gross-size) + [Rule 2a - Gross Size](next/rules.html#rule2a-gross-size) calculated size is not the same as the file size. - `rule_2b_override` (boolean) * `true` if user overrides warning of - [Rule 2b Next Size](next/rules.html#rule-2b-net-size) + [Rule 2b - Net Size](next/rules.html#rule2b-net-size) violation, else `false`. **IMPORTANT:** if the - [Rule 2b Next Size](next/rules.html#rule-2b-net-size) + [Rule 2b - Net Size](next/rules.html#rule2b-net-size) calculated size is **NOT** violated but this is `true` then you stand a good chance of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging). - -- `highbit_warning` (boolean) - * `true` if `iocccsize` detects a high bit (unescaped octets with the high - bit set - octet value >= 128); see - [Rule 12 - UTF-8](next/rules.html#rule-12---utf-8), - else `false`. - -- `nul_warning` (boolean) - * `true` if `iocccsize` detects a NUL character in the `prog.c`, else - `false`. + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry). - `trigraph_warning` (boolean) * `true` if `iocccsize` detects an unknown or invalid trigraph in `prog.c`, else `false`. -- `wordbuf_warning` (boolean) - * This is ignored and will be removed for IOCCC29 and beyond. - - `ungetc_warning` (boolean) * `true` if `prog.c` triggered an `ungetc(3)` error, else `false`. @@ -2780,7 +2768,7 @@ In order of the file's contents we describe each required field, below: **IMPORTANT:** if the `Makefile` file has no problems and this is `true` then you stand a good chance of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging)! + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)! See the FAQ on "[Makefile](#makefile)" @@ -2791,7 +2779,7 @@ In order of the file's contents we describe each required field, below: **IMPORTANT:**: if the `Makefile` file does **NOT** have an `all` rule then you stand a good chance of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging)! + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)! See the FAQ on "[Makefile](#makefile)" @@ -2803,7 +2791,7 @@ In order of the file's contents we describe each required field, below: **IMPORTANT:** if the `Makefile` file does **NOT** have an `all` rule and this boolean is `true` then you stand a good chance of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging)! + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)! See the FAQ on "[Makefile](#makefile)" @@ -2815,7 +2803,7 @@ In order of the file's contents we describe each required field, below: **IMPORTANT:** if the `Makefile` file does **NOT** have a `clean` rule and this boolean is `true` then you stand a good chance of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging)! + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)! See the FAQ on "[Makefile](#makefile)" @@ -2827,7 +2815,7 @@ In order of the file's contents we describe each required field, below: **IMPORTANT:** if the `Makefile` file does **NOT** have an `clobber` rule and this boolean is `true` then you stand a good chance of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging)! + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)! See the FAQ on "[Makefile](#makefile)" @@ -2839,7 +2827,7 @@ In order of the file's contents we describe each required field, below: **IMPORTANT:** if the `Makefile` file does **NOT** have a `try` rule and this boolean is `true` then you stand a good chance of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging)! + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)! See the FAQ on "[Makefile](#makefile)" @@ -2865,7 +2853,7 @@ The `mkiocccentry(1)` tool will write it in this order: **IMPORTANT:** if this is **NOT** the case you stand a great chance of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging)! + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)! - `auth_JSON` (double quoted string) * This `MUST` be `".auth.json"`, defined as `AUTH_JSON_FILENAME` in @@ -2878,7 +2866,7 @@ The `mkiocccentry(1)` tool will write it in this order: **IMPORTANT:** if this is **NOT** the case you stand a great chance of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging)! + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)! - `c_src` (double quoted string) * This `MUST` be `"prog.c"`, defined as `PROG_C_FILENAME` in @@ -2888,7 +2876,7 @@ The `mkiocccentry(1)` tool will write it in this order: **IMPORTANT:** if this is **NOT** the case you stand a great chance of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging)! + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)! - `Makefile` (double quoted string) * This `MUST` be `"Makefile"`, defined as `MAKEFILE_FILENAME` in @@ -2901,7 +2889,7 @@ The `mkiocccentry(1)` tool will write it in this order: **IMPORTANT:** if this is **NOT** the case you stand a great chance of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging)! + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)! - `remarks` (double quoted string) * This `MUST` be `"remarks.md"`, defined as `REMARKS_FILENAME` in @@ -2914,7 +2902,7 @@ The `mkiocccentry(1)` tool will write it in this order: **IMPORTANT:** if this is **NOT** the case you stand a great chance of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging)! + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)! The `manifest` **array** also **OPTIONALLY** has one or more of the field: @@ -2927,7 +2915,7 @@ The `manifest` **array** also **OPTIONALLY** has one or more of the field: filenames are not unique, not POSIX plus + safe chars only, if they are the wrong permission and various other things. In these cases you stand a great risk of having your submission rejected for violating - [Rule 17 - Packaging](next/rules.html#rule-17---packaging)! + [Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)! On the other hand, **ONLY** `mkiocccentry` will verify that the files exist and can be read; `txzchk(1)` will **NOT** do this for you as it only **LISTS** the tarball: it does **NOT** extract it. @@ -2991,7 +2979,7 @@ out of range (see above for list). Two more examples would be if a field is missing or if an unknown filed is in the file. In these cases (and any others that must be established as valid by `chksubmit`) your submission would be rejected for violating -[Rule 17 - Packaging](next/rules.html#rule-17---packaging), +[Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry), and in particular because `chksubmit` would not validate the `.info.json` file. @@ -7437,29 +7425,6 @@ app from time to time to view IOCCC mastodon updates. Jump to: [top](#) -
          -### Q 10.6.1: How can I get push notifications when the judges post something on mastodon? -
          - -To do this you need to go to the [IOCCC mastodon -account](https://fosstodon.org/@ioccc) with a computer (it is unclear how to do -this with a mobile device, if it is even possible) and then you should see a -bell icon. Make sure it's activated. If you mouse over it when it's not enabled -it should look something like this, assuming of course we follow you! :-) (if -not the message about following each other won't show up): - -screenshot of Mastodon push notifications - -It is not yet clear if this only works on desktop/computers or mobile devices -too as it was only just discovered (31 July 2025) but whatever the case we -suggest you do it. - - -Jump to: [top](#) - -
          ### Q 10.7: How do I set certain tabstops for viewing source code in vi(m)?
          diff --git a/news.html b/news.html index af10fb17a..a774a24bd 100644 --- a/news.html +++ b/news.html @@ -747,11 +747,11 @@ as well as a critical fix for installing on BSD based systems.

          and compile the mkiocccentry tool set. You may also wish to install this code. See also the mkiocccentry FAQ for more information.

          2024-12-30

          -

          The IOCCC Rule 12 - UTF-8 no longer discourages the +

          The IOCCC Rule 12 - UTF-8 no longer discourages the use of UTF-8 in C source. Since the days of -std=gnu17 compilers, UTF-8 characters do not impose a compiler problem. The related guideline states that “Rule 13 no longer discourages the use of UTF-8 +characters in C code”.

          -

          The IOCCC Rule 8 - Submission wording has been fixed. It no longer +

          The IOCCC Rule 8 - Submitting requirements wording has been fixed. It no longer states that email will be sent. Instead it talks about potential slot comment modifications as means to tell the submitter that their submission was received.

          All of the import IOCCC dates within the IOCCC rules diff --git a/news.md b/news.md index 8783f9f10..f0c4e1688 100644 --- a/news.md +++ b/news.md @@ -406,12 +406,12 @@ See also the [mkiocccentry FAQ](https://github.com/ioccc-src/mkiocccentry/blob/m ## 2024-12-30 -The IOCCC [Rule 12 - UTF-8](next/rules.html#rule-12---utf-8) no longer discourages the +The IOCCC [Rule 12 - UTF-8](next/rules.html#rule12-utf8) no longer discourages the use of UTF-8 in C source. Since the days of `-std=gnu17` compilers, UTF-8 characters do not impose a compiler problem. The related guideline states that "Rule 13 no longer discourages the use of UTF-8 +characters in C code". -The IOCCC [Rule 8 - Submission](next/rules.html#rule-8---submission) wording has been fixed. It no longer +The IOCCC [Rule 8 - Submitting requirements](next/rules.html#rule8-submitting-requirements) wording has been fixed. It no longer states that email will be sent. Instead it talks about potential slot comment modifications as means to tell the submitter that their submission was received. diff --git a/next/guidelines.html b/next/guidelines.html index e2618bbec..09d6d2568 100644 --- a/next/guidelines.html +++ b/next/guidelines.html @@ -452,940 +452,28 @@ -

          29th International Obfuscated C Code Contest Official Guidelines

          -

          -Copyright © 2025 Leonid A. Broukhis and Landon Curt Noll. -

          -

          All Rights Reserved. Permission for personal, education or non-profit use is -granted provided this copyright and notice are included in its entirety -and remains unaltered. All other uses must receive prior permission in -writing by contacting the judges.

          -

          Guidelines Version

          -

          -These IOCCC guidelines are version 29.00 2025-11-28. -

          -

          -The | symbol indicates an change from the previous IOCCC. -

          -

          -Because the IOCCC29 guidelines was a substantial rewrite, only important changes from IOCCC28 have been marked. -

          -

          Be sure to read the IOCCC rules.

          -
          - -
          -
          - -
          -

          Guidelines for Rule 2 - Size

          -

          -You should pay attention to our observations on -code size and Rule 2 remarks for IOCCC28. -

          -

          Your submission must satisfy BOTH the maximum size Rule 2a Gross Size -AND the Rule 2b Net Size.

          -

          To check your code against Rule 2 - Size, use the iocccentry(1) tool. -For example:

          -
              iocccsize prog.c
          -

          The IOCCC size tool algorithm can be summarized as follows:

          -
          -

          The size tool counts most C reserved words (keyword, secondary, and selected -preprocessor keywords) as 1. The size tool counts all other bytes as 1 -excluding ASCII whitespace, and excluding any ‘;’, ‘{’ or ‘}’ followed by -ASCII whitespace, and excluding any ‘;’, ‘{’ or ‘}’ byte immediately -before the end of file.

          -

          ASCII whitespace includes ASCII tab, ASCII space, ASCII newline, ASCII formfeed, and ASCII carriage return.

          -

          When ‘;’, ‘{’ or ‘}’ are within a C string, they may still not be -counted by the IOCCC size tool.

          -
          -

          In cases where the above summary and the algorithm implemented by -the IOCCC size tool iocccsize(1) conflict, the algorithm implemented -by the current version of iocccsize(1) is preferred by the IOCCC judges. -Make sure iocccsize(1) does not flag any issues with your prog.c.

          -

          There a much less need to #define C reserved words in an effort to get -around the size limits of Rule 2 - Size because of the iocccsize(1) algorithm.

          -

          Yes Virginia, the previous guideline sentence is an important hint!

          -

          Jump to: top

          -
          - -
          -
          - -
          -

          Guidelines for Rule 3 - Register

          -

          See FAQ on “What is an author handle?”.

          -

          Jump to: top

          -
          - -
          -
          - -
          -

          Guidelines for Rule 7 - Original Work

          -

          While it is NOT required, you are allowed to use tools or services such as:

          -
            -
          • Code generators
            • -
          • Static and runtime code analysis tools
            • -
          • Machine learning tools
            • -
          • natural language models
            • -
          • Large language models (LLMs)
            • -
          • Code copilot tools
            • -
          • So called “AI services”
            • -
          • etc.
            • -
          -

          The IOCCC has a rich history of remarkable winning entries created by -authors who skillfully employed various techniques to develop their code. -If you do make use of such tools or services, then we ENCOURAGE you to -describe how you used such tools in your remarks.md file.

          -

          In short: You created it, you own it, its an original work, or you have explicit permission to the work.

          -

          See FAQ on “May I use AI, LLM, Virtual coding assistants, or similar tools to write my submission?”.

          -

          Jump to: top

          -
          - -
          -
          - -
          -

          Guidelines for Rule 11 - Abuse

          -

          We do realize that there are holes in the IOCCC rules, and invite -submitters to attempt to apply creative rule interpretation. A rule abuse though, even -if not rewarded, may result in a subsequent rule change for future contests.

          -

          We sometimes award ‘Best abuse of the rules’ or ‘Worst abuse of the rules’, -or some variation to a submission that creatively attempts to exploit a holes in the -IOCCC rules.

          -

          When we do need to plug a hole in the IOCCC rules -or IOCCC guidelines, we will attempt to use a very small plug, -if not smaller.

          -

          Or, maybe not. :-)

          -

          Legal rule abuse may involve, but is not limited to, doing things that are -technically allowed by the IOCCC rules and yet do not fit the spirit of what -we intended to be submitted.

          -

          Legal abuse of the IOCCC rules is NOT an invitation to violate the -IOCCC rules (especailly Rule 17 - Packaging ). A submission that violates the rules in the -opinion of the IOCCC judges, WILL be -disqualified. RULE ABUSE CARRIES A CERTAIN LEVEL OF RISK! If you -have a submission that might otherwise be interesting, you might want to -submit two versions; one that does not abuse the IOCCC rules and one that -does.

          -

          If you intend to abuse the IOCCC rules, -indicate so in your remarks.md file. You MUST try to justify, plead, beg, -why you consider your rule abuse to be allowed under the -IOCCC rules. Humor or creativity help plead a case. -As there is no guarantee that you will succeed, you might consider -submitting an alternate version that conforms to the -IOCCC rules.

          -

          If you do bypass the mkiocccentry(1) warnings about -Rule 2a Gross Size -or about -Rule 2b Net Size -or any other -rule and submit a submission anyway, you MUST try to justify why the IOCCC -IOCCC judges should not reject your submission due to a rule -violation, and you would be wise to do this towards the top of your remarks.md -file.

          -

          We are often asked why the contest IOCCC rules and IOCCC -guidelines seem strange or contain mistakes, flaws, or -grammatical errors. One reason is that we sometimes make genuine mistakes, but -in many cases such problems, flaws or areas of confusion are deliberate.

          -

          Changes to IOCCC rules and IOCCC guidelines in -response to rule abuses, are done in a minimal fashion. Often we will -deliberately leave behind holes (or introduce new ones) so that future rule -abuse can continue. A clever author should be able to read them and “drive a -truck through the holes” in the IOCCC rules and IOCCC -guidelines.

          -

          At the risk of stating the obvious, this contest is a parody of the software -development process. The IOCCC rules and IOCCC guidelines -are only part of the overall contest. Even so, one might think the -contest IOCCC rules and IOCCC guidelines process as a parody -of the sometimes tragic mismatch between what a customer (or marketing) wants -and what engineering delivers. Real programmers must face obfuscated and -sometimes conflicting, balloning specifications, and requirements from marketing, sales, -product management and even from customers themselves on an all too regular basis. -This is one of the reasons why the IOCCC rules and -IOCCC guidelines are written in obfuscated form.

          -

          Jump to: top

          -
          - -
          -
          - -
          -

          Guidelines for Rule 15 - Building

          -

          You may use git, or services such as GitHub -to develop and maintain your submission. However, we DISLIKE -submissions that require such services in order to build/compile your submission.

          -

          Submissions will be judged in an environment that has no IDE. -Any submission that fails to compile/build because it requires -an IDE will be rejected.

          -

          We will use the GNU make(1) tool, your Makefile, as well as tools found in the -Single UNIX Specification -environments, and commonly found on systems that reasonably conform to the -Single UNIX Specification -in the building and compiling of your submission.

          -

          Jump to: top

          -
          - -
          -
          - -
          -

          Guidelines for Rule 17 - Packaging

          -

          We STRONGLY recommend you do install the -mkiocccentry toolkit -As use of using older versions of the mkiocccentry toolkit to are HIGHLY LIKELY to be REJECTED!

          -

          If you submit your own JSON files (other than .auth.json and -.info.json) then they do NOT have to be valid JSON.

          -

          However, if you do provide invalid JSON files, PLEASE -document and clearly explain this in your remarks.md file.

          -

          -An extra file is defined as a file that is not prog.c, prog.alt.c, -try.sh, try.alt.sh, remarks.md, Makefile, .auth.json and .info.json: -unless it’s not in the top level directory, in which case it IS an extra -file. -

          -

          -These files (prog.c, prog.alt.c, try.sh, try.alt.sh, remarks.md, -Makefile, .auth.json and .info.json) do not count towards the -Rule 17 - Packaging limit of 31 extra files. -

          -

          If you use an optional filename for something other than their intended use -in order to get past the file limit, we will consider that an abuse of rules.

          -

          Your tarball does NOT reveal who you are! For this reason, the tarball -MUST be a v7 format tarball.

          -

          You should NOT use a tarball as an extra file for a test-suite unless you -have a very good reason for this: if you do include a tarball as an extra file, -then you MUST specify why in your remarks.md file.

          -

          If you DO include a tarball an extra file, and the build process or the program extracts -said tarball(s), the make clobber rule MUST remove the extracted files.

          -

          Instead of including a large test-suite that requires a lot of files as part of your submission, -and your submission doesn’t require the test-suite to be available to run, -then in your remarks.md a URL where such a test-suite may be downloaded from -and how to use the test-suite to test your submission.

          -

          See FAQ on “What should I do with the try.sh and try.alt.sh scripts?”.

          -

          See FAQ on “What is a .auth.json file?”.

          -

          See FAQ on “What is a .info.json file?”.

          -

          See FAQ on “How can I validate my submission directory?”.

          -

          See FAQ on “What permissions may my files be and what if I need different permissions?”.

          -

          See FAQ on “What are the detailed recommendations for a submission Makefile?”.

          -

          See FAQ on “What are the details behind Rule 17 - Packaging?”.

          -

          Jump to: top

          -
          - -
          -
          - -
          -

          Guidelines for the mkiocccentry toolkit

          -

          The IOCCC submit server, and related services -use the most recent version of the -mkiocccentry toolkit: -submissions that package using older versions of the -mkiocccentry toolkit -are LIKELY to be REJECTED! So you REALLY SHOULD use the latest mkiocccentry toolkit -to package your own submission.

          -

          The mkiocccentry(1) tool runs a number of checks by way of these -mkiocccentry toolkit tools:

          -
            -
          • iocccsize(1)
            • -
          • txzchk(1)
            • -
          • fnamchk(1)
            • -
          • chksubmit(1)
            • -
          • chkentry(1)
            • -
          -

          Do NOT use txzchk(1) or fnamchk(1) command line options that are labeled -“for TESTING purposes” in their respective man pages.

          -

          Similarly do NOT use chkentry(1) command line options marked “for the use -by the IOCCC judges only” in the chkentry(1) man page.

          -

          To view mkiocccentry toolkit man pages, -while your current directory is the top of the source tree:

          -
          man soup/man/man1/mkiocccentry.1
-man soup/man/man1/iocccsize.1
-man soup/man/man1/txzchk.1
-man test_ioccc/man/man1/fnamchk.1
-man soup/man/man1/chksubmit.1
-man soup/man/man1/chkentry.1
          -

          The above man(1) commands will show the toolkit man pages without having to install them first.

          -

          So that you do not have to repeatedly answer all the mkiocccentry(1) questions, -use mkiocccentry -a answers ... to create a file containing the answers you first give, -so later enter mkiocccentry -i answers ... to reuse those same answers.

          -

          The mkiocccentry -A answers .. does the same thing except that the answers file will be overwritten.

          -

          The mkiocccentry -i answers .. will still be required to confirm “Yes/No” questions. -While mkiocccentry -Y -i answers .. will force yes answers, use with great caution, -because it might force a yes answer to something you do NOT want.

          -

          To help with not having to repeatedly enter a UUID, put your UUID into a file and use -mkiocccentry -u uuidfile .., or use mkiocccentry -U UUID .. to give the UUID -on the command line.

          -

          If you wish to test that your submission passes the mkiocccentry(1) tests -without having to type in answers each time, you can use the -d or -s seed -option to mkiocccentry for the tool to pseudo-randomly create answers for you. -For example:

          -
          mkiocccentry -d workdir topdir
          -

          Do NOT submit a tarball formed by mkiocccentry -d .., NOR by mkiocccentry -s seed ..!

          -

          The mkiocccentry(1) tool creates an xz(1) compressed v7 format tarball using a tar(1) -command of the form:

          -
          cd workdir/UUID-slot_num && tar --format=v7 -cJf submit.UUID-slot_num.timestamp.txz UUID-slot_num
          -

          In many places the mkiocccentry(1) tool will prompt you to verify what you input, allowing you to -correct details as you go along.

          -

          Pressing the “enter key” mkiocccentry(1) tool prompts will allow you to proceed with a default, -however make sure the default is the CORRECT answer.

          -

          The mkiocccentry(1) tool will use code from iocccsize(1) which detects a number of -issues (such as Rule 2 - Size) that you may ignore, -however ignoring such issues comes with a significant level of risk as noted else where.

          -

          Once the tarball is packaged it will -run txzchk(1), which will also run fnamchk(1), as part of its algorithm.

          -

          The use of mkiocccentry -W ... is highly discouraged as this may ignore -warnings about a problem that may cause your submission to be REJECTED!”

          -

          If mkiocccentry encounters an error, the program will exit and the xz -compressed tarball will NOT be generated: this is a feature, not a bug!

          -

          If you encounter a bug with the -mkiocccentry toolkit -PLEASE run the bug_report.sh script to help us out here!

          -

          While you don’t have to install the -mkiocccentry toolkit, -then in order to run a tool outside the repo directory -you will have to specify mkiocccentry(1) command line options to locate required tools -such as chkentry(1) (mkiocccentry -C chkentry ..), txzchk(1) (mkiocccentry -T txzchk ..), -and fnamchk(1) (mkiocccentry -F fnamchk ..).

          -

          The mkiocccentry(1) tool will ignore any filename or directory that begins with a period (.).

          -

          The mkiocccentry(1) tool will ignore all files that begin with COPYING, COPYRIGHT, and LICENSE, regardless -of filename case.

          -

          The mkiocccentry(1) tool will any of the following files if they are found directly under -the top level directory (topdir):

          -
            -
          • README.md
            • -
          • index.html
            • -
          • prog
            • -
          • prog.alt
            • -
          • prog.alt.o
            • -
          • prog.orig.c
            • -
          • filenames matching the [0-9][0-9][0-9][0-9]_*.tar.bz2 file glob
            • -
          -

          The files listed in the above list are allowed to exist in sub-directories: just NOT directly under -the top level directory (topdir).

          -

          The mkiocccentry(1) tool evaluates all filenames and directory names in a case independent way: -this FOO, Foo, and foo are treated as the SAME file even if your filesystem doesn’t.

          -

          Having two or more filenames that differ only by case WILL lead to problems because of the previous statement.

          -

          When the mkiocccentry(1) tool ignores a file, that file is NOT included as part of your submission.

          -

          When the mkiocccentry(1) tool ignores a directory, that directory, -and everything under that directory is NOT included as part of -your submission.

          -

          The mkiocccentry(1) tool will ignore all symlinks.

          -

          Creating a directory directly under the top level directory (topdir) -that is normally considered to be a regular file, such as a directory -named Makefile, prog.alt.c, prog.c, remarks.md, try.alt.sh, -or try.sh is NOT a good idea and will likely cause the -mkiocccentry(1) tool to abort with a fatal error.

          -

          The required Makefile, remarks.md file may NOT be an empty file.

          -

          If the optional file try.alt.sh, or try.sh exits and is an empty file, -the mkiocccentry(1) tool to abort with a fatal error.

          -

          If the mkiocccentry(1) tool encounters anything that isn’t a file, isn’t a directory, -and isn’t a symlink (which the tool ignores), the mkiocccentry(1) tool to abort with a fatal error.

          -

          See FAQ on “How do I report bugs in an mkiocccentry tool?”.

          -

          See Rule 11 - Abuse for warnings about ignoring mkiocccentry(1) tool warnings.

          -

          See FAQ on “What is the fnamchk tool?”.

          -

          See FAQ on “What is mkiocccentry in simple terms?”.

          -

          See FAQ on “What is the mkiocccentry tool, how do I obtain it and how do I use it”.

          -

          Jump to: top

          -
          - -
          -

          General Overall Guidelines

          -

          These guideline are hints and suggestions, NOT IOCCC rules.

          -

          While submissions that violate guideline are allowed, -submissions that remain within the IOCCC guidelines are preferred.

          -

          You are encouraged to review the following FAQs:

          - -

          While the contest is open, you may modify your -previously uploaded submission by rebuilding your submission with the -mkiocccentry toolkit, -and then re-uploading it to the same slot number on the -submit server.

          -

          The official locale of the IOCCC is C.

          -

          You are encouraged to examine the winners of previous contests.

          -

          Because rules change from year to year, some winning entries -of the past may be rejected this year.

          -

          What was was unique and novel one year might be ‘old’ the next year.

          -

          A submission is usually examined in a number of ways. We typically apply -a number of tests to a submission:

          -
            -
          • look at the original source
            • -
          • C pre-process the source ignoring #include lines
            • -
          • C pre-process the source ignoring #define and #include lines
            • -
          • run it through a C beautifier (such as clang-format(1))
            • -
          • examine the algorithm
            • -
          • compile it (with flags to enable all warnings)
            • -
          • execute it
            • -
          -

          You should consider how your submission looks in each of the above tests. -You should ask yourself if your submission remains obscure after it has been -‘cleaned up’ by the C pre-processor and a C beautifier.

          -

          Your submission need not pass all of the above tests as in certain cases, -a test is not important.

          -

          Submissions that compete for the -‘strangest/most creative source layout’ need not do as well as -others in terms of their algorithm.

          -

          Given two submissions, we are more inclined to pick the submission that -does something interesting when it’s executed.

          -

          IMPORTANT: Be sure that your submission works as documented in your remarks.md file.

          -

          We sometimes make an effort to debug a submission -that has a slight problem, particularly in or near the final round. -On the other hand, we have seen some otherwise excellent submissions -fall down because they didn’t work as documented.

          -

          If you submission has bugs and/or mis-features, you are MUCH BETTER off -documenting such bugs and/or mis-features in your remarks.md file.

          -

          Consider an example of a prime number -printing program that claims that 16 is a prime number. -Noting such a bug in your remarks.md file could save your submission:

          -
          -

          “this submission sometimes prints the 4th power of a prime by mistake”

          -
          -

          Sometimes a strange bug or (mis-)feature can even help the submission! Of course, a correctly -working submission might be better.

          -

          We tend to look down on a -prime number -printer that claims that 16 is a prime number. -Clever people will note that 16 might be prime under certain conditions. ;-) -Wise people, when submitting something clever -will fully explain such cleverness in their submission’s remarks.md file.

          -

          People who are considering to just use some complex mathematical -function or state machine to spell out something such as “hello, -world!” really really, and we do mean REALLY, do need to be more creative.

          -

          Consider using misleading or subtle tricks layered on top of or under -an appropriate level of obfuscation.

          -

          A clean looking program with -misleading comments and variable names might be a VERY GOOD START -to a great submission!

          -

          Jump to: top

          -
          - -
          -
          - -
          -

          OUR LIKES AND DISLIKES:

          -

          We VERY MUCH LIKE submissions that use an edited variant of the -example Makefile, as described and linked to in the Makefile section, -renamed as Makefile of course. This makes it easier for the IOCCC judges -to test your submission. And if your submissions wins, it makes it easier to integrate it into -the Official IOCCC winner website.

          -

          We VERY MUCH LIKE submissions that have some educational value. This does NOT mean -that your submission should not be obfuscated but rather that the IOCCC has moved away from -the idea of “spoilers”. You should not encrypt or rot13 content in your remarks.md file.

          -

          It is VERY MUCH appreciated if your remarks have some educational -value. And although educational value is not required, it is an -EXCELLENT bonus.

          -

          We LIKE submissions that use an edited version of the -try.sh example script (and if you have alternate code, -the same applies with the try.alt.sh script):

          - -

          Of course, it is quite possible that only one invocation is -possible, so it is not necessarily detrimental to your submission if you do not -include one, though we do like interesting and creative uses of submissions. See -also the -FAQ on “submitting try.sh and try.alt.sh scripts”.

          -

          -Even if it only has one invocation we still LIKE the try scripts. -

          -

          -If you do include a try.sh then PLEASE remove the try rule in the Makefile. -

          -

          -If you do include a try.alt.sh then PLEASE remove the try.alt rule in the Makefile. -

          -

          -If you don’t have a prog.alt.c, then PLEASE remove the try.alt rule as well. -

          -

          Doing masses of #defines to obscure the source has become ‘old’. We -tend to ‘see thru’ masses of #defines due to our pre-processor tests -that we apply. Simply abusing #defines or -Dfoo=bar won’t go as far -as a program that is more well rounded in confusion.

          -

          Many C compilers DISLIKE the following code, and so do we:

          -
              #define d define
-    #d foo             /* <-- don't expect this to turn into #define foo */
          -

          In other words, it is a compilation error, and in order to get older -IOCCC winning entries that did this to compile, we had to update them to not do this.

          -

          When declaring local or global variables, you should declare the type:

          -
              int this_is_fine;
-    this_is_not;       /* <-- Try to avoid implicit type declarations */
          -

          We tend to like less a submission that requires either -gcc OR clang. We prefer submissions that can compile -under BOTH gcc AND clang. Hint!

          -

          We RECOMMEND that the compiler flags you use in your -submission’s Makefile are supported by BOTH gcc AND clang.

          -

          We DISLIKE the use of obscure compiler flags, especially -if gcc and/or clang do not support it. We suggest -that you not use any really obscure compiler flags if you can help it.

          -

          One side effect of the above is that you cannot assume the use -of nested functions such as:

          -
               int main() {
-|        void please_dont_submit_this() {
-|           printf("The machine that goes BING!!\n");
-         }
-|        please_dont_submit_this();
-     }
          -

          On 2012 July 20, the IOCCC judges rescinded the encouragement of -nested functions. Such constructions, while interesting and sometimes -amusing, will have to wait until they are required by a C standard that are -actually implemented in BOTH gcc AND clang.

          -

          We DISLIKE submissions that require the use of -fnested-functions.

          -

          If your submission uses functions that have a variable number of -arguments, be careful. Systems implement va_list in a wide variety -of ways. Because of this, a number of operations using va_list are -not portable and must not be used:

          -
            -
          • assigning a non-va_list variable to/from a va_list variable
            • -
          • casting a non-va_list variable into/from a va_list variable
            • -
          • passing a va_list variable to a function expecting a non-va_list arg
            • -
          • passing a non-va_list variable to a function expecting a va_list arg
            • -
          • performing arithmetic on va_list variables
            • -
          • using va_list as a structure or union
            • -
          -

          In particular, do not treat va_list variables as if they were a char **.

          -

          We DISLIKE the use of varargs.h. Use stdarg.h instead.

          -

          We DISLIKE the use of gets(3). Use fgets(3) instead.

          -

          We tend to DISLIKE the blatant use of tarballs in an attempt to simply get -around the extra file number limit. We realize there may be cases where a -tarball containing a number of extra files may be needed. Such a need for a -tarball MUST be explained in the remarks.md file.

          -

          -Using a mass of gotos to obfuscate your code has become ‘old’ and is unlikely -to make it through the final rounds, if it even gets that far. -

          -

          On 28 January 2007, the Judges rescinded the requirement that the -# in a C preprocessor directive must be the 1st non-whitespace byte.

          -

          The exit(3) function returns void. Some broken systems have exit(3) -return int; your submission should assume that exit(3) returns a void.

          -

          Small programs are best when they are short, obscure and concise. -While such programs are not as complex as other winners, they do -serve a useful purpose: they are often the only program that people -attempt to completely understand. For this reason, we look for -programs that are compact, and are instructional.

          -

          One line programs should be short one line programs: say around 80 to 132 -bytes long. Going well beyond 132 bytes is a bit too long to be called -a one-liner in our vague opinion.

          -

          We tend to DISLIKE programs that:

          -
            -
          • are very hardware specific
            • -
          • are very OS version specific (index(3)/strchr(3) differences are OK, but -sockets/streams specific code is likely not to be)
            • -
          • dump core or have compiler warnings (it is OK only if -you warn us in your remarks.md file)
            • -
          • won’t compile or run in a Single UNIX -Specification -environment
            • -
          • depend on a utility or application not normally found -in systems that conform to the Single UNIX -Specification
            • -
          • abuse the build file to get around the size limit
            • -
          • obfuscate by use of ANSI trigraphs
            • -
          • obfuscate by use of digraphs
            • -
          • are larger than they need to be
            • -
          • have more lines than they need to have
            • -
          • are “blob-ier” (just a pile of unformatted C code) than they need to be
            • -
          • are rather similar to previous winners :-(
            • -
          • are identical to previous losers :-)
            • -
          • that mandate the exclusive use of a specific Integrated Development Environment (IDE)
            • -
          -

          In order to encourage submission portability, we DISLIKE submissions that -fail to build unless one is using an IDE. For example, do not -mandate that one must use Microsoft Visual Studio to compile -your submission.

          -

          The program must compile and link cleanly in a Single UNIX -Specification -environment. Therefore do not assume the system has a -windows.h include file:

          -
              #include <windows.h>  /* we DISLIKE this */
          -

          Unless you are cramped for space, or unless you are entering the -‘Best one liner’ category, we suggest that you format your program -in a more creative way than simply forming excessively long lines.

          -

          The Makefile should not be used to try and get around the size limit. It is -one thing to make use of a several -Ds on the compile line to help out, but it -is quite another to use many bytes of -Ds in order to try and squeeze the -source under the size limit.

          -

          Your source code, post-pre-processing, should not exceed the size of -Microsoft Windows. :-)

          -

          You should try to restrict commands used in the build file to commands found in -Single UNIX -Specification -environments and systems that conform to the Single UNIX -Specification.

          -

          You may compile and use your own programs. If you do, try to build and execute -from the current directory. This restriction is not a hard and -absolute one. The intent is to ensure that the building of your -program is reasonably portable.

          -

          We prefer programs that are portable across a wide variety of UNIX-like -operating systems (e.g., Linux, GNU Hurd, BSD, UNIX, etc.).

          -

          Don’t forget that the building of your program should be done -WITHOUT human intervention. So don’t do things such as:

          -
              prog: prog.c
-        #echo this next line requires data from standard input
-        cat > prog.c
-        ${CC} prog.c -o prog
          -

          However, you can do something cute such as making your program -do something dumb (or cute) when it is built ‘automatically’, and -when it is run with a human involved, do something more clever. -For example, one could put in their Makefile:

          -
              prog: prog.c
-        ${CC} prog.c -DNON_HUMAN_COMPILE -o prog
-        @echo "See remarks section about alternate ways to compile"
          -

          and then include special notes in your remarks.md file for -alternate / human intervention based building.

          -

          We want to get away from source that is simply a compact blob of -bytes. REALLY TRY to be more creative than blob coding. HINT!

          -

          Please do not use things like gzip(1) to get around the size limit. -Please try to be much more creative.

          -

          We really DISLIKE submissions that make blatant use of including -large data files to get around the source code size limit.

          -

          Did we remember to indicate that programs that blatantly use -some complex state machine to do something simple, are boring? -We think we did. :-)

          -

          Given two versions of the same program, one that is a compact blob -of code, and the other that is formatted more like a typical C -program, we tend to favor the second version. Of course, a third -version of the same program that is formatted in an interesting -and/or obfuscated way, would definitely win over the first two! -Remember, you can submit more than one submission. See the -IOCCC rules -for details (in particular, -Rule 8 - Submission).

          -

          We suggest that you avoid trying for the ‘smallest self-replicating’ -source. The smallest, a zero byte entry, won in -1994.

          -

          Programs that claim to be the smallest C source that does something, really -better be the smallest such program or they risk being rejected because -they do not work as documented.

          -

          Please note that the C source below, besides lacking in obfuscation, -is NOT the smallest C source file that when compiled and run, dumps core:

          -
              main;
          -

          Unless you specify -fwritable-strings (see COTHER in the example -Makefile, described in the Makefile section), do not assume this -sort of code will work:

          -
              char *T = "So many primes, so little time!";
-    ...
-    T[14] = ';';    /* modifying a string requires: -fwritable-strings */
          -

          Even so, one should probably not assume that this is universally accepted.

          -

          Initialized char arrays are OK to write over. For instance, this is OK:

          -
              char b[] = "Is this OK";
-    b[9] = 'k';     /* modifying an initialized char array is OK */
          -

          X client submissions should be as portable as possible. Submissions that -adapt to a wide collection of environments will be favored. For -example, don’t depend on a particular type or size of display. -Don’t assume the use of a particular browser. Instead assume a -generic browser that forms to a widely used W3C -standard. -Don’t assume a particular sound sub-system or video driver is installed -in the OS. Instead, make use of a well known and widely available open -source program (one that actually works) to display audio/visual data.

          -

          X client submissions should avoid using X related libraries and -software that are not in wide spread use.

          -

          As of Red Hat RHEL9.0, the X.org server is deprecated. See the -FAQ on “Xorg deprecation”” -for more details. This does not mean that a submission using this will -necessarily be rejected, but it would be better if it can support Wayland in -some way or another.

          -

          We DISLIKE submissions that use proprietary toolkits such as the M*tif, -Xv*ew, or OpenL*ok toolkits, since not everyone has them. Use an -open source toolkit that is widely and freely available instead.

          -

          X client submissions should try to not to depend on particular items in -.Xdefaults. If you must do so, be sure to note the required lines -in the your remarks.md file. They should also not depend on any -particular window manager.

          -

          Try to avoid submissions that play music that some people believe is copyrighted -music.

          -

          While we recognize that UNIX is not a universal operating system, the contest -does have a bias towards such systems. In an effort to expand the scope of the -contest, we phrase our bias to favor the Single UNIX -Specification.

          -

          You are well advised to submit code that conforms to the Single UNIX -Specification Version 4.

          -

          To quote the IOCCC judges:

          -

          We LIKE programs that:

          -
            -
          • are as concise and small as they need to be
            • -
          • do something at least quasi-interesting
            • -
          • are portable
            • -
          • are unique or novel in their obfuscation style
            • -
          • make use of a NUMBER OF DIFFERENT TYPES OF OBFUSCATIONS! <== HINT!!
            • -
          • make us laugh and/or throw up :-) (humor really helps!)
            • -
          • make us want to eat good chocolate
            • -
          -

          Some types of programs can’t excel (anti-tm) in some areas. Your -program doesn’t have to excel in all areas, but doing well in several -areas really does help.

          -

          You are better off explaining what your submission does in your -remarks.md file section rather than leaving it obscure for the -IOCCC judges as we might miss something and/or be too tired to -notice.

          -

          We freely admit that interesting, creative or humorous comments in -your remarks.md file help your chances of winning. If you had to -read so many twisted submissions, you too would enjoy a good laugh or two. -We think the readers of the contest winners do as well. We do read -your remarks.md content during the judging process, so it is worth your -while to write a remarkable remarks.md file.

          -

          We DISLIKE C code with trailing control-M’s (\r or \015) that results -in compilation failures. Some non-UNIX/non-Linux tools such as -MS Visual C and MS Visual C++ leave trailing control-M’s on lines. -Users of such tools should strip off such control-M’s before submitting -their submissions. In some cases tools have a “Save As” option that will -prevent such trailing control-M’s being added.

          -

          One should restrict libcurses to portable features found on both BSD -and Linux curses.

          -

          -If you do #include <curses.h> make CERTAIN you link in curses (i.e. --lcurses) and not ncurses (i.e. -lncurses). -

          -

          Rule 13 - Newlines -no longer discourages the use of UTF-8 -characters in C code.

          -

          It is a very good idea to, in your remarks.md file, tell us why you -think your submission is obfuscated. This is particularly true if -your submission has some very subtle obfuscations that we might -otherwise overlook. <<– Hint!

          -

          Anyone can format their code into a dense blob. A really clever -author will try format their submission using a “normal” formatting style -such that at first glance (if you squint and don’t look at the details) -the code might pass for non-obfuscated C. Deceptive comments, -and misleading formatting, in some cases, may be a plus. On the -other hand, a misleading code style requires more source bytes.

          -

          If you do elect to use misleading formatting and comments, we -suggest you remark on this point in your remarks.md where you talk -about why you think your submission is obfuscated. On the other hand, -if you are pushing up against the size limits, you may be forced -into creating a dense blob. Such are the trade-offs that obfuscators face!

          -

          We prefer code that can run on either a 64-bit or 32-bit -processor. However, it is UNWISE to assume it will run on an -some Intel-like x86 architecture**.

          -

          While programs that only run in a specific word size are OK, if you have -to pick, choose a 64-bit word size.

          -

          If your submission MUST run only on a 64-bit or 32-bit architecture, -then you MUST specify the -arch on your command line -(see ARCH in the example -Makefile, described in Makefile section). Do not assume a -processor word size without specifying -arch. For example:

          -
              ARCH= -m64
          -

          Note, however, that some platforms will not necessarily support some -architectures. For instance, more recent versions of macOS do NOT support -32-bit!

          -

          If there are limitations in your submission, you are highly encouraged -to note such limitations in your remarks.md file. For example if your -submission factors values up to a certain size, you might want to state:

          -
          -

          This submission factors values up 2305567963945518424753102147331756070. -Attempting to factor larger values will produce unpredictable results.

          -
          -

          The IOCCC judges might try to factor the value -5, so you want to might state:

          -
          -

          This submission factors positive values up -2305567963945518424753102147331756070. Attempting to factor large values will -produce unpredictable results.

          -
          -

          However the IOCCC judges might try to also factor 0, so you want to might state:

          -
          -

          This submission factors values between 1 and -2305567963945518424753102147331756070. Attempting to factor values outside -that range will produce unpredictable results.

          -
          -

          Moreover they might try to also factor 3.5 or 0x7, or Fred, so you want to might state:

          -
          -

          This submission factors integers between 1 and -2305567963945518424753102147331756070. Attempting to factor anything else -will produce unpredictable results.

          -
          -

          You submission might be better off catching the attempt to factor bogus values -and doing something interesting. So you might want to code accordingly and state:

          -
          -

          This submission factors integers between 1 and 2305567963945518424753102147331756070. -Attempting to factor anything else will cause the program to insult your pet fish Eric.

          -
          -

          The IOCCC judges might not have a pet fish named Eric, so you might want to state:

          -
          -

          This submission factors integers between 1 and -2305567963945518424753102147331756070. Attempting to factor anything else -will cause the program to insult your pet fish Eric, or in the case that you -lack such a pet, will insult the pet that you do not have.

          -
          -

          When all other things are equal, a submission with fewer limitations will be judged -better than a submission with lots of limitations. So you might want to code accordingly -and state:

          -
          -

          This submission attempts to a factor value of any size provided that the -program is given enough time and memory. If the value is not a proper integer, -the program might insult a fish named Eric.

          -
          -

          We DISLIKE the use of ASCII tab characters in markdown files, such as in the required remarks.md file.

          -

          We don’t mind the use of ASCII tab characters in your C code. Feel free -to use ASCII tab characters if that suits your obfuscation needs. If is -perfectly OK to use tab characters elsewhere in your submission, just not in -markdown files as this tends annoy us when it comes time to -rendering your markdown content as it complicates the process.

          -

          If you do use ASCII tab characters in your non-markdown files, be -aware that some people may use a tab stop that is different than the common 8 -character tab stop.

          -

          PLEASE observe our IOCCC markdown guidelines -when forming your submission’s remarks.md file. And if your submission -contains additional markdown files, please follow those same guidelines for -those files. See also -Rule 4 - Files, -and the -FAQ on “markdown”.

          -

          We LIKE reading remarks.md files, especially if they contain -useful, informative, and even humorous content about your submission. Yes, this -is a hint. :-)

          -

          We RECOMMEND you put a reasonable amount effort into the content of the -remarks.md file: it is a required file for a reason. :-)

          -

          Try to be even more creative!

          -

          Jump to: top

          -
          - -
          -

          Fun😄damental Guidelines

          -

          The reason for the times of day are so that key IOCCC events are calculated -to be a functional UTC time. :-)

          -

          At least 2 of several reasons for selecting the prime, 2503, for -Rule 2b - Net Size -may be found on the “Curios!” about 2503.

          -

          The 2503 value for Rule 2b - Net is a decimal anagram -of the number of the kernel disk pack of one of the judge’s BESM-6.

          -

          There may or may not be fewer than 2^7+1 reasons why these IOCCC -guidelines seem obfuscated.

          -

          Excessively “dotty” use of the chksubmit(1) or chkentry(1) commands suggests that -either like silly things, or that you”RTFS” with some level of care.

          -

          Some people might question what actually constitutes a valid JSON file, given -the state of the “so-called” JSON spec.. :-)

          -

          We prefer programs that do not require a fish license: crayons and -cat detector vans not withstanding.

          -

          -This guideline has a change mark at the very start of this line. -

          -

          While those who are used to temperatures found on dwarf -planets -(yes Virginia, dwarf planets ARE planets!), such as -Pluto, might be able to -explain to the Walrus why our seas are boiling hot, the question of -whether pigs have wings is likely to remain a debatable point to most.

          -

          At least one judge prefers to maintain the use of the -leap-second -as part of the world’s time standard. If your code prints time -with seconds, we prefer that your code be capable of printing the -time of day during a leap-second where the value in seconds -after the minute mark is 60.

          -

          Other windows, on the other hand, might be OK: especially where “X -marks the spot”. Yet on the third hand, windows are best when they are -“unseen” (i.e., not dirty). :-)

          -

          The IOCCC judges, as a group, have a history giving wide degree of latitude -to reasonable submissions. And recently they have had as much longitudinal -variation as it is possible to have on Earth. :-) -Other windows, on the other hand, might be OK: especially where “X -marks the spot”. Yet on the third hand, windows are best when they are -“unseen” (i.e., not dirty). :-)

          -

          The IOCCC judges, as a group, have a history giving wide degree of latitude -to reasonable submissions. And recently they have had as much longitudinal -variation as it is possible to have on Earth. :-)

          -
          -

          You are in a maze of twisty guidelines, all different.

          -
          -

          There are at least zero IOCCC judges who think that -Fideism has little -or nothing to do with the IOCCC judging process.

          -
          -

          All generalizations are false, including this one. – Mark Twain

          -
          -

          -There are more than about 1 typos in this very sentence. -

          -

          This could be the only guideline that contains the word -fizzbin.

          -

          However, do you know how to play fizzbin? -You do?!? (Except on Tuesday?)

          -

          OK, there are actually 2 guidelines that contain the word -fizzbin, -unless you count this one, in which case there are 3. :-)

          -

          NOTE: The previous guideline in this spot has been replaced by this guideline:

          -

          -

          -

          You very well might not be completely prohibited from failing to not partly -misunderstand this particular guideline, but of course, we could not possibly -comment! :-) Nevertheless, you are neither prohibited, nor are you fully or partly -required to determine that this or the previous sentence is either false and/or -perhaps misleading. Therefore, it might be wise for you to not fail to consider -to not do so, accordingly. Thank you very much (allegedly).

          -
          -

          -

          Any complaints about the above guideline could be addressed to the -Speaker of the House of Commons, or to the speaker of your national -parliament should you have one.

          -

          -Please try to avoid this specific individual guideline, if it at all possible. -

          -

          We believe that Mark Twain’s quote:

          -
          -

          Get your facts first, then you can distort them as you please.

          -
          -

          … is a good motto for those writing code for the IOCCC.

          -

          -We do not recommend submitting systemd source code to the IOCCC, -if nothing else because that code is likely to exceed -Rule 2 - Size. -This isn’t to say that another highly compact and obfuscated -replacement of init(8) would not be an interesting submission. -

          -

          -The -mkiocccentry toolkit -is not an original work, unless you one of the -several mkiocccentry toolkit contributors. -in which case it is original! :-) -

          -

          If the IOCCC judges are feeling ornery we -might choose to compile your program for running on an Arduino or -a PDP-11. Heck, should we ever find an emulator of 60-bit CDC Cyber -CPU, we might just try your submission on that emulator as well :-)

          -

          Do not fear if you’re not 100% sure of the significance of -2305567963945518424753102147331756070 as it is not of prime importance: or is -it? :-)

          -

          Jump to: top

          -
          - -
          -
          - -
          -

          FOR MORE INFORMATION:

          -

          For questions or comments about the contest, see Contacting the IOCCC.

          -

          Be SURE to review the IOCCC Rules and Guidelines as they -may (and often do) change from year to year.

          -

          PLEASE be sure you have the current IOCCC rules and -IOCCC guidelines prior to submitting to the contest.

          -

          See the Official IOCCC website news for additional information.

          -

          For the updates and breaking IOCCC news, you are encouraged to follow -the IOCCC on Mastodon. See our -FAQ on “Mastodon” -for more information. Please do note that unless -you are mentioned by us you will NOT get a notification from the app so you -should refresh the page even if you do follow us.

          -

          Check out the Official IOCCC winner website in general.

          -

          Consider joining the IOCCC discord community via this link: -https://discord.gg/Wa42Qujwnw

          -

          See the -FAQs on “obtaining, compiling, installing and using the mkiocccentry tools” -and the -FAQ on “how to enter the IOCCC” -as that FAQ has important details on -how to register -as well as -how to upload your submission for the IOCCC.

          -
          -

          Jump to: top -

          + +

          The IOCCC is closed

          +

          The IOCCC is NOT accepting new submissions at this time. See the +IOCCC winning entries page for the entries that have won the +IOCCC in the past.

          +

          These guidelines are a TENTATIVE proposal for the next IOCCC +and are likely be to be updated before the next IOCCC.

          +

          See our +FAQ on “rules, guidelines, tools feedback” +as well as our +FAQ on “about asking questions” +about these guidelines. You might also find the FAQ in general useful, especially the +FAQ on “how to enter the IOCCC”.

          +

          Watch both the IOCCC status page and the +@IOCCC mastodon feed for information about +future IOCCC openings.

          +

          HINT to mastodon users: You may wish to refresh the @IOCCC +mastodon feed page and/or mastodon +app from time to time to view IOCCC mastodon updates.

          + + + diff --git a/next/guidelines.md b/next/guidelines.md index 0a7386917..c6308c625 100644 --- a/next/guidelines.md +++ b/next/guidelines.md @@ -1,1214 +1,28 @@ + -# 29th International Obfuscated C Code Contest Official Guidelines +# The IOCCC is closed -

          -Copyright © 2025 Leonid A. Broukhis and Landon Curt Noll. -

          +The IOCCC is **NOT** accepting new submissions at this time. See the +[IOCCC winning entries page](../years.html) for the entries that have won the +IOCCC in the past. -All Rights Reserved. Permission for personal, education or non-profit use is -granted provided this copyright and notice are included in its entirety -and remains unaltered. All other uses must receive prior permission in -writing by [contacting the judges](../contact.html). +These guidelines are a **TENTATIVE proposal** for the next IOCCC +and are **likely be to be updated** before the next IOCCC. +See our +FAQ on "[rules, guidelines, tools feedback](../faq.html#feedback)" +as well as our +FAQ on "[about asking questions](../faq.html#question)" +about these guidelines. You might also find the FAQ in general useful, especially the +FAQ on "[how to enter the IOCCC](../quick-start.html#enter)". -# Guidelines Version +Watch both [the IOCCC status page](../status.html) and the +[@IOCCC mastodon feed](https://fosstodon.org/@ioccc) for information about +future IOCCC openings. -

          -These IOCCC guidelines are version **29.00 2025-11-28**. -

          +**HINT to mastodon users**: You may wish to refresh the [@IOCCC +mastodon feed](https://fosstodon.org/@ioccc) page and/or mastodon +app from time to time to view IOCCC mastodon updates. -

          -The | symbol indicates an **change** from the previous IOCCC. -

          - -

          -Because the **IOCCC29** guidelines was a substantial rewrite, only **important changes** from **IOCCC28** have been marked. -

          - -Be sure to read the [IOCCC rules](rules.html). - - -
          -
          - -# Guidelines for [Rule 2 - Size](rules.html#rule-2---size) - -

          -You should pay attention to our observations on -[code size and Rule 2 remarks for IOCCC28](../2024/index.html#code-size-and-rule-2). -

          - -Your submission must satisfy **BOTH** the maximum size [Rule 2a Gross Size](rules.html#rule-2a-gross-size) -**AND** the [Rule 2b Net Size](rules.html#rule-2b-net-size). - -To check your code against [Rule 2 - Size](rules.html#rule-2---size), use the `iocccentry(1)` tool. -For example: - -``` - iocccsize prog.c -``` - -The IOCCC size tool algorithm can be summarized as follows: - -> The size tool counts most C reserved words (keyword, secondary, and selected -preprocessor keywords) as 1. The size tool counts all other bytes as 1 -excluding ASCII whitespace, and excluding any '`;`', '`{`' or '`}`' followed by -ASCII whitespace, and excluding any '`;`', '`{`' or '`}`' byte immediately -before the end of file. -> -> ASCII whitespace includes ASCII tab, ASCII space, ASCII newline, ASCII formfeed, and ASCII carriage return. -> -> When '`;`', '`{`' or '`}`' are within a C string, they may still not be -counted by the IOCCC size tool. - -In cases where the above summary and the algorithm implemented by -the IOCCC size tool `iocccsize(1)` conflict, the algorithm implemented -by the current version of `iocccsize(1)` is preferred by the [IOCCC judges](../judges.html). -Make sure `iocccsize(1)` does not flag any issues with your `prog.c`. - -There a much less need to `#define` C reserved words in an effort to get -around the size limits of [Rule 2 - Size](rules.html#rule-2---size) because of the `iocccsize(1)` algorithm. - -Yes Virginia, **the previous guideline sentence is an important hint**! - - -Jump to: [top](#) - - -
          -
          - -# Guidelines for [Rule 3 - Register](rules.html#rule-3---register) - -See FAQ on "[What is an author handle?](../faq.html#author_handle_faq)". - - -Jump to: [top](#) - - -
          -
          - -# Guidelines for [Rule 7 - Original Work](rules.html#rule-7---original-work) - -While it is **NOT** required, you are allowed to use tools or services such as: - -* Code generators -* Static and runtime code analysis tools -* Machine learning tools -* natural language models -* Large language models (LLMs) -* Code copilot tools -* So called "_AI services_" -* etc. - -The IOCCC has a rich history of remarkable winning entries created by -authors who skillfully employed various techniques to develop their code. -If you do make use of such tools or services, then we **ENCOURAGE you to -describe how you used such tools** in your `remarks.md` file. - -In short: You created it, you own it, its an original work, or you have explicit permission to the work. - -See FAQ on "[May I use AI, LLM, Virtual coding assistants, or similar tools to write my submission?](../faq.html#ai)". - - -Jump to: [top](#) - - -
          -
          - -# Guidelines for [Rule 11 - Abuse](rules.html#rule-11---abuse) - -We do realize that there are holes in the [IOCCC rules](rules.html), and invite -submitters to attempt to apply creative rule interpretation. A rule abuse though, even -if not rewarded, may result in a subsequent rule change for future contests. - -We sometimes award '**Best abuse of the rules**' or '**Worst abuse of the rules**', -or some variation to a submission that creatively attempts to exploit a holes in the -[IOCCC rules](rules.html). - -When we do need to plug a hole in the [IOCCC rules](rules.html) -or [IOCCC guidelines](guidelines.html), we will attempt to use a very small plug, -if not smaller. - -Or, maybe not. :-) - -Legal rule abuse may involve, but is not limited to, doing things that are -technically allowed by the [IOCCC rules](rules.html) and yet do not fit the spirit of what -we intended to be submitted. - -Legal abuse of the [IOCCC rules](rules.html) is **NOT** an invitation to violate the -[IOCCC rules](rules.html) (especailly [Rule 17 - Packaging](./rules.html#rule-17---packaging) ). A submission that violates the [rules](rules.html) in the -opinion of the [IOCCC judges](../judges.html), **WILL** be -disqualified. **_RULE ABUSE CARRIES A CERTAIN LEVEL OF RISK!_** If you -have a submission that might otherwise be interesting, you might want to -submit two versions; one that does not abuse the [IOCCC rules](rules.html) and one that -does. - -If you intend to abuse the [IOCCC rules](rules.html), -indicate so in your `remarks.md` file. You **MUST** try to justify, plead, beg, -why you consider your rule abuse to be allowed under the -[IOCCC rules](rules.html). Humor or creativity help plead a case. -As there is no guarantee that you will succeed, you might consider -submitting an alternate version that conforms to the -[IOCCC rules](rules.html). - -If you do bypass the `mkiocccentry(1)` warnings about -[Rule 2a Gross Size](rules.html#rule-2a-gross-size) -or about -[Rule 2b Net Size](rules.html#rule-2b-net-size) -or any other -rule and submit a submission anyway, you **MUST** try to justify why the IOCCC -[IOCCC judges](../judges.html) should not reject your submission due to a rule -violation, and you would be wise to do this towards the top of your `remarks.md` -file. - -We are often asked why the contest [IOCCC rules](rules.html) and [IOCCC -guidelines](guidelines.html) seem strange or contain mistakes, flaws, or -grammatical errors. One reason is that we sometimes make genuine mistakes, but -in many cases such problems, flaws or areas of confusion are deliberate. - -Changes to [IOCCC rules](rules.html) and [IOCCC guidelines](guidelines.html) in -response to rule abuses, are done in a minimal fashion. Often we will -deliberately leave behind holes (or introduce new ones) so that future rule -abuse can continue. A clever author should be able to read them and "drive a -truck through the holes" in the [IOCCC rules](rules.html) and [IOCCC -guidelines](guidelines.html). - -At the risk of stating the obvious, this contest is a parody of the software -development process. The [IOCCC rules](rules.html) and [IOCCC guidelines](guidelines.html) -are only part of the overall contest. Even so, one might think the -contest [IOCCC rules](rules.html) and [IOCCC guidelines](guidelines.html) process as a parody -of the sometimes tragic mismatch between what a customer (or marketing) wants -and what engineering delivers. Real programmers must face obfuscated and -sometimes conflicting, balloning specifications, and requirements from marketing, sales, -product management and even from customers themselves on an all too regular basis. -This is one of the reasons why the [IOCCC rules](rules.html) and -[IOCCC guidelines](guidelines.html) are written in obfuscated form. - - -Jump to: [top](#) - - -
          -
          - -# Guidelines for [Rule 15 - Building](rules.html#rule-15---building) - -You may use `git,` or services such as [GitHub](https://www.github.com) -to develop and maintain your submission. However, we **DISLIKE** -submissions that **require** such services in order to build/compile your submission. - -Submissions will be judged in an environment that has no **IDE**. -Any submission that fails to compile/build because it requires -an **IDE** will be rejected. - -We will use the `GNU make(1)` tool, your `Makefile`, as well as tools found in the -[Single UNIX Specification](https://en.wikipedia.org/wiki/Single_UNIX_Specification) -environments, and commonly found on systems that reasonably conform to the -[Single UNIX Specification](https://en.wikipedia.org/wiki/Single_UNIX_Specification) -in the building and compiling of your submission. - - -Jump to: [top](#) - - -
          -
          - -# Guidelines for [Rule 17 - Packaging](rules.html#rule-17---packaging) - -We **STRONGLY** recommend you **do** install the -[mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) -As use of using older versions of the mkiocccentry toolkit to are **HIGHLY LIKELY** to be **REJECTED**! - -If you submit your own JSON files (other than `.auth.json` and -`.info.json`) then they do **NOT** have to be valid JSON. - -However, if you do provide invalid JSON files, **PLEASE** -document and **clearly explain** this in your `remarks.md` file. - -

          -An _extra file_ is defined as a file that is not `prog.c`, `prog.alt.c`, -`try.sh`, `try.alt.sh`, `remarks.md`, `Makefile`, `.auth.json` and `.info.json`: -unless it's not in the top level directory, in which case it **IS** an _extra -file_. -

          - -

          -These files (`prog.c`, `prog.alt.c`, `try.sh`, `try.alt.sh`, `remarks.md`, -`Makefile`, `.auth.json` and `.info.json`) do _not_ count towards the -[Rule 17 - Packaging](rules.html#rule-17---packaging) limit of **31** _extra files_. -

          - -If you use an optional filename for something other than their intended use -in order to get past the file limit, we will consider that an abuse of rules. - -Your tarball does **NOT** reveal who you are! For this reason, the tarball -**MUST** be a **v7 format** tarball. - -You should NOT use a tarball as an _extra file_ for a test-suite unless you -have a very good reason for this: if you do include a tarball as an _extra file_, -then you **MUST** specify why in your `remarks.md` file. - -If you **DO** include a tarball an _extra file_, and the build process or the program extracts -said tarball(s), the make `clobber` rule **MUST** remove the extracted files. - -Instead of including a large test-suite that requires a lot of files as part of your submission, -and your submission doesn't require the test-suite to be available to run, -then in your `remarks.md` a URL where such a test-suite may be downloaded from -and how to use the test-suite to test your submission. - -See FAQ on "[What should I do with the `try.sh` and `try.alt.sh` scripts?](../faq.html#try_scripts)". - -See FAQ on "[What is a `.auth.json` file?](../faq.html#auth_json)". - -See FAQ on "[What is a `.info.json` file?](../faq.html#info_json)". - -See FAQ on "[How can I validate my submission directory?](../faq.html#chksubmit)". - -See FAQ on "[What permissions may my files be and what if I need different permissions?](../faq.html#file_perms)". - -See FAQ on "[What are the detailed recommendations for a submission Makefile?](../faq.html#makefile_details)". - -See FAQ on "[What are the details behind Rule 17 - Packaging?](../faq.html#rule17)". - - -Jump to: [top](#) - - -
          -
          - -# Guidelines for the mkiocccentry toolkit - -The [IOCCC submit server](https://submit.ioccc.org), and related services -use the **most recent version** of the -[mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry): -submissions that package using older versions of the -[mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) -are **LIKELY** to be **REJECTED**! So you **REALLY SHOULD** use the latest [mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) -to package your own submission. - -The `mkiocccentry(1)` tool runs a number of checks by way of these -[mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) tools: - -* iocccsize(1) -* txzchk(1) -* fnamchk(1) -* chksubmit(1) -* chkentry(1) - -Do **NOT** use `txzchk(1)` or `fnamchk(1)` command line options that are labeled -"**for TESTING purposes**" in their respective man pages. - -Similarly do **NOT** use `chkentry(1)` command line options marked "**for the use -by the IOCCC judges only**" in the `chkentry(1)` man page. - -To view [mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) man pages, -while your current directory is the top of the source tree: - -``` -man soup/man/man1/mkiocccentry.1 -man soup/man/man1/iocccsize.1 -man soup/man/man1/txzchk.1 -man test_ioccc/man/man1/fnamchk.1 -man soup/man/man1/chksubmit.1 -man soup/man/man1/chkentry.1 -``` - -The above `man(1)` commands will show the toolkit man pages without having to install them first. - -So that you do not have to repeatedly answer all the `mkiocccentry(1)` questions, -use `mkiocccentry -a answers ...` to create a file containing the answers you first give, -so later enter `mkiocccentry -i answers ...` to reuse those same answers. - -The `mkiocccentry -A answers ..` does the same thing except that the **answers file will be overwritten**. - -The `mkiocccentry -i answers ..` will still be required to confirm "_Yes/No_" questions. -While `mkiocccentry -Y -i answers ..` will force yes answers, use with **great caution**, -because it might force a yes answer to something you do **NOT** want. - -To help with not having to repeatedly enter a UUID, put your UUID into a file and use -`mkiocccentry -u uuidfile ..`, or use `mkiocccentry -U UUID ..` to give the `UUID` -on the command line. - -If you wish to **test** that your submission passes the `mkiocccentry(1)` tests -without having to type in answers each time, you can use the `-d` or `-s seed` -option to `mkiocccentry` for the tool to pseudo-randomly create answers for you. -For example: - -``` -mkiocccentry -d workdir topdir -``` - -Do **NOT** submit a tarball formed by `mkiocccentry -d ..`, **NOR** by `mkiocccentry -s seed ..`! - -The `mkiocccentry(1)` tool creates an `xz(1)` compressed **v7 format** tarball using a `tar(1)` -command of the form: - -``` -cd workdir/UUID-slot_num && tar --format=v7 -cJf submit.UUID-slot_num.timestamp.txz UUID-slot_num -``` - -In many places the `mkiocccentry(1)` tool will prompt you to verify what you input, allowing you to -correct details as you go along. - -Pressing the "_enter key_" `mkiocccentry(1)` tool prompts will allow you to proceed with a default, -however make sure the default is the **CORRECT** answer. - -The `mkiocccentry(1)` tool will use code from `iocccsize(1)` which detects a number of -issues (such as [Rule 2 - Size](rules.html#rule-2---size)) that you may ignore, -however ignoring such issues **comes with a significant level of risk** as noted else where. - -Once the tarball is packaged it will -run `txzchk(1)`, which will also run `fnamchk(1)`, as part of its algorithm. - -The use of `mkiocccentry -W ...` is **highly discouraged** as this may ignore -warnings about a problem that may cause your submission to be **REJECTED!**" - -If `mkiocccentry` encounters an **error**, the program will exit and the xz -compressed tarball **will NOT be generated**: this is a **feature, not a bug**! - -If you encounter a **bug** with the -[mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) -**PLEASE run the `bug_report.sh` script to help us out here!** - -While you don't have to install the -[mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry), -then in order to run a tool outside the repo directory -you will have to specify `mkiocccentry(1)` command line options to locate required tools -such as `chkentry(1)` (`mkiocccentry -C chkentry ..`), `txzchk(1)` (`mkiocccentry -T txzchk ..`), -and `fnamchk(1)` (`mkiocccentry -F fnamchk ..`). - -The `mkiocccentry(1)` tool will ignore any filename or directory that begins with a period (`.`). - -The `mkiocccentry(1)` tool will ignore all files that begin with `COPYING`, `COPYRIGHT`, and `LICENSE`, regardless -of filename case. - -The `mkiocccentry(1)` tool will any of the following files if they are found directly under -the top level directory (`topdir`): - -* README.md -* index.html -* prog -* prog.alt -* prog.alt.o -* prog.orig.c -* filenames matching the `[0-9][0-9][0-9][0-9]_*.tar.bz2` file glob - -The files listed in the above list are allowed to exist in sub-directories: just **NOT** directly under -the top level directory (`topdir`). - -The `mkiocccentry(1)` tool evaluates all filenames and directory names in a case independent way: -this `FOO`, `Foo`, and `foo` are treated as the **SAME** file even if your filesystem doesn't. - -Having two or more filenames that differ only by case **WILL** lead to problems because of the previous statement. - -When the `mkiocccentry(1)` tool ignores a file, that file is **NOT** included as part of your submission. - -When the `mkiocccentry(1)` tool ignores a directory, that directory, -and everything under that directory is **NOT** included as part of -your submission. - -The `mkiocccentry(1)` tool will ignore all symlinks. - -Creating a directory directly under the top level directory (`topdir`) -that is normally considered to be a regular file, such as a directory -named `Makefile`, `prog.alt.c`, `prog.c`, `remarks.md`, `try.alt.sh`, -or `try.sh` is **NOT** a good idea and will likely cause the -`mkiocccentry(1)` tool to abort with a **fatal error**. - -The required `Makefile`, `remarks.md` file may **NOT** be an empty file. - -If the optional file `try.alt.sh`, or `try.sh` exits and is an empty file, -the `mkiocccentry(1)` tool to abort with a **fatal error**. - -If the `mkiocccentry(1)` tool encounters anything that isn't a file, isn't a directory, -and isn't a symlink (which the tool ignores), the `mkiocccentry(1)` tool to abort with a **fatal error**. - -See FAQ on "[How do I report bugs in an `mkiocccentry` tool?](../faq.html#mkiocccentry_bugs)". - -See [Rule 11 - Abuse](rules.html#rule-11---abuse) for warnings about ignoring `mkiocccentry(1)` tool warnings. - -See FAQ on "[What is the `fnamchk` tool?](../faq.html#fnamchk)". - -See FAQ on "[What is mkiocccentry in simple terms?](../faq.html#about_mkiocccentry)". - -See FAQ on "[What is the mkiocccentry tool, how do I obtain it and how do I use it](../faq.html#mkiocccentry)". - - -Jump to: [top](#) - - -
          - -# General Overall Guidelines - -These [guideline](guidelines.html) are **hints** and **suggestions**, **NOT** [IOCCC rules](rules.html). - -While submissions that violate [guideline](guidelines.html) are allowed, -submissions that remain within the [IOCCC guidelines](guidelines.html) are preferred. - -You are encouraged to review the following [FAQs](../faq.html): - -* [How to enter the IOCCC](../quick-start.html#enter) - -* [Obtaining and compiling the most recent mkiocccentry toolkit](../faq.html#mkiocccentry) - -* [How to upload your submission](../next/submit.html) - -While the contest is **[open](../faq.html#open)**, you may modify your -previously uploaded submission by rebuilding your submission with the -[mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry), -and then re-uploading it to **the same slot number** on the -[submit server](https://submit.ioccc.org). - -The **official locale** of the **IOCCC** is **C**. - -You are **encouraged** to examine the [winners of previous contests](../years.html). - -Because [rules](rules.html) change from year to year, some [winning entries](../years.html) -of the past may be rejected this year. - -What was _was_ unique and novel one year _might be 'old' the next year_. - -A submission is usually examined in a number of ways. We typically apply -a number of tests to a submission: - -* look at the original source -* C pre-process the source ignoring `#include` lines -* C pre-process the source ignoring `#define` _and_ `#include` lines -* run it through a C beautifier (such as `clang-format(1)`) -* examine the algorithm -* compile it (with flags to enable all warnings) -* execute it - -You should consider how your submission looks in each of the above tests. -You should ask yourself if your submission remains obscure after it has been -'_cleaned up_' by the C pre-processor and a C beautifier. - -Your submission need not pass all of the above tests as in certain cases, -a test is not important. - -Submissions that compete for the -'**strangest/most creative source layout**' need not do as well as -others in terms of their algorithm. - -Given two submissions, we are more inclined to pick the submission that -does something interesting when it's executed. - -**IMPORTANT:** Be sure that **your submission works** as documented in your `remarks.md` file. - -We sometimes make an effort to debug a submission -that has a slight problem, particularly in or near the final round. -On the other hand, we have seen some otherwise excellent submissions -fall down because they didn't work as documented. - -If you submission has bugs and/or mis-features, you are **MUCH BETTER** off -documenting such bugs and/or mis-features in your `remarks.md` file. - -Consider an example of a [prime number](https://en.wikipedia.org/wiki/Prime_number) -printing program that claims that 16 is a prime number. -Noting such a bug in your `remarks.md` file could save your submission: - -> "_this submission sometimes prints the 4th power of a prime by mistake_" - -Sometimes a strange bug or (mis-)feature can even help the submission! Of course, a correctly -working submission might be better. - -We tend to look down on a -[prime number](https://en.wikipedia.org/wiki/Prime_number) -printer that claims that 16 is a prime number. -Clever people will note that 16 might be prime under certain conditions. ;-) -Wise people, when submitting something clever -will **fully explain such cleverness** in their submission's `remarks.md` file. - -People who are considering to just use some complex mathematical -function or state machine to spell out something such as "_hello, -world!_" **really really, _and we do mean REALLY_, do need to be more creative**. - -Consider using misleading or subtle tricks layered on top of or under -an appropriate level of obfuscation. - -A clean looking program with -misleading comments and variable names might be a **VERY GOOD START** -to a great submission! - - -Jump to: [top](#) - - -
          -
          - -# OUR LIKES AND DISLIKES: - -We **VERY MUCH LIKE** submissions that use an edited variant of the -example Makefile, as described and linked to in the [Makefile section](#makefile), -renamed as `Makefile` of course. This makes it easier for the [IOCCC judges](../judges.html) -to test your submission. And if your submissions wins, it makes it easier to integrate it into -the [Official IOCCC winner website](https://www.ioccc.org/index.html). - -We **VERY MUCH LIKE** submissions that have some educational value. This does **NOT** mean -that your submission should not be obfuscated but rather that the IOCCC has moved away from -the idea of "spoilers". You should not encrypt or rot13 content in your `remarks.md` file. - -It is **VERY MUCH** appreciated if your remarks have some educational -value. And although educational value is not required, it is an -**EXCELLENT** bonus. - -We **LIKE** submissions that use an edited version of the -`try.sh` example script (and if you have alternate code, -the same applies with the `try.alt.sh` script): - -- [view example try.sh](%%REPO_URL%%/next/try.sh) -- download example try.sh - -- [view example try.alt.sh](%%REPO_URL%%/next/try.alt.sh) -- download example try.alt.sh - -Of course, it is quite possible that only one invocation is -possible, so it is not necessarily detrimental to your submission if you do not -include one, though we do like interesting and creative uses of submissions. See -also the -FAQ on "[submitting try.sh and try.alt.sh scripts](../faq.html#try_scripts)". - -

          -Even if it only has one invocation we still **LIKE** the try scripts. -

          - -

          -If you do include a `try.sh` then **PLEASE** remove the `try` rule in the Makefile. -

          - -

          -If you do include a `try.alt.sh` then **PLEASE** remove the `try.alt` rule in the Makefile. -

          - -

          -If you don't have a prog.alt.c, then **PLEASE** remove the `try.alt` rule as well. -

          - -Doing masses of `#define`s to obscure the source has become 'old'. We -tend to 'see thru' masses of `#define`s due to our pre-processor tests -that we apply. Simply abusing `#define`s or `-Dfoo=bar` won't go as far -as a program that is more well rounded in confusion. - -**Many** C compilers **DISLIKE** the following code, and so do we: - -``` - #define d define - #d foo /* <-- don't expect this to turn into #define foo */ -``` - -In other words, it is a compilation error, and in order to get older -IOCCC winning entries that did this to compile, we had to update them to not do this. - -When declaring local or global variables, you should declare the type: - -``` - int this_is_fine; - this_is_not; /* <-- Try to avoid implicit type declarations */ -``` - -We tend to **like _less_** a submission that requires either -`gcc` **OR** `clang`. **We _prefer_ submissions** that can compile -under **BOTH** `gcc` **AND** `clang`. **Hint!** - -We **RECOMMEND** that the compiler flags you use in your -submission's `Makefile` are supported by **BOTH** `gcc` **AND** `clang`. - -We **DISLIKE** the use of obscure compiler flags, especially -if `gcc` and/or `clang` do not support it. We **suggest** -that you not use any really obscure compiler flags if you can help it. - -One side effect of the above is that you cannot assume the use -of nested functions such as: - -``` - int main() { -| void please_dont_submit_this() { -| printf("The machine that goes BING!!\n"); - } -| please_dont_submit_this(); - } -``` - -On 2012 July 20, the [IOCCC judges](../judges.html) rescinded the encouragement of -nested functions. Such constructions, while interesting and sometimes -amusing, will have to wait until they are required by a C standard that are -actually implemented in **BOTH** `gcc` **AND** `clang`. - -We **DISLIKE** submissions that require the use of `-fnested-functions`. - -If your submission uses functions that have a variable number of -arguments, **be careful**. Systems implement `va_list` in a wide variety -of ways. Because of this, a number of operations using `va_list` **are -not portable and _must not_ be used**: - -* assigning a non-`va_list` variable to/from a `va_list` variable -* casting a non-`va_list` variable into/from a `va_list` variable -* passing a `va_list` variable to a function expecting a non-`va_list` arg -* passing a non-`va_list` variable to a function expecting a `va_list` arg -* performing arithmetic on `va_list` variables -* using `va_list` as a structure or union - -In particular, do not treat `va_list` variables as if they were a `char **`. - -We **DISLIKE** the use of `varargs.h`. Use `stdarg.h` instead. - -We **DISLIKE** the use of `gets(3)`. Use `fgets(3)` instead. - -We tend to **DISLIKE** the blatant use of tarballs in an attempt to simply get -around the extra file number limit. We realize there may be cases where a -tarball containing a number of extra files may be needed. Such a need for a -tarball **MUST** be explained in the `remarks.md` file. - -

          -Using a mass of `goto`s to obfuscate your code has become 'old' and is unlikely -to make it through the final rounds, if it even gets that far. -

          - -On 28 January 2007, the Judges rescinded the requirement that the -`#` in a C preprocessor directive must be the 1st non-whitespace byte. - -The `exit(3)` function returns `void`. Some broken systems have `exit(3)` -return `int`; your submission should assume that `exit(3)` returns a `void`. - -Small programs are best when they are short, obscure and concise. -While such programs are not as complex as other winners, they do -serve a useful purpose: they are often the only program that people -attempt to completely understand. For this reason, we look for -programs that are compact, and are instructional. - -One line programs should be short one line programs: say around **80** to **132** -bytes long. Going well beyond **132** bytes is a bit too long to be called -a one-liner in our vague opinion. - -We tend to **DISLIKE** programs that: - -* are very hardware specific -* are very OS version specific (`index(3)`/`strchr(3)` differences are OK, but -sockets/streams specific code is likely not to be) -* dump core or have compiler warnings (it is OK only if -you warn us in your `remarks.md` file) -* won't compile or run in a [Single UNIX -Specification](https://en.wikipedia.org/wiki/Single_UNIX_Specification) -environment -* depend on a utility or application not normally found -in systems that conform to the [Single UNIX -Specification](https://en.wikipedia.org/wiki/Single_UNIX_Specification) -* abuse the build file to get around the size limit -* obfuscate by use of ANSI trigraphs -* obfuscate by use of digraphs -* are larger than they need to be -* have more lines than they need to have -* are "blob-ier" (just a pile of unformatted C code) than they need to be -* are rather similar to **[previous winners](../years.html)** :-( -* are **identical** to **[previous losers](https://en.wikipedia.org/wiki/Null_device)** :-) -* that mandate the exclusive use of a specific Integrated Development Environment (IDE) - -In order to encourage submission portability, we **DISLIKE** submissions that -fail to build unless one is using an IDE. For example, do not -mandate that one must use Microsoft Visual Studio to compile -your submission. - -The program must compile and link cleanly in a [Single UNIX -Specification](https://en.wikipedia.org/wiki/Single_UNIX_Specification) -environment. Therefore do not assume the system has a -[windows.h](https://en.wikipedia.org/wiki/Windows.h) include file: - - -``` - #include /* we DISLIKE this */ -``` - -Unless you are cramped for space, or unless you are entering the -'**Best one liner**' category, we suggest that you format your program -in a more creative way than simply forming excessively long lines. - -The `Makefile` should not be used to try and get around the size limit. It is -one thing to make use of a several `-D`s on the compile line to help out, but it -is quite another to use many bytes of `-D`s in order to try and squeeze the -source under the size limit. - -Your source code, post-pre-processing, should not exceed the size of -[Microsoft Windows](https://en.wikipedia.org/wiki/Microsoft_Windows). :-) - -You should try to restrict commands used in the build file to commands found in -[Single UNIX -Specification](https://en.wikipedia.org/wiki/Single_UNIX_Specification) -environments and systems that conform to the [Single UNIX -Specification](https://en.wikipedia.org/wiki/Single_UNIX_Specification). - -You may compile and use your own programs. If you do, try to build and execute -from the current directory. This restriction is not a hard and -absolute one. The intent is to ensure that the building of your -program is reasonably portable. - -We prefer programs that are portable across a wide variety of UNIX-like -operating systems (e.g., Linux, GNU Hurd, BSD, UNIX, etc.). - -Don't forget that the building of your program should be done -**WITHOUT human intervention**. So don't do things such as: - -``` - prog: prog.c - #echo this next line requires data from standard input - cat > prog.c - ${CC} prog.c -o prog -``` - -However, you can do something cute such as making your program -do something dumb (or cute) when it is built 'automatically', and -when it is run with a human involved, do something more clever. -For example, one could put in their `Makefile`: - -``` - prog: prog.c - ${CC} prog.c -DNON_HUMAN_COMPILE -o prog - @echo "See remarks section about alternate ways to compile" -``` - -and then include special notes in your `remarks.md` file for -alternate / human intervention based building. - -We want to get away from source that is simply a compact blob of -bytes. **REALLY TRY** to be more creative than blob coding. **HINT!** - -Please do not use things like `gzip(1)` to get around the size limit. -Please try to be much more creative. - -We really **DISLIKE** submissions that make blatant use of including -large data files to get around the source code size limit. - -Did we remember to indicate that programs that blatantly use -some complex state machine to do something simple, are boring? -We think we did. :-) - -Given two versions of the same program, one that is a compact blob -of code, and the other that is formatted more like a typical C -program, we tend to favor the second version. Of course, a third -version of the same program that is formatted in an interesting -and/or obfuscated way, would definitely win over the first two! -Remember, you can submit more than one submission. See the -[IOCCC rules](rules.html) -for details (in particular, -[Rule 8 - Submission](rules.html#rule-8---submission)). - -We suggest that you avoid trying for the '**smallest self-replicating**' -source. The smallest, a [zero byte entry](../1994/smr/index.html), won in -[1994](../years.html#1994). - -Programs that claim to be the smallest C source that does something, really -better be the smallest such program or they risk being rejected because -they do not work as documented. - -Please note that the C source below, besides lacking in obfuscation, -is **NOT** the smallest C source file that when compiled and run, dumps core: - -``` - main; -``` - -Unless you specify `-fwritable-strings` (see `COTHER` in the example -Makefile, described in the [Makefile section](#makefile)), do not assume this -sort of code will work: - -``` - char *T = "So many primes, so little time!"; - ... - T[14] = ';'; /* modifying a string requires: -fwritable-strings */ -``` - -Even so, one should probably not assume that this is universally accepted. - -Initialized char arrays are OK to write over. For instance, this is OK: - -``` - char b[] = "Is this OK"; - b[9] = 'k'; /* modifying an initialized char array is OK */ -``` - -X client submissions should be as portable as possible. Submissions that -adapt to a wide collection of environments will be favored. For -example, don't depend on a particular type or size of display. -Don't assume the use of a particular browser. Instead assume a -generic browser that forms to a widely used [W3C -standard](https://www.w3.org/standards/). -Don't assume a particular sound sub-system or video driver is installed -in the OS. Instead, make use of a well known and widely available open -source program (one that actually works) to display audio/visual data. - -X client submissions should avoid using X related libraries and -software that are not in wide spread use. - -As of Red Hat RHEL9.0, the X.org server is deprecated. See the -FAQ on "[Xorg deprecation"](../faq.html#Xorg_deprecated)" -for more details. This does not mean that a submission using this will -necessarily be rejected, but it would be better if it can support Wayland in -some way or another. - -We **DISLIKE** submissions that use proprietary toolkits such as the `M*tif`, -`Xv*ew`, or `OpenL*ok` toolkits, since not everyone has them. Use an -open source toolkit that is widely and freely available instead. - -X client submissions should try to not to depend on particular items in -`.Xdefaults`. If you must do so, be sure to note the required lines -in the your `remarks.md` file. They should also not depend on any -particular window manager. - -Try to avoid submissions that play music that some people believe is copyrighted -music. - -While we recognize that UNIX is not a universal operating system, the contest -does have a bias towards such systems. In an effort to expand the scope of the -contest, we phrase our bias to favor the [Single UNIX -Specification](https://en.wikipedia.org/wiki/Single_UNIX_Specification). - -You are **well advised** to submit code that conforms to the [Single UNIX -Specification Version 4](https://unix.org/version4/overview.html). - -To quote the [IOCCC judges](../judges.html): - -We **LIKE** programs that: - -* are as concise and small as they need to be -* do something at least quasi-interesting -* are portable -* are unique or novel in their obfuscation style -* make use of a **NUMBER OF DIFFERENT TYPES OF OBFUSCATIONS!** **<== HINT!!** -* make us laugh and/or throw up :-) (humor really helps!) -* make us want to eat good chocolate - -Some types of programs can't excel (anti-tm) in some areas. Your -program doesn't have to excel in all areas, but doing well in several -areas really does help. - -You are better off explaining what your submission does in your -`remarks.md` file section rather than leaving it obscure for the -[IOCCC judges](../judges.html) as we might miss something and/or be too tired to -notice. - -We freely admit that interesting, creative or humorous comments in -your `remarks.md` file help your chances of winning. If you had to -read so many twisted submissions, you too would enjoy a good laugh or two. -We think the readers of the contest winners do as well. We do read -your `remarks.md` content during the judging process, so it is worth your -while to write a remarkable `remarks.md` file. - -We **DISLIKE** C code with trailing control-M's (`\r` or `\015`) that results -in compilation failures. Some non-UNIX/non-Linux tools such as -MS Visual C and MS Visual C++ leave trailing control-M's on lines. -Users of such tools should strip off such control-M's before submitting -their submissions. In some cases tools have a "Save As" option that will -prevent such trailing control-M's being added. - -One should restrict libcurses to portable features found on both BSD -and Linux curses. - -

          -If you do `#include ` make **CERTAIN** you link in curses (i.e. -`-lcurses`) and not ncurses (i.e. `-lncurses`). -

          - -[Rule 13 - Newlines](rules.html#rule-13---newlines) -no longer discourages the use of UTF-8 -characters in C code. - -It is a very good idea to, in your `remarks.md` file, tell us why you -think your submission is obfuscated. This is particularly true if -your submission has some very subtle obfuscations that we might -otherwise overlook. **<<-- Hint!** - -Anyone can format their code into a dense blob. A really clever -author will try format their submission using a "normal" formatting style -such that at first glance (if you squint and don't look at the details) -the code might pass for non-obfuscated C. Deceptive comments, -and misleading formatting, in some cases, may be a plus. On the -other hand, a misleading code style requires more source bytes. - -If you do elect to use misleading formatting and comments, we -suggest you remark on this point in your `remarks.md` where you talk -about why you think your submission is obfuscated. On the other hand, -if you are pushing up against the size limits, you may be forced -into creating a dense blob. Such are the trade-offs that obfuscators face! - -We prefer code that can run on either a 64-bit or 32-bit -processor. However, it is **UNWISE **to assume it will run on an -some Intel-like x86 architecture**. - -While programs that only run in a specific word size are OK, if you have -to pick, choose a 64-bit word size. - -If your submission **MUST** run only on a 64-bit or 32-bit architecture, -then you **MUST** specify the `-arch` on your command line -(see `ARCH` in the example -Makefile, described in [Makefile section](#makefile)). Do not assume a -processor word size without specifying `-arch`. For example: - -``` - ARCH= -m64 -``` - -Note, however, that some platforms will not necessarily support some -architectures. For instance, more recent versions of `macOS` do **NOT** support -32-bit! - -If there are limitations in your submission, you are highly encouraged -to note such limitations in your `remarks.md` file. For example if your -submission factors values up to a certain size, you might want to state: - -> This submission factors values up `2305567963945518424753102147331756070`. -Attempting to factor larger values will produce unpredictable results. - -The [IOCCC judges](../judges.html) might try to factor the value -5, so you want to might state: - -> This submission factors positive values up -`2305567963945518424753102147331756070`. Attempting to factor large values will -produce unpredictable results. - -However the [IOCCC judges](../judges.html) might try to also factor 0, so you want to might state: - -> This submission factors values between 1 and -`2305567963945518424753102147331756070`. Attempting to factor values outside -that range will produce unpredictable results. - -Moreover they might try to also factor 3.5 or 0x7, or Fred, so you want to might state: - -> This submission factors integers between 1 and -`2305567963945518424753102147331756070`. Attempting to factor anything else -will produce unpredictable results. - -You submission might be better off catching the attempt to factor bogus values -and doing something interesting. So you might want to code accordingly and state: - -> This submission factors integers between 1 and `2305567963945518424753102147331756070`. -> Attempting to factor anything else will cause the program to insult your pet fish Eric. - -The [IOCCC judges](../judges.html) might not have a pet fish named Eric, so you might want to state: - -> This submission factors integers between 1 and -`2305567963945518424753102147331756070`. Attempting to factor anything else -will cause the program to insult your pet fish Eric, or in the case that you -lack such a pet, will insult the pet that you do not have. - -When all other things are equal, a submission with fewer limitations will be judged -better than a submission with lots of limitations. So you might want to code accordingly -and state: - -> This submission attempts to a factor value of any size provided that the -program is given enough time and memory. If the value is not a proper integer, -the program might insult a fish named Eric. - -We **DISLIKE** the use of ASCII tab characters in markdown files, such as in the required `remarks.md` file. - -We don't mind the use of ASCII tab characters in your C code. Feel free -to use ASCII tab characters if that suits your obfuscation needs. If is -perfectly **OK** to use tab characters elsewhere in your submission, just not in -markdown files as this tends annoy us when it comes time to -rendering your markdown content as it complicates the process. - -If you do use ASCII tab characters in your non-markdown files, be -aware that some people may use a tab stop that is different than the common 8 -character tab stop. - -**PLEASE** observe our [IOCCC markdown guidelines](../markdown.html) -when forming your submission's `remarks.md` file. And if your submission -contains additional markdown files, please follow those same guidelines for -those files. See also -[Rule 4 - Files](rules.html#rule-4---files), -and the -FAQ on "[markdown](../faq.html#markdown)". - -We **LIKE** reading `remarks.md` files, especially if they contain -useful, informative, and even humorous content about your submission. Yes, this -is a **hint**. :-) - -We **RECOMMEND** you put a reasonable amount effort into the content of the -`remarks.md` file: it is a required file for a reason. :-) - -Try to be even more creative! - - -Jump to: [top](#) - - -
          - -# Fun😄damental Guidelines - -The reason for the times of day are so that key IOCCC events are **calculated** -to be a **fun**ctional UTC time. :-) - -At least 2 of several reasons for selecting the prime, 2503, for -[Rule 2b - Net Size](rules.html#rule-2b---net-size) -may be found on the ["Curios!" about 2503](https://t5k.org/curios/page.php/2503.html). - -The 2503 value for [Rule 2b - Net](rules.html#rule-2b---net-size) is a decimal anagram -of the number of the kernel disk pack of one of the judge's [BESM-6](https://en.wikipedia.org/wiki/BESM-6). - -There may or may not be fewer than 2^7+1 reasons why these [IOCCC -guidelines](guidelines.html) seem obfuscated. - -Excessively "_dotty"_ use of the `chksubmit(1)` or `chkentry(1)` commands suggests that -either like silly things, or that you "_RTFS"_ with some level of care. - -Some people might question what actually constitutes a valid JSON file, given -the state of the "_so-called_" JSON spec.. :-) - -We prefer programs that do not require a fish license: crayons and -cat detector vans not withstanding. - -

          -This _guideline_ has a change mark at the very start of this line. -

          - -While those who are used to temperatures found on [dwarf -planets](https://science.nasa.gov/dwarf-planets/) -(**yes Virginia, dwarf planets _ARE_ planets!**), such as -[Pluto](https://science.nasa.gov/dwarf-planets/pluto/), might be able to -explain to the Walrus why our seas are boiling hot, the question of -whether pigs have wings is likely to remain a debatable point to most. - -At least one judge prefers to maintain the use of the -[leap-second](https://en.wikipedia.org/wiki/Leap_second) -as part of the world's time standard. If your code prints time -with seconds, we prefer that your code be capable of printing the -time of day during a leap-second where the value in seconds -after the minute mark is **60**. - -Other windows, on the other hand, might be OK: especially where "**X -marks the spot**". Yet on the third hand, windows are best when they are -"unseen" (i.e., not dirty). :-) - -The [IOCCC judges](../judges.html), as a group, have a history giving wide degree of latitude -to reasonable submissions. And recently they have had as much longitudinal -variation as it is possible to have on [Earth](https://science.nasa.gov/earth/). :-) -Other windows, on the other hand, might be OK: especially where "**X -marks the spot**". Yet on the third hand, windows are best when they are -"unseen" (i.e., not dirty). :-) - -The [IOCCC judges](../judges.html), as a group, have a history giving wide degree of latitude -to reasonable submissions. And recently they have had as much longitudinal -variation as it is possible to have on [Earth](https://science.nasa.gov/earth/). :-) - -> You are in a maze of twisty _guidelines_, all different. - -There are at least zero [IOCCC judges](../judges.html) who think that -[Fideism](https://en.wikipedia.org/wiki/Fideism) has little -or nothing to do with the IOCCC judging process. - -> All generalizations are false, including this one. -- **Mark Twain** - -

          -There are more than about 1 typos in this very sentence. -

          - -This could be the only _guideline_ that contains the word -[fizzbin](https://en.wikipedia.org/wiki/List_of_games_in_Star_Trek#Fizzbin). - -However, do you know how to play [fizzbin](https://en.wikipedia.org/wiki/List_of_games_in_Star_Trek#Fizzbin)? -You do?!? (Except on Tuesday?) - -OK, there are actually 2 _guidelines_ that contain the word -[fizzbin](https://en.wikipedia.org/wiki/List_of_games_in_Star_Trek#Fizzbin), -unless you count this one, in which case there are 3. :-) - -**NOTE**: The previous _guideline_ in this spot has been replaced by this _guideline_: - -

          -> You very well might not be completely prohibited from failing to not partly -misunderstand this particular _guideline_, but of course, we could not possibly -comment! :-) Nevertheless, you are neither prohibited, nor are you fully or partly -required to determine that this or the previous sentence is either false and/or -perhaps misleading. Therefore, it might be wise for you to not fail to consider -to not do so, accordingly. Thank you very much (allegedly). -

          - -Any complaints about the above _guideline_ could be addressed to the -Speaker of the House of Commons, or to the speaker of your national -parliament should you have one. - -

          -Please try to avoid this specific individual _guideline_, if it at all possible. -

          - -We believe that Mark Twain's quote: - -> Get your facts first, then you can distort them as you please. - -... is a good motto for those writing code for the IOCCC. - -

          -We do not recommend submitting [systemd](https://systemd.io) source code to the IOCCC, -if nothing else because that code is likely to exceed -[Rule 2 - Size](rules.html#rule-2---size). -This isn't to say that another highly compact and obfuscated -replacement of `init(8)` would not be an interesting submission. -

          - -

          -The -[mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) -is not an original work, unless you one of the -[several mkiocccentry toolkit contributors](https://github.com/ioccc-src/mkiocccentry/graphs/contributors). -in which case it is original! :-) -

          - -If the [IOCCC judges](../judges.html) are feeling ornery we -might choose to compile your program for running on an Arduino or -a PDP-11. Heck, should we ever find an emulator of 60-bit CDC Cyber -CPU, we might just try your submission on that emulator as well :-) - -Do not fear if you're not 100% sure of the significance of -`2305567963945518424753102147331756070` as it is not of prime importance: or is -it? :-) - - -Jump to: [top](#) - - -
          -
          - -# FOR MORE INFORMATION: - -For questions or comments about the contest, see [Contacting the IOCCC](../contact.html). - -**Be SURE** to review the [IOCCC Rules and Guidelines](index.html) as they -may (and **often do**) change from year to year. - -**PLEASE** be sure you have the current [IOCCC rules](rules.html) and -[IOCCC guidelines](guidelines.html) prior to submitting to the contest. - -See the [Official IOCCC website news](../news.html) for additional information. - -For the updates and breaking IOCCC news, you are encouraged to follow -the [IOCCC on Mastodon](https://fosstodon.org/@ioccc). See our -FAQ on "[Mastodon](../faq.html#try_mastodon)" -for more information. Please do note that unless -you are mentioned by us you will **NOT** get a notification from the app _so you -should refresh the page **even if you do follow us**_. - -Check out the [Official IOCCC winner website](https://www.ioccc.org/index.html) in general. - -Consider joining the IOCCC discord community via this link: -[https://discord.gg/Wa42Qujwnw](https://discord.gg/Wa42Qujwnw) - -See the -FAQs on "[obtaining, compiling, installing and using the mkiocccentry tools](../faq.html#mkiocccentry)" -and the -FAQ on "[how to enter the IOCCC](../quick-start.html#enter)" -as that FAQ has important details on -[how to register](../next/register.html) -as well as -[how to upload your submission](../next/submit.html) for the IOCCC. - - -
          - - -Jump to: [top](#) + + diff --git a/next/rules.html b/next/rules.html index 7af92541f..9792fe77b 100644 --- a/next/rules.html +++ b/next/rules.html @@ -474,60 +474,80 @@ app from time to time to view IOCCC mastodon updates.

          29th International Obfuscated C Code Contest Official Rules

          -

          Copyright © 2025 Leonid A. Broukhis and Landon Curt Noll.

          +

          Copyright (c) 2025 Leonid A. Broukhis and Landon Curt Noll.

          All Rights Reserved. Permission for personal, education or non-profit use is granted provided this copyright and notice are included in its entirety and remains unaltered. All other uses MUST receive prior permission in writing by contacting the judges.

          Rules Version

          -

          These IOCCC Rules are version 29.08 2025-11-28.

          -

          Be sure to read the IOCCC guidelines.

          +

          These IOCCC Rules are version 29.09 2025-11-29.

          +

          Reminder: be SURE to read the IOCCC guidelines.

          Rule 0 - Dates

          -

          This IOCCC runs from 2025-12-03 20:25:12.045045 UTC to 2026-03-13 17:19:23.293137 UTC.

          -

          This contest will enter the pending state on 2025-12-03 20:25:12.045045 UTC, +

          This IOCCC runs from 2025-12-03 20:25:12.045045 UTC to 2026-03-13 17:19:23.293137 UTC.

          +

          This contest will enter the pending state on 2025-12-03 20:25:12.045045 UTC, allowing people to register for the IOCCC.

          -

          This contest will enter the open state on 2025-12-15 18:21:24.273033 UTC, +

          This contest will enter the open state on 2025-12-15 18:21:24.273033 UTC, allowing people to upload submissions to the IOCCC submit server.

          -

          This contest will enter the judging state on 2026-03-13 17:19:23.293137 UTC, +

          This contest will enter the judging state on 2026-03-13 17:19:23.293137 UTC, when people will no longer be allowed to upload submissions.

          Until the contest enters the open state, any or all of the above dates and times may change AT ANY TIME!

          The above timestamps are in “YYYY-MM-DD HH:MM:SS.micros UTC” format.

          -

          See Current status of the IOCCC.

          +

          See the current status of the IOCCC.

          -

          Rule 1 - Program

          +

          Rule 1 - C program

          -

          Your submission MUST be a C program.

          +

          Your submission MUST be a C program that does NOT #include data files.

          -

          Rule 2 - Size

          +
          +
          +
          +

          Rule 2 - Size restrictions

          +
          +
          +

          Rule 2 requires that your submission satisfy BOTH -Rule 2a Gross Size +Rule 2a (Gross Size) and -Rule 2b Next Size. +Rule 2b (Net Size). During development this can be checked using iocccsize(1):

          -

          iocccsize prog.c

          -

          See Guidelines for Rule 2 - Size.

          +
              iocccsize prog.c
          +

          See the Guidelines for Rule 2 - Size restrictions.

          +
          +

          Rule 2a - Gross Size

          +
          +

          The overall maximum size of your prog.c program source MUST NOT exceed 4993 bytes.

          +

          NOTE: by default iocccsize will only report the rule 2b size, unless the +code surpasses the limit.

          See Entering the IOCCC: the bare minimum you need to know.

          +
          +

          Rule 2b - Net Size

          +
          +

          When the filename of your program source (i.e., prog.c) is given as a command line argument to the latest version of the official IOCCC size tool (hereby referred to as iocccsize(1)), the value printed MUST NOT exceed 2503.

          +

          NOTE: iocccsize does NOT calculate the filename length. See Rule 17 - +Use mkiocccentry.

          -

          Rule 3 - Register

          +
          +

          Rule 3 - Register for the IOCCC

          +

          You MUST register, using a valid email address, in order to submit -entries to the IOCCC. You may register while the contest is pending or open.

          +to the IOCCC. You may register while the contest is pending or open.

          A few days after registering, you’ll receive your UUID username and temporary password, which you MUST change within 14 days. If you fail to change it in a timely manner, you’ll need to @@ -538,38 +558,53 @@ register and submit your entries; DO NOT WAIT UNTIL THE FINAL DAYSNOT responsible for delayed or lost email or for those who wait until the last minute to try to register!

          See Entering the IOCCC: the bare minimum you need to know.

          -

          See Rule 8 - Submission.

          -

          See Guidelines for Rule 3 - Register.

          +

          See Rule 8 - Submitting requirements.

          +

          See Guidelines for Rule 3 - Register for the IOCCC.

          -

          Rule 4 - Files

          +
          +

          Rule 4 - Required files

          -

          The submission MUST include at least these files: Makefile, prog.c, -remarks.md,.info.json, and .auth.json.

          -

          At a minimum the following requirements apply. Additional requirements +

          +

          Your submission MUST include at least these files: Makefile, prog.c, +remarks.md,.info.json, and .auth.json, the latter two of which are +generated by mkiocccentry(1). See Rule 17 - +Use mkiocccentry.

          +

          At a minimum the following requirements apply. Additional requirements may be imposed by mkiocccentry(1) updates that have yet to be listed -here:

          +below.

          +

          NOTE: mkiocccentry(1) will reject any directory which has prohibited +files.

          +

          NOTE: by ‘top directory’ we mean the directory with prog.c, Makefile, +remarks.md and the mkiocccentry(1) generated files .auth.json and +.info.json and NOT the topdir arg to mkiocccentry(1).

            -

          • .info.json, and .auth.json MUST be generated by mkiocccenty(1) -when packing a submission, and MUST pass the chksubmit(1) tests.

            • +

          • .info.json and .auth.json MUST be generated by mkiocccenty(1) +when packing a submission. When chksubmit(1) is run on the submission +directory ALL tests must pass and if there is ANY problem with these +JSON files or if either is missing it will fail. See Rule 17 - use +mkiocccentry.

          • The Makefile, remarks.md,.info.json, and .auth.json MUST -have a file size greater than 0.

            • +have a file size greater than 0 and MUST have content. Note that +mkiocccentry(1) will check for file size but will NOT check for +content.

          • Your submitted source code MUST be called prog.c. When the Makefile compiles your code, the executable (if applicable) MUST be called prog. -The Makefile may compile your source code into other filenames as well.

            • +The Makefile may compile your source code into other filenames as well, if you +want.

          • As prog, prog.alt, prog.alt.o, prog.o may be created by your -Makefile, your submission MUST NOT include those files in -your top directory, as original content.

            • +Makefile, your submission MUST NOT include those files in your top +directory.

          • Your submission may NOT have any file that starts with COPYING, COPYRIGHT, or LICENSE as those files are reserved by IOCCC.

            • -

          • Your submission may NOT have in the top directory, prog.orig.c, -README.md, nor index.html as those files reserved by IOCCC.

            • -

          • Your submission may NOT have in the top directory, any file +

          • Your submission may NOT have in the top directory: prog.orig.c, +README.md or index.html as those files are reserved by the IOCCC.

            • +

          • Your submission may NOT have in the top directory any file that matches a file glob pattern form [0-9][0-9][0-9][0-9]_*.tar.bz2 as those files are reserved by IOCCC.

          • Your submission may ONLY contain files and directories. Other file -types such as symlinks, sockets, etc are NOT allowed.

            • -

          • All directories MUST have a file mode of 0755. All files -MUST have the file mode of 0444, except for files that +types such as symlinks, sockets etc. are NOT allowed.

            • +

          • All directories MUST have permission mode of 0755. All files +MUST have the file mode of 0444, EXCEPT for files that end in .sh which must have a mode of 0555.

          • All files that end in .md MUST be in markdown format. We recommend that markdown files observe our @@ -582,29 +617,35 @@ a case insensitive filesystem.

          The remarks.md and Makefile are explained in more detail in the Guidelines.

          See IOCCC markdown guidelines.

          -

          See Rule 17 - Packaging.

          -

          See FAQ on “What permissions may my files be and what if I need different permissions?”.

          -

          See Guidelines for the mkiocccentry toolkit.

          -

          See Guidelines for the Makefile.

          +

          See Rule 17 - Use mkiocccentry.

          +

          See the +FAQ on “What permissions may my files be and what if I need different permissions?”.

          +

          See the Guidelines on the mkiocccentry toolkit.

          +

          See the +FAQ on “What are the detailed recommendations for a submission Makefile?”.

          -

          Rule 5 - Integrity

          +
          +

          Rule 5 - Do NOT modify submitted files or filenames or parent directories

          -

          Your submission MUST NOT modify the filenames or content of any of -your original submission, such as prog.c, Makefile, or any supplied -data files. To modify files, your program can make a copy or you can -use the Makefile to setup working copies. Any working copies MUST be -cleaned up by the Makefile clobber target, so as to restore the -directory to its original state.

          +
          +

          Your submission MUST NOT modify the filenames or content of any of your +original submission, such as prog.c, Makefile, or ANY other supplied +files. To modify files, your program can make a copy or you can use the +Makefile to setup working copies. Any working copies MUST be cleaned up +by the Makefile clobber target, so as to restore the directory to its +original state.

          Your submission MUST NOT create or modify directories and files -ABOVE the current directory with the exception of the /tmp and the -/var/tmp directories as long as the directory name or filename does -NOT start with “.” (dot).

          -

          The Makefile clobber target MUST be restore your submission into +ABOVE the current directory (with the exception of the /tmp and the /var/tmp +directories and as long as the directory name or filename does NOT start +with a . (dot)).

          +

          The Makefile clobber target MUST restore your submission to its original form, including the removal of any created files and directories.

          Your code should be able to run under a SUS environment.

          -

          Rule 6 - Free

          +
          +

          Rule 6 - Free Rule

          +

          I am NOT a Rule, I am a free(void *human); ‼️

              while (!(ioccc(rule(you(are(number(6)))))) {
@@ -612,84 +653,103 @@ original form, including the removal of any created files and directories.
          
     }

          See Rule 19 - Prime.

          +

          Rule 7 - Original Work

          -

          You, the author(s), MUST own the contents of your submission, or you MUST -have permission from the original owner(s) to its use. If you submit -any content that is owned by others, you MUST detail that ownership, -i.e., who owns what, and document the permission you obtained from them -in your remarks.md file.

          +
          +

          You, the author(s), MUST own the contents of your submission, OR, IF you +do NOT own the work, then you MUST have permission from the original +owner(s) to its use. If you submit ANY content that is owned by others, you +MUST detail that ownership, i.e., who owns what, and document the permission +you obtained from them in your remarks.md file.

          You are permitted to use tools to write your code.

          -

          See Rule 16 - Anonymous.

          +

          See Rule 16 - Anonymous Judging.

          See Guidelines for Rule 7 - Original Work.

          -

          Rule 8 - Submission

          +
          +

          Rule 8 - Submitting requirements

          -

          The Submit Server will only accept submissions from those who have -registered and only while the contest is open.

          -

          The Submit Server places a total submission size limit of 3999971 bytes.

          +
          +

          The submit server will accept submissions ONLY from those who have +registered and ONLY while the contest is open.

          +

          The submit server places a total size limit of 3999971 bytes PER +submission.

          Each account has ten (10.000) submission slots (0..9). Each submission slot should be annotated by the server as to whether its was received, processed, malformed, etc. Please take note of any errors, rectify, and resubmit. In order to avoid potential packaging errors, it is highly -recommended to use mkiocccentry(1).

          +recommended to use mkiocccentry(1), AND to check from time to time the +status on the submit server, to see if any tests run by the server failed to +validate your submission.

          +

          Do NOT register more than one account!

          See -Rule 3 - Register, -Rule 15 - Building, +Rule 3 - Registering for the IOCCC, +Rule 15 - GNU Makefile, and -Rule 17 - Packaging.

          +Rule 17 - Use mkiocccentry.

          -

          Rule 9 - No hands

          +

          Rule 9 - No interactive compiling allowed

          Entries requiring human interaction to be initially compiled are NOT permitted. However, see the guidelines. Each entry MUST automate the -build process using bash, gmake, gcc, clang, under a -SUS environment.

          +build process using bash, gmake, gcc and/or clang and other commonly +available tools under an SUS +environment.

          NOTE: The references to gmake(1) can be any GNU Make compatible tool.

          -

          See Rule 15 - Building.

          +

          NOTE: it is better to use the ${MAKE} variable as then one may override +the make command.

          +

          NOTE: it is better and more portable to NOT modify the ${CC} variable +in the Makefile.

          +

          See Rule 15 - GNU Makefile.

          -

          Rule 10 - Privileges

          +

          Rule 10 - Program file permissions

          Programs that require special privileges (setuid(2), setgid(2), super-user, special owner, special group, etc.) are HIGHLY DISCOURAGED. We do NOT guarantee these functions will behave as you expect on our test platforms. If your program needs special permissions you MUST document this fact and explain why it is needed in your submission’s -remarks.md file.

          +remarks.md file, preferably close to the top.

          Furthermore, if you need a supplementary program that you include to -have these permissions, you will also have to explain this, because these +have these permissions, you will also have to explain this as well, because these bits are NOT allowed in submissions and those bits will NOT be copied by mkiocccentry(1).

          -

          See Rule 4 - Files, +

          See Rule 4 - Required files, and -Rule 5 - Integrity.

          +Rule 5 - Do NOT modify files.

          -

          Rule 11 - Abuse

          + -

          Legal abuse of the rules is somewhat encouraged, but comes with risks. -A submission that, in the opinion of the Judges, violates the rules WILL +

          +

          Legal abuse of the rules is somewhat encouraged, but comes with risks. +A submission that, in the opinion of the Judges, violates the rules WILL BE DISQUALIFIED. Submissions that plan to abuse the rules MUST justify why their rule abuse is legal (or interesting) in the remarks.md file.

          -

          Submission packaging abuse will NOT be tolerated and for this reason -its recommended to use mkiocccentry(1). During development you can -check your prog.c size limits using iocccsize(1), e.g., iocccsize -v1 prog.c. -Overriding problems detected by any of the IOCCC tools +

          Submission packaging abuse will NOT be tolerated and for this reason, +amongst many others, it is recommended that you use mkiocccentry(1). During +development you can check your prog.c size limits using iocccsize(1), e.g., +iocccsize -v1 prog.c. Overriding problems detected by any of the IOCCC tools risks that the submission will be rejected.

          If you do submit a rule abusing or violating submission, then consider also submitting an alternate version in a different submission server slot that does NOT violate the rules in case your rule abuse excuse is rejected.

          IMPORTANT: If you do submit such an alternate non-rule abusing -version, please indicate that in your remarks.md file of your non-rule -abusing version so that the Judges don’t think you uploaded a duplicate -into a wrong slot by mistake.

          -

          See Guidelines for Rule 11 - Abuse.

          +version, PLEASE indicate that in your remarks.md file of your non-rule +abusing version so that the Judges don’t think you uploaded a duplicate into a +wrong slot by mistake.

          +

          See Guidelines for Rule 11 - Legal rule +abuse.

          +

          Rule 12 - UTF-8

          -

          Use of UTF-8 is supported by C89 standard and its updates and so too by the IOCCC.

          +
          +

          Use of UTF-8 is supported by C89 standard and its updates and so too by the +IOCCC.

          -

          Rule 13 - Newlines

          +

          Rule 13 - No carriage returns in prog.c

          Any C source that fails to compile because lines contain carriage-returns (CTRL+M, \r) in particular as part of DOS/Windows style newlines might @@ -697,34 +757,36 @@ be rejected. Please do NOT put trailing CTRL+M in prog.c< or remarks.md files, but instead end lines with Unix newline (line-feed, CTRL+J, \n).

          You are permitted, in order to try and squeeze your prog.c under a -Rule 2a Gross Size and/or -Rule 2b Next Size +Rule 2a Gross Size and/or +Rule 2b Net Size limits, to NOT end source with a newline. If you need to do this, please document that in your remarks.md file and if your compiler complains about this, document this too and update your Makefile to account for this.

          -

          Rule 14 - Resubmit

          +

          Rule 14 - Resubmitting lost submissions

          Submissions that are substantially similar to previous winning IOCCC entries are discouraged.

          -

          You are allowed to resubmit to a later contest, a submission that didn’t -win the IOCCC. If you do so, then you would be well advised to try and -enhance and improve your submission. If you do resubmit something that -didn’t previously win, then you are encouraged to mention this in your -remarks.md file as this sometimes helps.

          +

          You are allowed to resubmit to a later contest, a submission that didn’t win the +IOCCC. If you do so, then you would be WELL ADVISED to try and enhance and +improve your submission. If you do resubmit something that didn’t previously +win, then you are encouraged to mention this in your remarks.md file as this +sometimes helps.

          -

          Rule 15 - Building

          +
          +

          Rule 15 - GNU Makefile

          -

          The Makefile MUST adhere to GNU Makefile syntax. Its recommended -that you copy and rename the Makefile.example as a template. The primary -target of the Makefile MUST be prog and the source file is prog.c. -The C compiler and preprocessor MUST be invoked using ${CC} and ${CPP} -macros respectively.

          -

          The clobber target should clean and restore the submission directory -tree to its original state, such as removing temporary files or any -modified data files. Don’t assume that git tool chain is installed, -i.e., do NOT expect git clean -f to work.

          +
          +

          The Makefile MUST adhere to GNU Makefile syntax. It’s highly recommended +that you copy the Makefile.example as a template, renaming +it to Makefile. The primary target of the Makefile MUST be prog and +the source file is prog.c. The C compiler and preprocessor MUST be +invoked using ${CC} and ${CPP} macros respectively.

          +

          The clobber target MUST clean and restore the submission directory tree to +its original state, such as removing temporary files or any modified data files. +Don’t assume that git tool chain is installed, i.e. do NOT expect git clean -f to work. To be clear: do NOT use git to clean out files as this +can cause problems in the winner repo!

          The Makefile MUST use a syntax that is compatible with bash(1) and GNU make(1). You are encouraged to use SHELL= bash in your Makefile; please add a space between the = and the value such as:

          @@ -734,25 +796,33 @@ Specification environments and systems are available in the search $PATH. Avoid command options that aren’t part of SUS, such as -GNU long name options --example or extensions like grep -P.

          -

          Do NOT assume that . (current directory) is in the $PATH environment variable.

          -

          See Rule 4 - Files.

          -

          See FAQ on “What are the detailed recommendations for a submission Makefile?”.

          -

          See Guidelines for Rule 15 - Building.

          +GNU long name options (such as --example) or extensions like grep -P.

          +

          Do NOT assume that . (current directory) is in the $PATH environment +variable.

          +

          See Rule 4 - Required files.

          +

          See +FAQ on “What are the detailed recommendations for a submission Makefile?”.

          +

          See Guidelines for Rule 15 - GNU Makefile.

          -

          Rule 16 - Anonymous

          +
          +

          Rule 16 - Anonymous judging

          +

          Your source code, data files, remarks, and program output MUST NOT identify the author(s) of your code (unless you are Peter Honeyman or pretending to be Peter Honeyman). In order to be impartial the Judges do NOT know who is submitting -entries to the IOCCC until final selection is made. Even if you are -a past winner, you MUST NOT reveal your identity deliberately or by -accident anywhere in your submission. Failure to comply may result -in the submission being disqualified.

          +programs to the IOCCC until final selection is made, and only submissions +that won.

          +

          Even if you are a past winner, you MUST NOT reveal your identity +deliberately or by accident anywhere in your submission. Failure to comply +may result in the submission being disqualified.

          -

          Rule 17 - Packaging

          +
          +

          Rule 17 - Use mkiocccentry

          +
          +

          TL;DR: use mkiocccentry(1) to package your submission.

          The files, directories, and paths MUST conform to the limits imposed by mkiocccentry(1), including but NOT limited, to their names, count, path length, directory tree depth, and permissions.

          @@ -763,33 +833,36 @@ directory depths of 4. The maximum number of files, excluding component is 38 and maximum path length is 60.

          The submission MUST be a .txz compressed tarball (i.e., tarball compressed by xz(1)) as constructed by mkiocccentry(1), which MUST be within [1..3999971] bytes in size.

          -

          The tarball MUST be a v7 format tarball.

          +

          The tarball MUST be a v7 format tarball, and any supplementary tarballs +you provide MUST also be v7 format.

          The sum of all file lengths, after unpacking from the tarball, MUST be less than 27651*1024 (28314624) bytes.

          -

          The submission MUST be a tarball file that MUST pass all txzchk(1) checks, and the tarball -filename MUST pass all fnamchk(1) checks.

          -

          You may NOT submit a tarball created by the -d, -e, NOR by the -s seed options of mkiocccentry(1).

          +

          The submission MUST pass all txzchk(1) checks, and the tarball filename +MUST pass all fnamchk(1) checks as well.

          +

          You may NOT submit a tarball created by the -d, -e OR by the -s seed options of mkiocccentry(1).

          The unpacked submission directory MUST pass the checks performed by the -current version of chksubmit(1).

          -

          Submissions may NOT use a -mkiocccentry toolkit -command line options that labeled as “for TESTING purposes”, -NOR labeled as “for the use by the IOCCC judges only”, -in their respective man pages.

          -

          Submissions may ONLY use -mkiocccentry toolkit -command lines that confirm to the command’s -h “print help message”.

          -

          The prog.c file MUST pass the Rule 2 - Size -size checks performed by iocccsize(1).

          -

          The .auth.json and .info.json files MUST be compatible with what chksubmit(1) generates.

          -

          Any submission that fails to pass the checks performed by the most recent version of the -mkiocccentry toolkit +minimum required version of chksubmit(1).

          +

          Submissions may NOT use a mkiocccentry +toolkit command line options that +are labelled as “for TESTING purposes”, OR labelled as “for the use by +the IOCCC judges only”, in their respective man pages.

          +

          Submissions may ONLY use mkiocccentry +toolkit command lines that confirm +to the command’s -h “print help message”, again notwithstanding the options +for testing and the IOCCC judges.

          +

          The prog.c file MUST pass the Rule 2 - Size +checks performed by iocccsize(1).

          +

          The .auth.json and .info.json files MUST be compatible with what +mkiocccentry(1) generates.

          +

          Any submission that fails to pass the checks performed by the minimum required +version of the mkiocccentry toolkit WILL be rejected!

          -

          See Rule 4 - Files.

          -

          See FAQ on “What is the mkiocccentry tool, how do I obtain it and how do I use it?”.

          -

          See Guidelines for Rule 17 - Packaging.

          +

          See Rule 4 - Required files.

          +

          See the +FAQ on “What is the mkiocccentry tool, how do I obtain it and how do I use it?”.

          +

          See the Guidelines for Rule 17 - Use mkiocccentry.

          -

          Rule 18 - License

          +

          Rule 18 - Submission license

          The entirety of your submission MUST be submitted under the following license:

          CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International

          @@ -800,14 +873,14 @@ size checks performed by iocccsize(1).

          This 19th rule, while prime, is reserved for future abuse 😁. Additional rules, both humorous and otherwise, may be added below this rule in future contests.

          -

          See Rule 6 - Free.

          +

          See Rule 6 - Free Rule.

          Further Reading

          Please read the Guidelines next for further commentary on these rules.

          Read the Entering the IOCCC: the bare minimum you need to know for an overview of how to enter the contest.

          See also the FAQ.

          -

          And now for something completely different

          +

          And now for something completely different.

          Consider joining the IOCCC Discord Server for discussions about The Rules, questions for the Judges, and C in general.

          Leonid A. Broukhis diff --git a/next/rules.md b/next/rules.md index 4ed0bc1eb..f87d14393 100644 --- a/next/rules.md +++ b/next/rules.md @@ -29,7 +29,7 @@ app from time to time to view IOCCC mastodon updates. # 29th International Obfuscated C Code Contest Official Rules -Copyright © 2025 Leonid A. Broukhis and Landon Curt Noll. +Copyright (c) 2025 Leonid A. Broukhis and Landon Curt Noll. All Rights Reserved. Permission for personal, education or non-profit use is granted provided this copyright and notice are included in its entirety @@ -39,24 +39,25 @@ writing by [contacting the judges](../contact.html). ## Rules Version -These IOCCC Rules are version **29.08 2025-11-28**. +These IOCCC Rules are version **29.09 2025-11-29**. -Be sure to read the [IOCCC guidelines](guidelines.html). +Reminder: be SURE to read the [IOCCC guidelines](guidelines.html).

          ## Rule 0 - Dates
          -This IOCCC runs from **2025-12-03 20:25:12.045045 UTC** to **2026-03-13 17:19:23.293137 UTC**. +This IOCCC runs from `2025-12-03 20:25:12.045045 UTC` to `2026-03-13 +17:19:23.293137 UTC`. -This contest will enter the **pending state** on **2025-12-03 20:25:12.045045 UTC**, +This contest will enter the **pending state** on `2025-12-03 20:25:12.045045 UTC`, allowing people to register for the IOCCC. -This contest will enter the **open state** on **2025-12-15 18:21:24.273033 UTC**, +This contest will enter the **open state** on `2025-12-15 18:21:24.273033 UTC`, allowing people to upload submissions to the [IOCCC submit server](https://submit.ioccc.org). -This contest will enter the **judging state** on **2026-03-13 17:19:23.293137 UTC**, +This contest will enter the **judging state** on `2026-03-13 17:19:23.293137 UTC`, when people will no longer be allowed to upload submissions. Until the contest enters the **open** state, any or all @@ -64,57 +65,81 @@ of the above **dates and times may change _AT ANY TIME_**! The above timestamps are in "_YYYY-MM-DD HH:MM:SS.micros UTC_" format. -See [Current status of the IOCCC](../status.html). +See the [current status of the IOCCC](../status.html).
          -## Rule 1 - Program +## Rule 1 - C program
          -Your submission **MUST** be a C program. +Your submission **MUST** be a C program that does NOT `#include` data files.
          -## Rule 2 - Size +
          +
          +
          +## Rule 2 - Size restrictions +
          +
          +
          `Rule 2` requires that your submission satisfy **BOTH** -[Rule 2a Gross Size](rules.html#rule-2a-gross-size) +[Rule 2a (Gross Size)](rules.html#rule2a) and -[Rule 2b Next Size](rules.html#rule-2b-net-size). +[Rule 2b (Net Size)](rules.html#rule2b). During development this can be checked using `iocccsize(1)`: +``` iocccsize prog.c +``` -See [Guidelines for Rule 2 - Size](guidelines.html#guideline-2---size). +See the [Guidelines for Rule 2 - Size restrictions](guidelines.html#guideline-2---size).
          +
          +
          ### Rule 2a - Gross Size
          +
          +
          The overall maximum size of your `prog.c` program source **MUST NOT** exceed **4993** bytes. +**NOTE**: by default `iocccsize` will only report the rule 2b size, unless the +code surpasses the limit. + See [Entering the IOCCC: the bare minimum you need to know](../quick-start.html#enter).
          +
          +
          ### Rule 2b - Net Size
          +
          +
          When the filename of your program source (i.e., `prog.c`) is given as a command line argument to the latest version of the official IOCCC size tool (hereby referred to as `iocccsize(1)`), the value printed **MUST NOT** exceed **2503**. +**NOTE**: `iocccsize` does **NOT** calculate the filename length. See [Rule 17 - +Use mkiocccentry](#rule17-mkiocccentry). +
          -## Rule 3 - Register +
          +## Rule 3 - Register for the IOCCC +
          You **MUST** register, using a valid email address, in order to submit -entries to the IOCCC. You may register while the contest is **pending** or **open**. +to the IOCCC. You may register while the contest is **pending** or **open**. A few days after registering, you'll receive your UUID username and temporary password, which you **MUST** change within 14 days. If you @@ -129,51 +154,69 @@ email or for those who wait until the last minute to try to register! See [Entering the IOCCC: the bare minimum you need to know](../quick-start.html#enter). -See [Rule 8 - Submission](rules.html#rule-8---submission). +See [Rule 8 - Submitting requirements](rules.html#rule8). -See [Guidelines for Rule 3 - Register](guidelines.html#guideline-3---register). +See [Guidelines for Rule 3 - Register for the IOCCC](guidelines.html#guideline-3---register).
          -## Rule 4 - Files +
          +## Rule 4 - Required files +
          -The submission **MUST** include at least these files: `Makefile`, `prog.c`, -`remarks.md`,`.info.json`, and `.auth.json`. +Your submission **MUST** include at least these files: `Makefile`, `prog.c`, +`remarks.md`,`.info.json`, and `.auth.json`, the latter two of which are +generated by `mkiocccentry(1)`. See [Rule 17 - +Use mkiocccentry](#rule17-mkiocccentry). -At a minimum the following requirements apply. Additional requirements +At a **minimum** the following requirements apply. Additional requirements may be imposed by `mkiocccentry(1)` updates that have yet to be listed -here: +below. -* `.info.json`, and `.auth.json` **MUST** be generated by `mkiocccenty(1)` -when packing a submission, and **MUST** pass the `chksubmit(1)` tests. +**NOTE**: `mkiocccentry(1)` will reject any directory which has prohibited +files. + +**NOTE**: by 'top directory' we mean the directory with `prog.c`, `Makefile`, +`remarks.md` and the `mkiocccentry(1)` generated files `.auth.json` and +`.info.json` and **NOT** the `topdir` arg to `mkiocccentry(1)`. + + +* `.info.json` and `.auth.json` **MUST** be generated by `mkiocccenty(1)` +when packing a submission. When `chksubmit(1)` is run on the submission +directory **ALL** tests must pass and if there is **ANY** problem with these +JSON files or if either is missing it will fail. See [Rule 17 - use +mkiocccentry](#rule17-mkiocccentry). * The `Makefile`, `remarks.md`,`.info.json`, and `.auth.json` **MUST** -have a file size **greater than 0**. +have a file size **greater than 0** and **MUST** have content. Note that +`mkiocccentry(1)` will check for file **size** but will **NOT** check for +content. -* Your submitted source code **MUST** be called `prog.c`. When the `Makefile` +* Your submitted source code **MUST** be called `prog.c`. When the `Makefile` compiles your code, the executable (if applicable) **MUST** be called `prog`. -The `Makefile` may compile your source code into other filenames as well. +The `Makefile` may compile your source code into other filenames as well, if you +want. * As `prog`, `prog.alt`, `prog.alt.o`, `prog.o` may be created by your -`Makefile`, your submission **MUST NOT** include those files in -your top directory, as original content. +`Makefile`, your submission **MUST NOT** include those files in your **top** +directory. * Your submission may **NOT** have any file that starts with `COPYING`, `COPYRIGHT`, or `LICENSE` as those files are reserved by IOCCC. -* Your submission may **NOT** have in the top directory, `prog.orig.c`, -`README.md`, nor `index.html` as those files reserved by IOCCC. +* Your submission may **NOT** have in the **top** directory: `prog.orig.c`, +`README.md` or `index.html` as those files are reserved by the IOCCC. -* Your submission may **NOT** have in the top directory, any file +* Your submission may **NOT** have in the **top** directory any file that matches a file glob pattern form `[0-9][0-9][0-9][0-9]_*.tar.bz2` as those files are reserved by IOCCC. * Your submission may **ONLY** contain files and directories. Other file -types such as symlinks, sockets, etc are **NOT** allowed. +types such as symlinks, sockets etc. are **NOT** allowed. -* All directories **MUST** have a file mode of **0755**. All files -**MUST** have the file mode of **0444**, except for files that +* **All** directories **MUST** have permission mode of **0755**. All files +**MUST** have the file mode of **0444**, EXCEPT for files that end in `.sh` which must have a mode of **0555**. * All files that end in `.md` **MUST** be in markdown format. @@ -190,32 +233,36 @@ The `remarks.md` and `Makefile` are explained in more detail in the Guidelines. See [IOCCC markdown guidelines](../markdown.html). -See [Rule 17 - Packaging](rules.html#rule-17---packaging). +See [Rule 17 - Use mkiocccentry](rules.html#rule17-mkiocccentry). -See FAQ on "[What permissions may my files be and what if I need different permissions?](../faq.html#file_perms)". +See the +FAQ on "[What permissions may my files be and what if I need different permissions?](../faq.html#file_perms)". -See [Guidelines for the mkiocccentry toolkit](guidelines.html#mkiocccentry_toolkit). +See the [Guidelines on the mkiocccentry toolkit](guidelines.html#mkiocccentry_toolkit). -See [Guidelines for the Makefile](guidelines.html#makefile). +See the +FAQ on "[What are the detailed recommendations for a submission Makefile?](../faq.html#makefile_details)".
          -## Rule 5 - Integrity +
          +## Rule 5 - Do NOT modify submitted files or filenames or parent directories +
          -Your submission **MUST NOT** modify the filenames or content of any of -your original submission, such as `prog.c`, `Makefile`, or any supplied -data files. To modify files, your program can make a copy or you can -use the `Makefile` to setup working copies. Any working copies **MUST** be -cleaned up by the `Makefile` `clobber` target, so as to restore the -directory to its original state. +Your submission **MUST NOT** modify the filenames or content of any of your +original submission, such as `prog.c`, `Makefile`, or **ANY** other supplied +files. To modify files, your program can make a copy or you can use the +`Makefile` to setup working copies. Any working copies **MUST** be cleaned up +by the `Makefile` `clobber` target, so as to restore the directory to its +original state. Your submission **MUST NOT** create or modify directories and files -ABOVE the current directory with the exception of the `/tmp` and the -`/var/tmp` directories as long as the directory name or filename does -**NOT** start with "." (dot). +ABOVE the current directory (with the exception of the `/tmp` and the `/var/tmp` +directories and as long as the directory name or filename does **NOT** start +with a `.` (dot)). -The `Makefile` `clobber` target **MUST** be restore your submission into +The `Makefile` `clobber` target **MUST** restore your submission to its original form, including the removal of any created files and directories. Your code should be able to run under a @@ -223,7 +270,9 @@ Your code should be able to run under a
          -## Rule 6 - Free +
          +## Rule 6 - Free Rule +
          I am **NOT** a Rule, I am a `free(void *human);` ‼️ @@ -237,92 +286,110 @@ See [Rule 19 - Prime](rules.html#rule-19---prime).
          +
          ## Rule 7 - Original Work
          +
          -You, the author(s), **MUST** own the contents of your submission, or you **MUST** -have permission from the original owner(s) to its use. If you submit -any content that is owned by others, you **MUST** detail that ownership, -i.e., who owns what, and document the permission you obtained from them -in your `remarks.md` file. +You, the author(s), **MUST** own the contents of your submission, **OR**, IF you +do **NOT** own the work, then you **MUST** have permission from the original +owner(s) to its use. If you submit **ANY** content that is owned by others, you +**MUST** detail that ownership, i.e., who owns what, and document the permission +you obtained from them in your `remarks.md` file. You are permitted to use tools to write your code. -See [Rule 16 - Anonymous](rules.html#rule-16---anonymous). +See [Rule 16 - Anonymous Judging](rules.html#rule16-anonymous-judging). See [Guidelines for Rule 7 - Original Work](guidelines.html#guideline-7---original-work).
          -## Rule 8 - Submission +
          +## Rule 8 - Submitting requirements +
          -The Submit Server will only accept submissions from those who have -registered and only while the contest is open. +The submit server will accept submissions **ONLY** from those who have +registered and **ONLY** while the contest is open. -The Submit Server places a total submission size limit of **3999971** bytes. +The submit server places a total size limit of **3999971** bytes **PER** +submission. Each account has ten (**10.000**) submission slots (**0..9)**. Each submission slot should be annotated by the server as to whether its was received, processed, malformed, etc. Please take note of any errors, rectify, -and resubmit. In order to avoid potential packaging errors, it is **highly -recommended** to use `mkiocccentry(1)`. +and resubmit. In order to avoid potential packaging errors, it is **highly +recommended** to use `mkiocccentry(1)`, **AND** to check from time to time the +status on the submit server, to see if any tests run by the server failed to +validate your submission. + +Do **NOT** register more than one account! See -[Rule 3 - Register](rules.html#rule-3---register), -[Rule 15 - Building](rules.html#rule-15---building), +[Rule 3 - Registering for the IOCCC](rules.html#rule3-register), +[Rule 15 - GNU Makefile](rules.html#rule15-gnu-makefile), and -[Rule 17 - Packaging](rules.html#rule-17---packaging). +[Rule 17 - Use mkiocccentry](rules.html#rule17-mkiocccentry).
          -## Rule 9 - No hands +## Rule 9 - No interactive compiling allowed
          Entries requiring human interaction to be initially compiled are **NOT** -permitted. However, see the guidelines. Each entry **MUST** automate the -build process using `bash`, `gmake`, `gcc`, `clang`, under a -[SUS environment](https://pubs.opengroup.org/onlinepubs/9799919799/). +permitted. However, see the guidelines. Each entry **MUST** automate the +build process using `bash`, `gmake`, `gcc` and/or `clang` and other commonly +available tools under an [SUS +environment](https://pubs.opengroup.org/onlinepubs/9799919799/). **NOTE**: The references to `gmake(1)` can be any GNU Make compatible tool. -See [Rule 15 - Building](rules.html#rule-15---building). +**NOTE**: it is better to use the `${MAKE}` variable as then one may override +the make command. + +**NOTE**: it is better and more portable to **NOT** modify the `${CC}` variable +in the Makefile. + +See [Rule 15 - GNU Makefile](rules.html#rule15-gnu-makefile).
          -## Rule 10 - Privileges +## Rule 10 - Program file permissions
          Programs that require special privileges (`setuid(2)`, `setgid(2)`, super-user, special owner, special group, etc.) are **HIGHLY DISCOURAGED**. We do **NOT** guarantee these functions will behave as you expect on our -test platforms. If your program needs special permissions you **MUST** +test platforms. If your program needs special permissions you **MUST** document this fact and explain why it is needed in your submission’s -`remarks.md` file. +`remarks.md` file, preferably close to the top. Furthermore, if you need a supplementary program that you include to -have these permissions, you will also have to explain this, because these +have these permissions, you will also have to explain this as well, because these bits are **NOT** allowed in submissions and those bits will **NOT** be copied by `mkiocccentry(1)`. -See [Rule 4 - Files](rules.html#rule-4---files), +See [Rule 4 - Required files](rules.html#rule4-required-files), and -[Rule 5 - Integrity](rules.html#rule-5---integrity). +[Rule 5 - Do NOT modify files](rules.html#rule5-modifying-files).
          -## Rule 11 - Abuse +
          -Legal abuse of the rules is somewhat encouraged, but comes with risks. -A submission that, in the opinion of the Judges, violates the rules **WILL +Legal abuse of the rules is **somewhat** encouraged, but comes with risks. +A submission that, in the opinion of the Judges, **violates** the rules **WILL BE DISQUALIFIED**. Submissions that plan to abuse the rules **MUST** justify why their rule abuse is legal (or interesting) in the `remarks.md` file. -Submission packaging abuse will **NOT** be tolerated and for this reason -its recommended to use `mkiocccentry(1)`. During development you can -check your `prog.c` size limits using `iocccsize(1)`, e.g., `iocccsize -v1 prog.c`. -Overriding problems detected by any of the IOCCC tools +Submission packaging abuse will **NOT** be tolerated and for this reason, +amongst many others, it is recommended that you use `mkiocccentry(1)`. During +development you can check your `prog.c` size limits using `iocccsize(1)`, e.g., +`iocccsize -v1 prog.c`. Overriding problems detected by any of the IOCCC tools risks that the submission will be rejected. If you do submit a rule abusing or violating submission, then consider @@ -331,22 +398,26 @@ slot that does **NOT** violate the rules in case your rule abuse excuse is rejected. **IMPORTANT**: If you do submit such an alternate non-rule abusing -version, please indicate that in your `remarks.md` file of your non-rule -abusing version so that the Judges don't think you uploaded a duplicate -into a wrong slot by mistake. +version, **PLEASE** indicate that in your `remarks.md` file of your non-rule +abusing version so that the Judges don't think you uploaded a duplicate into a +wrong slot by mistake. -See [Guidelines for Rule 11 - Abuse](guidelines.html#guideline-11---abuse). +See [Guidelines for Rule 11 - Legal rule +abuse](guidelines.html#guideline-11---abuse).
          +
          ## Rule 12 - UTF-8
          +
          -Use of UTF-8 is supported by `C89` standard and its updates and so too by the IOCCC. +Use of UTF-8 is supported by `C89` standard and its updates and so too by the +IOCCC.
          -## Rule 13 - Newlines +## Rule 13 - No carriage returns in prog.c
          Any C source that fails to compile because lines contain carriage-returns @@ -356,91 +427,104 @@ or `remarks.md` files, but instead end lines with Unix newline (line-feed, CTRL+J, `\n`). You are permitted, in order to try and squeeze your `prog.c` under a -[Rule 2a Gross Size](rules.html#rule-2a-gross-size) and/or -[Rule 2b Next Size](rules.html#rule-2b-net-size) -limits, to **NOT** end source with a newline. If you +[Rule 2a Gross Size](rules.html#rule2a-gross-size) and/or +[Rule 2b Net Size](rules.html#rule2b-net-size) +limits, to **NOT** end source with a newline. If you need to do this, please document that in your `remarks.md` file and if your compiler complains about this, document this too and update your `Makefile` to account for this.
          -## Rule 14 - Resubmit +## Rule 14 - Resubmitting lost submissions
          Submissions that are substantially similar to previous winning IOCCC entries are discouraged. -You are allowed to resubmit to a later contest, a submission that didn't -win the IOCCC. If you do so, then you would be well advised to try and -enhance and improve your submission. If you do resubmit something that -didn't previously win, then you are encouraged to mention this in your -`remarks.md` file as this sometimes helps. +You are allowed to resubmit to a later contest, a submission that didn't win the +IOCCC. If you do so, then you would be **WELL ADVISED** to try and enhance and +improve your submission. If you do resubmit something that didn't previously +win, then you are encouraged to mention this in your `remarks.md` file as this +**sometimes** helps.
          -## Rule 15 - Building +
          +## Rule 15 - GNU Makefile +
          -The `Makefile` **MUST** adhere to GNU Makefile syntax. Its recommended -that you copy and rename the `Makefile.example` as a template. The primary -target of the `Makefile` **MUST** be `prog` and the source file is `prog.c`. -The C compiler and preprocessor **MUST** be invoked using `${CC}` and `${CPP}` -macros respectively. +The `Makefile` **MUST** adhere to GNU Makefile syntax. It's highly recommended +that you copy the [Makefile.example](Makefile.example) as a template, renaming +it to `Makefile`. The primary target of the `Makefile` **MUST** be `prog` and +the source file is `prog.c`. The C compiler and preprocessor **MUST** be +invoked using `${CC}` and `${CPP}` macros respectively. -The `clobber` target should clean and restore the submission directory -tree to its original state, such as removing temporary files or any -modified data files. Don't assume that `git` tool chain is installed, -i.e., do **NOT** expect `git clean -f` to work. +The `clobber` target **MUST** clean and restore the submission directory tree to +its original state, such as removing temporary files or any modified data files. +Don't assume that `git` tool chain is installed, i.e. do **NOT** expect `git +clean -f` to work. To be clear: do **NOT** use `git` to clean out files as this +can cause problems in the winner repo! The `Makefile` **MUST** use a syntax that is compatible with -`bash(1)` and GNU `make(1)`. You are encouraged to use `SHELL= +`bash(1)` and GNU `make(1)`. You are encouraged to use `SHELL= bash` in your `Makefile`; please add a space between the `=` and the value such as: -``` +``` SHELL= bash ``` Assume that commands commonly found in [Single UNIX Specification](https://en.wikipedia.org/wiki/Single_UNIX_Specification) environments and systems are available in the search -`$PATH`. Avoid command options that aren't part of +`$PATH`. Avoid command options that aren't part of [SUS](https://en.wikipedia.org/wiki/Single_UNIX_Specification), such as -GNU long name options `--example` or extensions like `grep -P`. +GNU long name options (such as `--example`) or extensions like `grep -P`. -Do **NOT** assume that `.` (current directory) is in the `$PATH` environment variable. +Do **NOT** assume that `.` (current directory) is in the `$PATH` environment +variable. -See [Rule 4 - Files](rules.html#rule-4---files). +See [Rule 4 - Required files](rules.html#rule4-required-files). -See FAQ on "[What are the detailed recommendations for a submission Makefile?](../faq.html#makefile_details)". +See +FAQ on "[What are the detailed recommendations for a submission Makefile?](../faq.html#makefile_details)". -See [Guidelines for Rule 15 - Building](guidelines.html#guideline-15---building). +See [Guidelines for Rule 15 - GNU Makefile](guidelines.html#guideline-15---building).
          -## Rule 16 - Anonymous +
          +## Rule 16 - Anonymous judging +
          Your source code, data files, remarks, and program output **MUST NOT** identify the author(s) of your code (unless you are **Peter Honeyman** -or pretending to be **Peter Honeyman**). In order to be impartial the +or pretending to be **Peter Honeyman**). In order to be impartial the [Judges](https://www.ioccc.org/judges.html) do **NOT** know who is submitting -entries to the IOCCC until final selection is made. Even if you are -a past winner, you **MUST NOT** reveal your identity deliberately or by -accident anywhere in your submission. ***Failure to comply may result -in the submission being disqualified.*** +programs to the IOCCC until final selection is made, and **only** submissions +that won. + +Even if you are a past winner, you **MUST NOT** reveal your identity +deliberately or by accident anywhere in your submission. **_Failure to comply +may result in the submission being disqualified_**.
          -## Rule 17 - Packaging +
          +## Rule 17 - Use `mkiocccentry`
          +
          + +TL;DR: use `mkiocccentry(1)` to package your submission. The files, directories, and paths **MUST** conform to the limits imposed by `mkiocccentry(1)`, including but **NOT** limited, to their names, count, path length, directory tree depth, and permissions. The submission tree may have at most **13** directories and maximum -directory depths of **4**. The maximum number of files, excluding +directory depths of **4**. The maximum number of files, excluding `prog.c`, `remarks.md`, `Makefile`, `prog.alt.c`, `try.sh`, `try.alt.sh`, `.info.json` and `.auth.json` is **31**. And the maximum file-path component is **38** and maximum path length is **60**. @@ -448,47 +532,51 @@ component is **38** and maximum path length is **60**. The submission **MUST** be a `.txz` compressed tarball (i.e., tarball compressed by `xz(1)`) as constructed by `mkiocccentry(1)`, which **MUST** be within **[1..3999971]** bytes in size. -The tarball **MUST** be a **v7 format** tarball. +The tarball **MUST** be a **v7 format** tarball, and any supplementary tarballs +you provide **MUST** also be **v7 format**. The sum of all file lengths, after unpacking from the tarball, **MUST** be less than `27651*1024` (**28314624**) bytes. -The submission **MUST** be a tarball file that **MUST** pass all `txzchk(1)` checks, and the tarball -filename **MUST** pass all `fnamchk(1)` checks. +The submission **MUST** pass all `txzchk(1)` checks, and the tarball filename +**MUST** pass all `fnamchk(1)` checks as well. -You may **NOT** submit a tarball created by the `-d`, `-e`, **NOR** by the `-s seed` options of `mkiocccentry(1)`. +You may **NOT** submit a tarball created by the `-d`, `-e` **OR** by the `-s +seed` options of `mkiocccentry(1)`. The unpacked submission directory **MUST** pass the checks performed by the -current version of `chksubmit(1)`. +minimum required version of `chksubmit(1)`. -Submissions may **NOT** use a -[mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) -command line options that labeled as "**for TESTING purposes**", -**NOR** labeled as "**for the use by the IOCCC judges only**", -in their respective man pages. +Submissions may **NOT** use a [mkiocccentry +toolkit](https://github.com/ioccc-src/mkiocccentry) command line options that +are labelled as "**for TESTING purposes**", **OR** labelled as "**for the use by +the IOCCC judges only**", in their respective man pages. -Submissions may **ONLY** use -[mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) -command lines that confirm to the command's `-h` "_print help message_". +Submissions may **ONLY** use [mkiocccentry +toolkit](https://github.com/ioccc-src/mkiocccentry) command lines that confirm +to the command's `-h` "_print help message_", again notwithstanding the options +for testing and the IOCCC judges. -The `prog.c` file **MUST** pass the [Rule 2 - Size](rules.html#rule-2---size) -size checks performed by `iocccsize(1)`. +The `prog.c` file **MUST** pass the [Rule 2 - Size](rules.html#rule2-size) +checks performed by `iocccsize(1)`. -The `.auth.json` and `.info.json` files **MUST** be compatible with what `chksubmit(1)` generates. +The `.auth.json` and `.info.json` files **MUST** be compatible with what +`mkiocccentry(1)` generates. -Any submission that fails to pass the checks performed by the most recent version of the -[mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) +Any submission that fails to pass the checks performed by the minimum required +version of the [mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) **WILL be rejected**! -See [Rule 4 - Files](rules.html#rule-4---files). +See [Rule 4 - Required files](rules.html#rule4-required-files). -See FAQ on "[What is the mkiocccentry tool, how do I obtain it and how do I use it?](../faq.html#mkiocccentry)". +See the +FAQ on "[What is the mkiocccentry tool, how do I obtain it and how do I use it?](../faq.html#mkiocccentry)". -See [Guidelines for Rule 17 - Packaging](guidelines.html#guideline-17---packaging). +See the [Guidelines for Rule 17 - Use mkiocccentry](guidelines.html#guideline-17---packaging).
          -## Rule 18 - License +## Rule 18 - Submission license
          The entirety of your submission **MUST** be submitted under the following license: @@ -506,7 +594,7 @@ This 19th rule, while prime, is reserved for future abuse 😁. Additional rules, both humorous and otherwise, may be added below this rule in future contests. -See [Rule 6 - Free](rules.html#rule-6---free). +See [Rule 6 - Free Rule](rules.html#rule6-free-rule). ## Further Reading @@ -519,7 +607,7 @@ for an overview of how to enter the contest. See also the [FAQ](../faq.html). -And now [for something completely different](guidelines.html#fun) +And now [for something completely different](guidelines.html#fun). Consider joining the [IOCCC Discord Server](https://discord.com/invite/Wa42Qujwnw) for discussions about The Rules, questions for the Judges, and `C` in general. diff --git a/next/submit.html b/next/submit.html index df14ca71e..b9df6cacf 100644 --- a/next/submit.html +++ b/next/submit.html @@ -452,7 +452,7 @@ -

          Use mkiocccentry to rebuild# How to upload your submission to the IOCCC

          +

          How to upload your submission to the IOCCC

          IMPORTANT NOTE: The IOCCC submit server is only ready for submissions ONLY WHEN THE CONTEST IS open.

          @@ -518,7 +518,7 @@ the file selection step.

        • the status of the submission
        • the filename, which will be in the correct format, assuming you used mkiocccentry(1) which is HIGHLY recommended so that you do not break -Rule 17 - Packaging!
          • +Rule 17 - Use mkiocccentry!
        • the file length, which txzchk(1) will also verify (the file itself and the tarball listing).
        • the upload date.
          • @@ -576,7 +576,7 @@ To see any status updates, you should logout and log back in later.

          … or ANY other error then you MUST FIX your submission, repackage your tarball with mkiocccentry and upload to the same slot again! If you do not fix this your submission WILL BE REJECTED for violating -Rule 17 - Packaging!

          +Rule 17 - Use mkiocccentry!

          If the format test went well, then you will see:

          Status: submit file received by the IOCCC judges. Passed both txzchk and chksubmit tests.

          @@ -586,7 +586,7 @@ rules or that everything is OK once the tarball is extracted; it simply means the tests performed by the tools passed. If you find a flaw in a tool and abuse it and the tests pass then you stand a significant chance of having your submission rejected for violating -Rule 17 - Packaging, +Rule 17 - Use mkiocccentry, even if the tests passed.

          For details on txzchk, see the FAQ on “txzchk”.

          diff --git a/next/submit.md b/next/submit.md index 60a5cb6b5..59fee0320 100644 --- a/next/submit.md +++ b/next/submit.md @@ -1,4 +1,4 @@ -Use mkiocccentry to rebuild# How to upload your submission to the IOCCC +# How to upload your submission to the IOCCC **IMPORTANT NOTE**: The [IOCCC submit server](https://submit.ioccc.org) is only ready for submissions @@ -87,7 +87,7 @@ And in the slot it will give you important details like: - the status of the submission - the filename, which will be in the correct format, assuming you used `mkiocccentry(1)` which is **HIGHLY** recommended so that you do not break -[Rule 17 - Packaging](rules.html#rule-17---packaging)! +[Rule 17 - Use mkiocccentry](rules.html#rule17-mkiocccentry)! - the file length, which `txzchk(1)` will also verify (the file itself and the tarball listing). - the upload date. @@ -158,7 +158,7 @@ Or: ... or **ANY** other error then you **MUST FIX** your submission, repackage your tarball with `mkiocccentry` and upload to the same slot again! If you do not fix this your submission **WILL BE REJECTED** for violating -[Rule 17 - Packaging](rules.html#rule-17---packaging)! +[Rule 17 - Use mkiocccentry](rules.html#rule17-mkiocccentry)! If the format test went well, then you will see: @@ -169,7 +169,7 @@ rules or that everything is OK once the tarball is extracted; it simply means the tests performed by the tools passed. If you find a flaw in a tool and abuse it and the tests pass then you stand a significant chance of having your submission rejected for violating -[Rule 17 - Packaging](rules.html#rule-17---packaging), +[Rule 17 - Use mkiocccentry](rules.html#rule17-mkiocccentry), even if the tests passed. For details on `txzchk`, see the diff --git a/quick-start.html b/quick-start.html index 2d58ee0e1..d53f3f306 100644 --- a/quick-start.html +++ b/quick-start.html @@ -566,13 +566,13 @@ for more info.

          NOTE: Please see our IOCCC markdown guide for important information on using markdown in the IOCCC.

          If the mkiocccentry tool indicates that there is a problem with your submission, especially if it identifies a -Rule 2 - Size, +Rule 2 - Size restrictions, or any other rule, related problem, you are strongly encouraged to revise and correct your entry and then re-run the mkiocccentry tool.

          If you choose to risk violating Rules, be sure and explain your reason for doing so in your remarks.md file.

          See also -Rule 17 - Packaging!

          +Rule 17 - Use mkiocccentry!

          IMPORTANT NOTE: the tools that require other tools, mkiocccentry(1) and txzchk(1), will, as of version 2.0.2 2025-03-11, search under $PATH. If you have an earlier version and you have not installed the tools and run the @@ -581,7 +581,7 @@ tools to set the path to the required tools.

          Do remember to make sure you have the latest vers chksubmit(1), txzchk(1) and fnamchk(1). And remember to make sure you have the latest version so you do not violate -Rule 17 - Packaging. +Rule 17 - Use mkiocccentry. See the FAQ on “obtaining the latest mkiocccentry tools”, the diff --git a/quick-start.md b/quick-start.md index 192fdf4bb..e975c697e 100644 --- a/quick-start.md +++ b/quick-start.md @@ -162,7 +162,7 @@ Three files are required to exist in `topdir`: If the `mkiocccentry` tool indicates that there is a problem with your submission, especially if it identifies a -[Rule 2 - Size](next/rules.html#rule-2---size), +[Rule 2 - Size restrictions](next/rules.html#rule2-size), or any other [rule](next/rules.html), related problem, you are **strongly** encouraged to revise and correct your entry and then re-run the `mkiocccentry` tool. @@ -170,7 +170,7 @@ If you choose to risk violating [Rules](next/rules.html), be sure and explain yo for doing so in your `remarks.md` file. See also -[Rule 17 - Packaging](next/rules.html#rule-17---packaging)! +[Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry)! **IMPORTANT NOTE**: the tools that require other tools, `mkiocccentry(1)` and `txzchk(1)`, will, as of version `2.0.2 2025-03-11`, search under `$PATH`. If @@ -181,7 +181,7 @@ tools to set the path to the required tools. Do remember to make sure you have the latest vers `chksubmit(1)`, `txzchk(1)` and `fnamchk(1)`. And remember to make sure you have the latest version so you do not violate -[Rule 17 - Packaging](next/rules.html#rule-17---packaging). +[Rule 17 - Use mkiocccentry](next/rules.html#rule17-mkiocccentry). See the FAQ on "[obtaining the latest mkiocccentry tools](faq.html#obtaining_mkiocccentry)", the