CIF_HKL_COD_NUMBER(1)

✨ cif_hkl_COD_number β€” the manual, but make it cute ✨

okay bestie, gather round πŸ’– you're looking at cif_hkl_COD_number, a lil' General Commands Manual darling that lives in section 1. She's a CIF girlie. She reads your CIF file and prints out the essential info in the COD CIF format. That's the whole vibe. Let's get into it πŸŽ€


🌸 NAME 🌸

cif_hkl_COD_number β€” parse a CIF file and print out the essential information in the COD CIF format πŸ¦‹


🌈 SYNOPSIS 🌈

cif_hkl_COD_number --options input1.cif input*.cif

πŸ’… DESCRIPTION πŸ’…

So like, the literal job description: parse a CIF file and print out the essential information in the COD CIF format. That's it, that's the girl. No cap ✨


πŸ‘‘ OPTIONS πŸ‘‘

  • -h, --add-cif-header header_file.cif β€” prepends each of the output files with the comments from the beginning of the file you specify. Free header, no cap 🫢
  • --exclude-empty-tags β€” removes tags that contain only empty values. A value counts as empty if it's equal to a single question mark ('?') or a single period ('.'). Bye bye, filler πŸ’€
  • --dont-exclude-empty-tags, --no-exclude-empty-tags β€” turns the --exclude-empty-tags option off. This is the default, so she's chill like that.
  • -x, --extra-tag-list tag-list.lst β€” adds extra tags to the list of recognised CIF tags. These extra tags live in a separate file, one tag per line. Bring your own tags, bestie πŸŽ€
  • --exclude-misspelled-tags β€” removes tags that were not present in the recognised tag list. Spelling counts, periodt.
  • --dont-exclude-misspelled-tags, --no-exclude-misspelled-tags β€” turns the --exclude-misspelled-tags option off.
  • --preserve-loop-order β€” prints loops in the same order they appeared in the original file. Nostalgic queen πŸ’œ
  • --use-internal-loop-order β€” disregards original loop order while printing the tags. This is the default.
  • --original-filename data_source.cif β€” uses the string you give her as the name of the original file. (peep --record-original-filename for the tea β˜•)
  • --clear-original-filename β€” does not use any previously provided strings as the name of the original file. Fresh start energy ✨
  • --record-original-filename β€” records the original filename and the original data block name for each data block as the '_cod_data_source_*' tag values.
  • --dont-record-original-filename β€” does not record the original filename and the original data block name. This is the default.
  • -S, --start-data-block-number 1234567 β€” uses the number you give her as the start number when renaming data blocks (default: '7000001'). Setting this option enables the -R option πŸ”₯
  • -d, --data-block-format '%07d' β€” uses the format you provide to determine new data block names from the provided data block numbers (default: '%07d').
  • -R, --renumber-data-blocks β€” renames all the data blocks. The new names are constructed by taking a start number (that's the -S option), applying the string format (that's the -d option), and then incrementing the start number for each sequential data block. Glow-up for every block, honestly πŸ‘‘
  • -R-, --dont-renumber-data-blocks β€” does not rename data blocks. This is the default. Heads up though: enabling this option sets the -S option to its default value.
  • --folding-width 76 β€” specifies the length of the longest unfolded line.
  • --fold-title, --dont-fold-title β€” folds the title, if it's longer than the folding width. Default: off.
  • --fold-long-fields, --dont-fold-long-fields β€” folds fields that are longer than the folding width. Default: off.
  • --use-perl-parser β€” uses the Perl parser to parse CIF files. Perl girlie mode πŸͺ
  • --use-c-parser β€” uses the C parser to parse CIF files. This is the default.
  • --help, --usage β€” outputs a short usage message (this message) and exits. Your lil' cheat sheet 🫢
  • --version β€” outputs version information and exits.

😭 REPORTING BUGS 😭

Found a bug in cif_hkl_COD_number? Don't suffer in silence, bestie β€” report it using e-mail: cod-bugs@ibt.lt πŸ’Œ


and that's the whole page, no notes πŸ’– this was the CIF_HKL_COD_NUMBER(1) manual page, from the General Commands Manual β€” she's serving general-commands-manual realness and she ate. mwah, slay, bye πŸŽ€βœ¨πŸ‘‘